Permalink
Commits on Jan 26, 2011
  1. Merge branch 'development'

    committed Jan 26, 2011
  2. IMPORTANT: Updated license to modified BSD license!

    In short: don't worry, appledoc is still free and will remain so, you can still use it, modify it as well as use generated documentation etc. for any kind of projects - free or commercial!
    
    In long :) I'm primarily developer and don't care about legal stuff, so I didn't take much time to consider this part before. I always wanted to contribute to the community and open the tool to anybody with minimal constraints and will continue to do so in the future. But to prevent potential misuse in today's crazy money-oriented-regardless-of-consequences world :) I took some time to go through at least basic considerations of the way I want to see appledoc go in the future. After all the time I've invested in the tool, this seemed proper to do...
    
    That being said, the main reason for switching from MIT to BSD is clearer text in BSD. But generally both licenses are practically the same and are among most liberal open source licenses :)
    
    I did add one additional requirement to the license and that is to attribute appledoc in generated documentation, your website or similar. I think this is quite sensible and shouldn't interfere with open source-ness of the tool a bit.
    
    If for whatever reason you cannot agree to the license, but want to use appledoc or documentation it generates, feel free to contact me as indicated in the readme file and I'll do my best to help you out and find workable solution!
    committed Jan 26, 2011
  3. Added basic overview of main appledoc classes and their interaction t…

    …o developer notes.
    committed Jan 26, 2011
  4. Removed what's new section from release notes and renamed it to devel…

    …oper notes.
    
    The whole history is available through git, so although nicely formatted what's new section is welcome, it's duplicate, and prone to "forgetting updating it" (happens to me all the time :).
    
    Various developer notes are still included in the file until I find a better place to organize them.
    committed Jan 26, 2011
  5. Updated template files to include appledoc build number for simpler d…

    …iagnostics and support.
    committed Jan 26, 2011
Commits on Jan 24, 2011
  1. Fixed HTML and XML handling within example blocks. Closes #54.

    The problem was two fold: template engine is specifically instructed to prevent any HTML escaping (otherwise using custom HTML tags within comment code wouldn't be possible), but this renders example blocks containing XML or HTML useless. To overcome this, example blocks are manually escaped by appledoc. Note that this required updating example blocks unit tests - changing to real settings provider as mock didn't do escaping...
    
    Second: GBTokenizer marked HTML/XML opening comment marker `<!--` as a delimiter and removed it from the string, leaving only the remaining text. This interfered with example blocks processing later on. This was actually a bug as delimiter should only be considered a line containing ONLY delimiter chars (at present the regex used was matching only from start of line)!
    
    Also added few more unit tests for validating example blocks prefixed with spaces are detected.
    
    Increased build number to 525.
    committed Jan 24, 2011
  2. Fixed unit tests target by adding all doc set generators to compile p…

    …hase.
    
    After splitting doc set generation into 3 distinct phases, the 2 new classes were not added to unit tests target resulting in linker errors.
    committed Jan 24, 2011
Commits on Jan 18, 2011
  1. Split docset generation phase into 3 distinct phases.

    Instead of having a single behemoth class, we're now using separate classes for distinct phases - generation, installation, publishing. This makes the code clearer and allows reuse existing input/output paths mechanism implemented in GBGenerator and GBOutputGenerator.
    committed Jan 18, 2011
Commits on Jan 17, 2011
  1. Increased build number to 521.

    committed Jan 17, 2011
  2. Added twitter name to readme.

    committed Jan 17, 2011
  3. Merge branch 'development'

    committed Jan 17, 2011
  4. Merge branch 'development'

    committed Jan 17, 2011
  5. Released verion 2.0!

    committed Jan 17, 2011
  6. Incremented build number to 514.

    committed Jan 17, 2011
  7. Implemented appledoc build number to make it simpler to check which v…

    …ersion was used for generation.
    committed Jan 17, 2011
  8. Updated templates to use user's whitespace. Closes #34 and #37.

    Note that this commit is only the last one in series which started at 214c662 that ultimately fixed above issues.
    committed Jan 17, 2011
  9. Refactored lists processing to match the code used for directives.

    Not only this makes both codes similar, it also results in cleaner code.
    committed Jan 17, 2011
  10. Fixed bold-italics decorators handling.

    The problem was with the fact that we needed to register text to inner decorator, but register the outer one to the paragraph. To reuse registration code, we correctly assigned inner decorator for text registration, but then only registered the inner decorator to paragraph, effectively discarding outer one completely. This is properly handled now.
    
    In fact, this fixes the remaining 7 unit tests and closes code refactoring!
    committed Jan 17, 2011
  11. Fixed remaining text items processing unit tests.

    The problem with these was in using normalized description as the string value. Although we could update unit tests to compensate for this, it would be a deviation from the rest of the code - we're now strictly using user's whitespace so we should also use this for string values.
    
    This fixes another set of 4 unit tests with 7 remaining.
    committed Jan 17, 2011
  12. Fixed multiple @see directives processing.

    The problem was that we always popped last paragraph inside processing loop, but @see directives don't push one! This is properly handled now, fixing another batch of 2 unit tests.
    
    11 more unit tests to go.
    committed Jan 17, 2011
  13. Further fixing of comment directives parsing by restoring description…

    … regexes that handle multiple lines.
    
    This was removed in one of the previous commits as it seemed it worked better this way. However it needed to be added back as this prevented handling descriptions spanning multiple lines. The real problem was elsewhere and was fixed with one of the previous commits.
    committed Jan 17, 2011
  14. Fixed comment directives processing and normal paragraphs handling.

    The problem was when popping directive paragraph which resulted in registering the paragraph to the comment as well if there was no other paragraph on the stack. To properly handle such situations, pushing paragraphs requires sender to specify whether the paragraph is auto-registerable or not. This information is then used when popping and the paragraph is only registered if the flag was set.
    
    This closes another 25 unit tests, with 18 to go.
    committed Jan 17, 2011
  15. Fixed link items processing.

    The problem was we only handled links that started with a word, which effectively ignored any links embedded within punctuation.
    committed Jan 17, 2011
  16. Fixed warning block processing.

    The problem was in copying the code from bug block and forgetting to change regex.
    committed Jan 17, 2011
  17. Updated comment text processing validation methods to keep whitespace.

    This fixes another 39 unit tests with 43 to go.
    committed Jan 17, 2011
Commits on Jan 16, 2011
  1. Implemented comment directives processing.

    This handles @param, @return and the rest. 6 more unit tests pass, 82 to go.
    committed Jan 16, 2011
  2. Implemented paragraph text processing.

    This makes 67 more unit tests pass, 88 to go...
    committed Jan 16, 2011