Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Commits on Aug 13, 2012
  1. @kenji21

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

    kenji21 authored
    …thod] now works) and markdown generation. Refs #237
  2. @kenji21
  3. @kenji21
  4. @kenji21
Commits on Jul 13, 2012
  1. @timshadel

    Allow the selection of a template path at compile time

    timshadel authored
    This path takes the least precedence, and allows packaging systems
    like Homebrew to place the templates from the current version in
    a path which this binary will look for as a last resort.
    That makes the default case of, "please give me the latest version
    of the templates," work seamlessly, while also allowing anyone to
    override it using the existing instructions in the documentation.
    --Tim Shadel <>
Commits on Jun 26, 2012
  1. @demosdemon
  2. @demosdemon

    Issue #223

    demosdemon authored
Commits on Jun 11, 2012
  1. Fixed Xcode quick help. Fixes #217.

    Turns out recent change to better support Dash broke Xcode quick help - Xcode does rely on `DocSetPlatformFamily` info plist key, must be either empty string or one of the valid platforms. To compensate and still support Dash, a custom key was introduced - `DashDocSetFamily`, if its value is `appledoc`, Dash will use optimized rendering.
Commits on May 18, 2012
  1. Implemented better support for Dash. Closes #217.

    Dash can take advantage of appledoc generated documentation sets by displaying TOC and click to copy. To be able to do so, it requires `--docset--platform-family` value to be `appledoc`. Current documentation set reference doesn't mention this key anymore, so it seems safe to hijack it. If this isn't desired, you can still revert to empty string or whichever value you want by explicitly using the cmd line switch (of course, you can also do it inside project or global settings plist files).
Commits on Mar 8, 2012
  1. Updated build number to 789.

Commits on Mar 7, 2012
Commits on Mar 6, 2012
  1. Support for Programming guides in TOC and Index Page. repeating short…

    smorel authored
    …Description in discussion disabled by default.
Commits on Mar 2, 2012
  1. @jerryhjones

    Add support for @note tags.

    jerryhjones authored
    Add support for printing titles of information blocks.
    Apple displays "Note:" in bold at the start of their note documentation. We'd like to do the same for warnings and bugs. This is now the default, and can be turned turned on/off with the 'print-information-block-titles' setting.
