Skip to content
This repository

Mar 03, 2011

  1. tomaz

    Implemented possibility of injecting descriptions to main index file.…

    … Closes #74.
    
    Using `--index-desc` switch, you can pass the path to the file containing description that'll be injected in the auto generated index.html. The file can be formatted using the same rules as any other static document. The difference is it's not possible to link to it from other objects or documents (each generated object html already contains the link to main index and hierarchy). But it's possible to link any class or document from within the index description; the same logic is used for that as for any other source code comment or static document.
    
    Online documentation will follow briefly... For now give it a try and let me know if there's anything else missing or something not working as expected.
    authored March 03, 2011

Feb 11, 2011

  1. tomaz

    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](http://tomaz.github.com/appledoc) 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 :)
    authored February 11, 2011

Dec 13, 2010

  1. tomaz

    Refactored settings handling by removing GBStoreProviding protocol.

    Reasoning is similar to previous commit.
    authored December 13, 2010

Nov 14, 2010

  1. tomaz

    Copied all the changes from the old generating branch.

    Something broke while copying the project over from the old computer, so the simplest way to fix this was to pull from GitHub and copy all the files from the local backup...
    authored November 14, 2010

Aug 27, 2010

  1. tomaz

    Prepared default processing class and invocation from GBAppledocAppli…

    …cation.
    authored August 27, 2010
  2. tomaz

    Enabled line wrapping and updated comments to fit better.

    authored August 27, 2010

Jul 26, 2010

  1. tomaz

    Implemented unit testing target and basic class parsing tests.

    authored July 26, 2010
Something went wrong with that request. Please try again.