Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Commits on Oct 18, 2011
  1. @tomaz

    Merge pull request #144 from groue/master

    tomaz committed
    Added support for termination macros for method declaration and properties declaration
Commits on Oct 15, 2011
  1. @groue
Commits on Sep 14, 2011
  1. @tomaz

    Merge pull request #138 from e28eta/patch-1

    tomaz committed
    Fixed typo in log message: "Checking for known superclasses and adopted p
Commits on Sep 8, 2011
  1. @e28eta
Commits on Sep 3, 2011
  1. @tomaz

    Fixed typo in install script.

    tomaz committed
  2. @tomaz

    Merge pull request #136 from SevInf/master

    tomaz committed
    Scripts for quick installation.
  3. @SevInf

    Fixed incorrect Templates copying

    SevInf committed
    If TEMPLATES_DIR existed script copied Templates directory instead of
    its content there
  4. @SevInf
  5. @SevInf

    Added script for quick installation of the app and templates

    SevInf committed
    Added script that can be used to quickly install
    appledoc. It can be invoked from terminal with "sudo sh" command. By default, it installs binary to
    /usr/local/bin and templates to ~/.appledoc. This directories can be
    overridden with -b and -t options respectively.
Commits on Sep 1, 2011
  1. @tomaz

    Fixed single and other odd placement of asterisk signs. Closes #96.

    tomaz committed
    **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...
  2. @tomaz

    Fixed dorset indexing for categories. Closes #120.

    tomaz committed
    The problem was in tokens.xml files which used only class name when composing identifier strings for categories and their members.
    Note: My quick testing confirms this working, but if anyone experiences issues with category members, let me know - either comment this issue or create a new one.
Commits on Aug 26, 2011
  1. @tomaz

    Merge pull request #133 from lhunath/master

    tomaz committed
    Added support for excluding paths from the output. Use `--exclude-output` option for entering all paths that should be parsed, but excluded from generated output.
    Although this is similar to `--ignore`, there's one important difference: Ignore option will simply prevent any parsing happening over specified files or folders, hence it will result in warnings in case symbols from these paths are referenced in documentation that gets parsed. Exclude parses specified files or folders, but it simply doesn't output them, therefore you get no warnings. It's somewhat slower on the other hand due to having to parse extra files.
Commits on Aug 19, 2011
  1. @lhunath

    Added support for excluding paths from the output.

    lhunath committed
    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.)
  2. @lhunath
Commits on Jul 13, 2011
  1. Added print style

    zittix committed
    Added a stylesheet to allow printing the doc.
  2. Improved HTML template generation

    Mathieu Monney committed
    - Improved the different templates with the standard appledoc header (merged from rasterize/appledoc).
    - Added the projectCompany and projectName template variable to all template document
  3. Added h2 style for general html documentation

    Mathieu Monney committed
  4. Added support for UTF8 documentation

    zittix committed
    Fix appledoc #122 ( tomaz#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 committed
    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.
Commits on Jul 7, 2011
  1. @tomaz
Commits on Jul 6, 2011
  1. @tomaz

    Fixed typo in log message.

    tomaz committed
Commits on Jun 27, 2011
  1. @tomaz

    Fixed method merging for cases when instance method is merged on a cl…

    tomaz committed
    …ass method. Closes #90.
    This was working when instance method was registered first and class method with the same name was merged on it later on. But it didn't handle the other ordering. Hopefully this will allow handling all cases. Note that there might still be cases when merging properties and class methods - keep in mind if the issue get's re-opened.
    Also updated build number to 703.
Commits on Jun 9, 2011
  1. @tomaz

    Addressing `&` and `&token;` issues when indexing documentation set, …

    tomaz committed
    …partially easing #107.
    Note: unfortunately it wasn't possible to continue indexing remaining files after encountering an error - docsetutil takes path to docset bundle, not individual files. So all symbols in the offending file AND all symbols in subsequent files will not be indexed.
    Also note that appledoc will log a warning and hence exit with code 1 in case it gets these errors! You'll probably want to use `--exit-threshold 2` or more if you're running from Xcode build script.
    For the moment, the only "workaround" is to stay clear of using these symbols in your own documentation. If you're using third party libraries or frameworks containing these symbols and only running them through appledoc to get similar looking docs encountering issues, you can only pass it through `--create-html` phase. If you want to have it integrated in Xcode, then go ahead and experiment to see how much of it is usable...
