Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Commits on May 10, 2011
  1. Refined exit codes handling. Closes #102.

    This commit concentrates on two related issues:
    - It adds a new command line switch `--exit-threshold` which allows users specify the threshold value (numeric) which is used to filter out tool exit codes: if reported exit code is below the threshold value, tool simply returns 0.
    - Restructures exit codes values to have higher value representing more severe condition. This plays nicer with previous point. Currently warning has value 1, error 2, fatal 3 (although fatal is not used currently in the tool).
    Note that it's not possible to suppress crashes, regardless of whether the threshold is set above the value (250 currently)!
    Also updated build number to 692.
Commits on May 9, 2011
  1. Restructured exit codes handling, attempting to tackle #102.

    Exit codes are now better structured to domains and error codes. Also added a debug log statement (available with `--verbose 6` switch) at the end of the run to log the exit code as "seen" by the application.
Commits on May 3, 2011
Commits on Apr 28, 2011
  1. Cleaned up few compiler warnings (no big deal).

    These seem to be new warnings from Xcode 4.1 as I didn't get them in Xcode 4.0.
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 26, 2011
  1. Implemented project settings. Closes #67.

    There are several ways of adding project settings:
    - Add AppledocSettings.plist file to one of the paths given to appledoc on command line. If the file is found in a path, it's settings are automatically injected. The same path is also used for source parsing. This allows command line like `appledoc .`.
    - Add specific path to a file with arbitrary name and .plist extension. The settings from the file are injected, but the file is not used for parsing.
    In both cases, the .plist file has the same syntax as global settings file, except that project settings allow additional option `--input`, which should be an array of strings, each pointing to a source file or directory. These paths can be relative to the .plist file or absolute (will update online documentation soon with examples). The input option is optional; if not used, command line is expected to have at least one source file or directory.
Commits on Feb 21, 2011
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.
Commits on Feb 16, 2011
  1. Renamed GBCommentsProcessorTesting to prepare it for multiple testing…

    … files (just about being added).
Commits on Feb 15, 2011
Commits on Feb 14, 2011
  1. Cleaned up source code.

Commits on Feb 11, 2011
  1. Implemented possibility to add arbitrary documentation. Closes #7.

    This was one of much requested features. It allows adding arbitrary files to generated documentation. It's enabled with one or more `--include` switches. All files and directories specified are simply copied to `docs` subfolder within generated HTML files. So basically, you're free to write any HTML or whatever you want included with the generated documentation.
    But the power lies in special "template" files. These are just normal text files which names end with `-template` (for example `document1-template.html). Extension of these files is not important - they will always be converted to .html! The files can reside on any subpath - the path will be preserved. All such files are processed using the same logic as any other comment, so you can use appledoc comment syntax, including cross referencing any object or member. You can also cross reference these files from "normal" comments (or other documents) by simply writing the filename without `-template` and extension. You don't have to deal with subpaths either, these will be automatically picked up for you! [Online documentation]( is not yet updated, will do it shortly.
    At this point, it's basic stuff only. As such it has much potential for future (like adding markdown syntax for headings, images and similar - for now just use HTML tags). But at least it's a start and get's work done for the moment.
    Enjoy and let me know if you find something not working as expected :)
Commits on Jan 29, 2011
Commits on Jan 28, 2011
Commits on Jan 26, 2011
  1. 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.
Commits on Jan 24, 2011
  1. Fixed unit tests target by adding all doc set generators to compile p…

    After splitting doc set generation into 3 distinct phases, the 2 new classes were not added to unit tests target resulting in linker errors.
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.
Commits on Jan 13, 2011
Commits on Dec 29, 2010
  1. Changed prefix header name to properly cased filename. Closes #18 & #13.

    This one was reported twice now, although rebasing fixed it for #13. As I don't remember touching this it might be Xcode bug, but will need to make further tests to confirm.
Commits on Dec 28, 2010
  1. Added checklist for releasing new versions.

    This should avoid most embarrasing mistakes such as failing to create doc set :) The list should be work in progress and updated with time.
    Hm, hope I'll follow it though :))
Commits on Dec 14, 2010
  1. Added default readme file.

Commits on Dec 13, 2010
  1. Refactored settings handling by removing GBStoreProviding protocol.

    Reasoning is similar to previous commit.
  2. Refactored settings handling by removing GBApplicationSettingsProvidi…

    …ng protocol.
    Instead, the GBApplicationSettingsProvider class is used. Objective-C can solve "program to interface" rule quite easily through anonymous type and we can as easily mock classes as we can protocols, so having a protocol only complicated development...
Commits on Dec 10, 2010
Commits on Dec 7, 2010
  1. Implemented documentation copying for overriden methods and fixed rem…

    …oval of undocumented objects.
    Due to the fact that we may copy documentation from superclasses, we must remove undocumented members and objects only after processing members, otherwise we would delete overriden methods before getting the chance to copy the documentation.
Commits on Dec 6, 2010
  1. Implemented basic categories merging handling.

    At this point we simply remove the category without actually merging as we're only testing merging on/off switch.
Commits on Dec 5, 2010
  1. Restructured unit tests for undocumented objects and members to get m…

    …ore specific testing in separate files.
    All unit tests specific to undocumented objects and members were moved to a separate file to keep test cases more understandable and up to the point.
Commits on Nov 30, 2010
  1. Refactored placeholders strings handling for GBApplicationSettingsPro…

    …viding to encapsulate replacements for it's values.
    This simplifies the rest of the application, reduced code clutter and speeds up as these values don't change during the run!
Commits on Nov 29, 2010
Something went wrong with that request. Please try again.