Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Commits on Mar 7, 2012
Commits on Dec 24, 2011
Commits on Dec 8, 2011
  1. Fixed usage of single star as bold marker (kind of). Closes #154.

    The problem with star delimited unordered lists was in appledoc comment preprocessor which consumed single star and replaced them with double star markers so that text would be emitted in bold. That's actually a feature of appledoc which allows single stars be used for bold markers, but may break compatibility with Markdown as the result. As there's no reliable way of determining whether the user wants to have star delimited, I decided to go the route I had in my mind for some time now: introduce another command line switch that would prevent handling single stars. It's on/off solution, so not the best one, but everyone can choose at least... Also updated [online documentation]( with example of using the new switch.
    **Important:** As of this version on, single star handling is **off** by default! This may break backwards compatibility with some folks, but I feel it's better to keep as Markdown compatible for new people as possible...
  2. Fixed remaining unit tests, now again to 0 faults...

    **Note:** Should convert to sen test as it's supported natively by Xcode 4 and provides much better IDE integration...
Commits on Mar 16, 2011
  1. Fixed remaining bug which resulted in duplicated output. Closes #83.

    The error was the same as before: although search range was given when looking for "simple" cross references, string's length was used when computing remaining search range instead of the given source range. This was a bit harder to spot as it only happened in certain circumstances: when using a combination of Markdown pre formatted cross references.
    Should work now...
Commits on Mar 14, 2011
  1. Fixed partial repeating of comment source strings while processing us…

    …er's Markdown links. Closes #83.
    The problem was in the processing code which didn't use search range but instead searched till the end of the string. This probably came via copy/paste from higher level method which actually handles the whole string... It only affected manual Markdown links written by the user. Also added additional unit test to guard against this for the future changes. Briefly checked other methods dealing with partial strings and they look valid, but it would be nice to keep this in mind in case something similar happens in the future.
    Note: This was one of those small issues code-wise that resulted in totally messed up output, giving impression some fundamental flaw was present. But, although a method was fundamentally wrong with it's presumptions, the error was very easy to pinpoint and fix. Now if only all the issues would work like that :)
  2. Fixed conversion of single to double star within example blocks and s…

    …pans under certain circumstances. Closes #77.
    The problem was with appledoc treating single star as bold and single underscore as italics while Markdown treats single star or underscore as italics and double star or underscore as bold. This requires appledoc preprocessing comment text and converting any single star marker to double star. However as Markdown processor doesn't convert markers inside code blocks, this effectively changed the layout in there. To further complicate the issue, appledoc preprocessor doesn't know in advance whether certain part of text will be converted to code block or not. To compensate, appledoc now leaves original markers untouched and uses placeholder strings when converting single stars to double ones. These placeholders are caught and properly handled later on, in generated HTML where detecting code block or span is simple.
Commits on Feb 24, 2011
  1. Improved copied documentation handling for methods from super classes…

    … and adopted protocols. Closes #70.
    The documentation is now properly processed only in the original context with slightly different behavior when creating cross references to local members; these are now generated so that they can be reused from any other object as well!
Commits on Feb 23, 2011
  1. Fixed code blocks auto generated links handling.

    If appledoc creates a cross reference link in a text that's later on converted to code block by Markdown processor, all such links are cleaned up when creating HTML value. This is required as Markdown processor doesn't process links inside these blocks.
    Note that this is not the most elegant solution: first we process the text and convert to links, then we process generated HTML again and remove inserted links. Ideally, this situation should be detected while processing string and prevent creating links there in the first place. However we would require reimplementing detection of code blocks there, so at least for now, this should be good enough - as code blocks are not that common this should not affect performance too much...
Commits on Feb 22, 2011
  1. Fixed cross references embedded within code spans.

    Using back tick Markdown syntax for code span, prevents Markdown from processing embedded text. This is fine from Markdown point of view (i.e. create HTML examples and similar), it creates issues with appledoc as any Markdown link generated from known object, embedded inside back ticks isn't converted properly. To overcome this, we need to embed back tick inside description manually after parsing. In the same time we need to take only handle links we generate while leaving any user entered ones unchanged!
Commits on Feb 20, 2011
  1. Implemented prefix for local methods cross references when used as re…

    …lated items.
    Apple uses -, + or @property prefix for these.
Commits on Feb 19, 2011
  1. Implemented proper @warning and @bug Markdown processing.

    We need to turn these into blockquotes so that Discount will turn them into properly classes div element.
Something went wrong with that request. Please try again.