Commits on May 27, 2011
  1. @rastersize

    Fixed some HTML5 stuff.

    rastersize committed
  2. @rastersize
Commits on May 26, 2011
  1. @tomaz

    Fixed Xcode integration warnings and errors full paths handling. Fixes

    tomaz committed
    To allow Xcode properly open the file after selecting the warning in build list, it requires full path to it in the output, so I had to add full path to GBSourceInfo and use that when generating Xcode compatible log.
    Note that I had appledoc crashed inside `[GBLog logFormatterForLogFormat]` when using standard log formats. The problem was with sending the given format instance `lowercaseString` however in case numerical value was used, the actual instance was `NSNumber`. To compensate, additional check was added to make sure the instance is indeed a `NSString`. Strange no one reported this as I didn't touch this code since last pushing to GitHub (or everyone was hardly waiting for Xcode compatibility and are now using that mode :).
    Also added `xcode` log format option to help output and increased build number to 701.
Commits on May 25, 2011
  1. @tomaz

    Implemented better Xcode integration for warnings and errors. Closes #…

    tomaz committed
    By using special log format `--logformat xcode`, appledoc formats warnings and errors related to source files in a way that Xcode is able to catch them and display them in build results. Currently only warnings are using that format (there is no error log message related to source files).
    *Implementation details:* Note that implementation required tweaking Cocoa Lumberjack source. Specifically, it required passing in original source code filename and line number to log message. Although logging macros pick up source file and line automatically through `__FILE__` and `__LINE__`, these belong to appledoc sources. But for Xcode warnings making sense, we need to write the file name and line of the context being parsed. To reuse existing macros, I added both values to DDMessage and additional class method to DDLog which needs to be called prior to logging. The method will simply store info to static vars. Then logging method will pick up stored values, write them to message and reset static vars. When emitting log messages, Xcode formatter will check if these values are set and emit specially formatted logs, otherwise it will revert to message only.
    *Additional note:* Although I searched for all occurrences of `GBLogWarn` and `GBLogError` in the project and updated those that seemed relevant, some may have been left out - let me know about exact messages and I will check it. Also note that parsing code currently doesn't emit warnings, if something goes wrong, exceptions are raised, which doesn't log the file and line. Didn't take much time to go into this as these usually indicate parsing code needs to be refined.
Commits on May 23, 2011
  1. @tomaz

    Fixed class methods with same selector as existing property.

    tomaz committed
    Thanks to Jason Gavris!
Commits on May 11, 2011
  1. @tomaz

    Released version 2.0.4, build 698.

    tomaz committed
  2. @tomaz

    Added basic support for headerdoc comments. Closes #95.

    tomaz committed
    Note that this only adds support for headerdoc style comments (`/*! */`) and `@result` for return value. The tool could be further improved by ignoring unsupported headerdoc tags (like `@abstract`, `@class`, `@method` and similar), but I don't have time for that right now. Will close the issue for now as headerdoc comments can be extracted, and if there will be a lot of demand for this feature in the future, either this issue can be reopened or a new one created.
    Also increased build number to 697.
  3. @tomaz

    Fixed escaping for documentation set when dealing with <> signs. Closes

    tomaz committed
    This covers issues like `Some text <UnknownEntity> and more`. Note that this simply deletes all occurrences of < and > markers. Although this prevents docsetutil from complaining when indexing, it can result in undesired removal of the markers in formulas or similar.
    Also note that current implementation would effectively make `<UnknownEntity>` invisible inside HTML. Although the string is emitted properly, HTML considers it unknown tag and doesn't render it! Although it could be possible overriding this by converting <> to `&ls;` and `&gt;`, this would prevent usage of any custom HTML formatting, like `<tt>something</tt>`.
Commits on May 10, 2011
  1. @tomaz
  2. @tomaz

    Fixed methods being reported in several sections after merging catego…

    tomaz committed
    …ries into classes.
    Although model objects properly merged sections from categories, resulting in empty sections if there were no methods in there, HTML generator rendered existing methods in these sections as if they were actually registered. Although this might require further investigation to really fix the issue (i.e. why output generator doesn't render empty section, why it adds methods to it?), current solution simply removes all empty sections after merging.
    Also updated build number to 694.
Something went wrong with that request. Please try again.