AutoDoc is a FREE utility that generates NEXTSTEP-style Rich Text Formatted documentation for Objective-C objects by extracting comments imbedded in the object source code files. Autodoc will produce documentation for functions, definitions, macros, typedef's and global variables, however documenting these resources is not the primary goal of AutoDoc, and it expects to find their definitions and documentation within the framework of Objective-C objects.
AutoDoc is available for free, thanks to ITSolutions. The latest release of AutoDoc, v1.8.1, is included in the upcoming MiscKit release (MiscKit 1.6.1), as well, AutoDoc is available at ftp.its.com.
BACKGROUND
AutoDoc is a perl script developed by Adam Swift aswift@its.com at Information Technology Solutions, with contributions from Bill Bumgarner, Todd Nathan, and Kim Shrier. AutoDoc has been donated free of charge to the Public Domain.
SYSTEM REQUIREMENTS
In order to run AutoDoc, you need to have perl v5.001 installed on your system. Perl is freely available from a number of places, but the most up to date version (precompiled tri-fat) is available from ftp.thoughtport.com thanks to Bill Bumgarner.
INSTALLATION
See the INSTALL file for information on installing and running autodoc. In general, previous autodoc execution lines should work as they did before; however, the installation process is a little bit more involved because autodoc has been broken into modules.
RELEASE NOTES
See the CHANGES file for a summary of improvements since the last release. Biggest change: functions, constants, typedefs, globals, and macros are now documented.
OTHER STUFF
Mailing List:
There is now a autodoc mailing list: autodoc@friday.com. To subscribe, send an empty message with the subject line, "subscribe", to <autodoc-request@friday.com>.
