Skip to content
Commits on Sep 8, 2015
  1. @jodyhagins

    This fix addresses three related issues.

    jodyhagins committed
    1. Image links were not being generated right. Specifically, ![foo](http://foo/bar.baz) was generating invalid HTML.
    2. Image links with a separate href were not generated right.  Specifically, [![foo](http://foo/bar.baz)](http://foo/bar.other) was generating invalid HTML.
    3. Percent sign in link was being used as C-string format specifier.  Specifically, [![foo](http://foo/bar.baz%2biz)](http://foo/bar.other) was generating invalid HTML.
Commits on Sep 7, 2015
  1. @jodyhagins
Commits on Sep 6, 2015
  1. @jodyhagins

    Ignore source-code-blocks while processing comments.

    jodyhagins committed
    Appledoc gives warnings when it encounters parsing issues inside
    source code blocks.  In particular, it looks for style markup and
    reference links.  These are especially bad within ObjectiveC
    source code example blocks because of the ObjectiveC bracket
    syntax and the obligatory underscores for category methods on
    Cocoa classes.
    This is similar to bug #72, but not exactly.  I noticed that in
    another similar report, these issues are gone in version 3, so I
    didn't bother trying to fix this completely.
    Basically, the code intercepts the markdown processing, and looks
    for any sections within documentation blocks that are marked with
    either @code/@endcode of the ~~~/~~~ and ```/``` markdown syntax.
    If it finds those blocks, it will output them as markup (making
    sure to use the backtick format), and skip any further processing
    for that block of text.
Commits on Feb 13, 2014
  1. @robbertkl
Commits on Jun 15, 2013
  1. @paulmelnikow

    Fix link content duplication when links are embedded inside other links

    paulmelnikow committed
    When a link falls within another link, such as a URL string within a method call, processing both would result in the processed URL being appended to the processed method call, duplicating the text from the URL. Instead, keep track of the links processed, and ignore a link if it's inside of a previously processed link.
    Here's a test case which illustrates the problem:
    `NSURL *baseURL = [NSURL URLWithString:@""]`
    @interface Fooclass : NSObject
    <p><code>NSURL *baseURL = [NSURL URLWithString:@""]</code><code>"]</code></p>
    With patch:
    <p><code>NSURL *baseURL = [NSURL URLWithString:@""]</code></p>
    The test case does indeed cover this problem but certainly could be improved.
Commits on Aug 13, 2012
  1. @kenji21

    Fixing links with custom title detection (custom titles like [this me…

    kenji21 committed
    …thod] now works) and markdown generation. Refs #237
  2. @kenji21
  3. @kenji21
  4. @kenji21
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 14, 2011
  1. 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 23, 2011
  1. Updated remote member links preprocessing in case unknown object is f…

    We also mark the range to avoid further preprocessing!
  2. 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 20, 2011
  1. Fixed remote member cross references handling when object is known bu…

    …t member isn't.
    In such case, the object was converted to a link. This is properly handled now by keeping unknown remote member text (i.e. not converting at all)!
  2. Added document links processing.

  3. Refactored internal handling of comments processing methods to accept…

    … various flags affecting the handling.
Commits on Feb 19, 2011
  1. Implemented grounds for preprocessing of Markdown syntax links.

    Not finished yet, but committed due to refactoring required for finalizing.
Commits on Feb 18, 2011
  1. Fixed detection of known objects regardless of the prefix or suffix.

    There's no need to have objects separated with whitespace! Note that this may yield unexpected results in case like this: `[Class(Unknown) method]`. If the Class is found, but no Class(Unknown) category, the Class word will be converted to a cross reference. This should be solvable by requiring prefix though.
  2. Fixed categories links detection when a class with same name exists.

    This fixes stuff like `Class(Category)` which should prefer category link if found instead of class link if also found on the same location.
Commits on Feb 17, 2011
Commits on Feb 16, 2011
  1. Fixed Markdown style bold/italics markers processing and added more u…

    …nit tests to cover formatting conversion.
Something went wrong with that request. Please try again.