Commits on Feb 28, 2012
  1. Parsing for objc shortcuts is not less strict. Closes #194.

    The problem was in appledoc expecting to have either both or neither of variable name and type keywords for a method argument. So this would pass `-(void)method:`, but this not `-(void)method:var`. The fix is simple: just assume the argument is `id`. So later example would transform internally to `-(void)method:(id)var`. Which is probably what Objective C compiler does too.
    Have no idea why I didn't think of this before, it's much less restricting (although probably not the recommended way of doing things in ObjC, but that's whole other topic I guess :)
Commits on Feb 25, 2012
  1. Self references don't form links. Closes #190.

    This covers the following cases:
    - Cross reference to "current" class, category or protocol.
    - Cross reference to "current" method or property.
Commits on Feb 23, 2012
  1. When merging categories to classes, their comment is also merged. Add…

    …resses #117.
    This is on by default, but can be controlled through `--merge-category-comment` cmd line switch.
  2. Updated build number to 764.

Commits on Feb 22, 2012
Commits on Feb 21, 2012
  1. Fixed NSInvalidArgumentException: -[__NSCFConstantString code]: unrec…

    …ognized selector sent to instance error. Thanks to @lhunath!
    The problem was that appledoc used custom `[NSException raise:format:]` override in an `NSException` category. Overriden method expected `NSError` being passed in as the first parameter, but default method expected `NSString` (i.e. exception name). The fix was to rename override (it's probably always a bad idea to override a method in a category anyway).
  2. Added better support for iPad, thanks to @JoeWard. Closes #119.

    I'm closing the ticket, but feel free to reopen or comment in case this doesn't fix everything!
Commits on Dec 30, 2011
  1. Updated build number to 752.

Commits on Dec 24, 2011
  1. Cleaned up HeaderDoc parsing code and made it optional. References #95

    …and #163.
    As comment preprocessing method in `GBTokenizer` became quite large, I divided it into separate methods by taking out header doc preprocessing. Also made header doc preprocessing optional and disabled by default (except the bare minimum covered by #95). To enable it, use `--preprocess-headerdoc` command line switch. The reason for opting it out by default is amount of preprocessing that could break things for existing appledoc users. Probably just me being paranoid, but better safe than sorry :)
Commits on Dec 19, 2011
  1. Fixed category cross references formatting. Closes #160.

    The problem was in Discount parsing URL with parenthesis `[text](path/with(parenthesis).html)` as `<a href="path/with(parenthesis">text</a>.html)`. Not sure if this is Markdown rule of how paths with parenthesis are handled, but the simplest solution was to convert category paths to not use parenthesis.
    **IMPORTANT:** From here on, category paths are constructed with a plus sign: `class+category`. Previously they were using format `class(category)`. Although this should be simply upgraded by running appledoc, it may break external links. Something to keep in mind...
Commits on Dec 15, 2011
  1. Increased build number to 743.

  2. Updated build number to 741.

  3. Fixed html literals handling with doc set. Closes #107.

    Today got a feedback from Apple on my bug report:
    > When constructing the Tokens.xml file, you have to remember that the file needs to be valid XML first and foremost.  You cannot have a standalone & or an unrecognized XML &entity; in an XML file.  They have to be encoded for the XML first.  For example, if you have the abstract string "This & that", you need to store it in the XML file like this:
    >     <Abstract>This &amp; that</Abstract>
    > When docsetutil (or any XML parser) reads the abstract string, the &amp; will get converted into a plain & character.  If you are trying to display a literal entity string, such as "This &asterisk; that", you need to still escape the ampersand character:
    >     <Abstract>This &amp;asterisk; that</Abstract>
    > However, if you want your entity to render as a particular character when displayed in QuickHelp, you need to mark the string as HTML:
    >     <Abstract type="html">This &amp;asterisk; that</Abstract>
    > The XML parser will see the abstract string as "This &asterisk; that" and will pass it on to the HTML parser, which will then render the string like "This * that".
    > Please let us know if that information helps you resolve the issue.
    Turns out the fix is to change abstract type to html and replace all occurrences of `&` with `&amp;` in token xml files, so for example `&ndash;` should become `&amp;dash;`. Tried few tests on it and works for me. The literals (i.e. `&ndash;`) are properly rendered in Xcode quick help and html. Took a while, but this solution didn't occur to me... Have a go and report back if you have any issue with this.
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...
Commits on Sep 1, 2011
  1. Fixed single and other odd placement of asterisk signs. Closes #96.

    **Note:** This should resolve the issue, although the whole processing of single asterisk as bold marker makes the code quite fragile. The best solution would be to revert to standard Markdown and stop handling single asterisk as bold. This might break existing users comments somewhat, but should provide more stable platform for the future...
Commits on Aug 19, 2011
  1. @lhunath

    Added support for excluding paths from the output.

    lhunath authored
    This is useful if you only want to generate documentation for certain
    sources but those sources depend on other sources that should not have
    documentation generated for them.  With this feature, you add all
    sources as input and exclude certain sources from output generation.  It
    will hide warnings on excluded sources, not generate output for them,
    but they will be used for merging with your included sources (eg.
    inheritance etc.)
Commits on Jul 13, 2011
  1. Added support for UTF8 documentation

    zittix authored
    Fix appledoc #122 ( #122 )
    The issue was that the string sent to Discount was relying on the [str length] method which return the number of characters instead of returning the number of bytes in the UTF8 string. After that, the converted markdown string was converted back to obj-c string using ASCII encoding which was breaking everything.
    - Add a test case for UTF8 string handling
Commits on Jul 11, 2011
  1. @zittix

    Added support for availability comment.

    zittix authored
    Using @since or @available comment in a method description will generate a new section in the method doc. called "Availability". The content of that section will be the text following the @since or @available tag.
Something went wrong with that request. Please try again.