Autodoc

Automatic Documentation Program

Invocation Options

-project projectdirectory
Used to specify a project directory for reading in object source files. If no object source files are specified, then all files in projectdirectory (and its subdirectories) which form a pair, "FileName.h" and "FileName.m", as well as all files ending in ".h" (unless the -nosingles switch is specified,) are used to produce documentation. The documentation produced will be saved under the root name for each of the file pairs, and will be stored in the source files' directory (unless the -destination option is used.)

-destination destinationdirectory
Used to specify a destination directory for the documentation files produced. If the -tree option is also used, any source files which are prepended with a file path, will be placed in a subdirectory of the destination directory with the same file path.

-copyright copyrightowner
Used to specify an copyright owner for the copyright line on top of the documentation file. This will override the copyright owner specified by the environment variable AD_COPYRIGHT if both are used.

-version
Displays the version number and copyright information for Autodoc.

-help
Displays the command line options available in Autodoc, with synopses of their purpose.

-timestamp
Includes the current time and date in the copyright line of the documentation files created.

-nosingles
Excludes unpaired source files from the files used to produce documentation (i.e. if the file "FileName.h" is in a directory which does not contain "FileName.m", no documentation will be generated from it.)

-rtf
When combined with the -project and -destination options and no object files are specified, this will copy all files found with an 'rtf' or 'rtfd' extension found in the project directory or its subdirectories to the destination directory.

-force
Force Autodoc to generate documentation files, even if the documentation files already exist and are newer than the source files. By defualt, Autodoc will not overwrite documentation files which are newer than their source files.

-tree
Specifies that the documentation should be generated into a directory tree based on the directories traversed in locating the source files. This can be combined with the -project and -destination options to produce subprojects source file documentation in subdirectories of the destination directory.

-silent
Makes Autodoc operate in silent mode, the only messages printed are error messages logged to stderr. Normally Autodoc alerts the user whenever a file or directory is created.

-Debug level
Makes Autodoc operate in DEBUG mode, verbose debugging messages are logged to stderr. The debugging levels for Autodoc range fall in the the following categories:

1. Objects being processed and general Autodoc configuration information
2. Object source files as they are accessed
3. Object data that is located, and a summary of what was found
4. Detailed information about all object data that is extracted
5. Complete logging of every line of text read in from the source files.

History

Change Log For Autodoc

• Completed checkin using DevMan Logs

• Continuing to try DevMan Log history

• fixed "up to date documentation" testing
• added missing small newlines between the methods and their documentation
• moved tab locations in the Defined Types stuff to improve doc apperance
• long method lines are now broken into multiple lines
• added new paragraph styles to the GenerateRTF module

• completely documented GenerateRTF.pm Autodoc module
• abstracted DumpDocs to remove rtf dependancies
• fixed case insensitive argument parsing to differentiate -D from -d (bbum)
• cleaned up usage of 'require' and 'use' to remove redundancy (bbum)
• added support for documenting what protocols an object conforms to.
• added support for documenting protocols. (Craig Kelley)

• added version control to the support modules, and their version is now reported when the -version option is used
• removed some warning messages in file_expandpath
• fixed bug preventing doc creation with .[hm] files with no object def.
• fixed resource naming when files are specified with no project dir
• fixed boldifying values of typedef-type structures
• allowed multiple levels of indention to follow curly braces in typedef's

• fixed documentation extraction failure detection
• added support for AD_PMLIBDIR to specify perl module lib directory
• added more log debugging to AutodocSupport .pm files
• moved LogDebug::Log.pm into AutodocSupport::LogDebug.pm
• moved FileSupport::Misc.pm into AutodocSupport::FileSupport.pm

• added -nosingles option to exclude unpaired '.h' and '.m' files from docs
• added support for functions, typedefs, defines, macros, and globals
• moved all Autodoc doc creation into AutodocSupport::DumpDocs
• moved all Autodoc source reading into AutodocSupport::ReadSource
• moved Autodoc comment parsing into AutodocSupport::ParseComment
• moved source file scanning code into AutodocSupport::ScanFile module
• added timestamping capability for documentation
• can now set copyright string with environment var: AD_COPYRIGHT
• moved debug logging into LogDebug::Log
• moved filepath expansion into FileSupport::Misc

• added support for GetOpts::Long package; GetOpts::Long can deal w/single character argnames as long as they aren't ambiguous.
• removed all warnings produced by perl -w
• modified scan_line to discard stars from the beginning of ADC lines
• added -help option; shows help and exits.
• made a Source directory and moved code files into (as per the README)
• look for ' bbum'; i fixed a bunch of a stuff that produced warnings when the rtf documentation did not yet exist.
• fixed -force so that it actually works.
• added NULL to list of bold words
• any instance variable on a line w/the word "INTERNAL" will be skipped.
• fixed method parameter matching to allow whitespace between the : and arg. (Kim Shrier)
• fixed argument italicising in method docs to parse out whitespace between the : and arg (Kim Shrier)

• added \ escaping for % and # characters to force display

• fixed the "Category Description" bug. Was putting out "Class Description" (Todd Nathan)

• added option to force overwriting up-to-date documentation files
• added time check for source and doc files to prevent unnecessary work
• added support for copying .rtf and .rtfd files to the doc dir
• added support for specifying a copyright owner on the command line
• fixed ivar parsing so it doesn't skip the line with the starting brace

• added minimal category support.
• changed filename to autodoc (from AutoDoc)
• added support for relative path naming for documentation and project dirs.
• fixed bug which aborted doc creation if no newline was found on @end line

• Added minimal support for lists of items via _{xxx desc} format
• Fixed matching problems at beginning and ends of text strings
• Added "id" to the list of bold words.
• Filtered out @public/@private/@protected modifiers in ivars.
• Fixed incorrect struct detection in ivars with curly braces in a following Autodoc comment.

• Started tracking changes

Change Log For ReadSource.pm

• Added DevMan style changes Log support

Change Log For DumpDocs.pm

• Added DevMan style changes Log support

Change Log For ScanFile.pm

• Added DevMan style changes Log support

Change Log For LogDebug.pm

• Added DevMan style changes Log support

Change Log For GenerateRTF.pm

• Added DevMan style changes Log support

Change Log For ParseComments.pm

• Added DevMan style changes Log support

Change Log For FileSupport.pm

• Added DevMan style changes Log support

Please send comments and questions to webmaster@friday.com

Copyright © 1995, Friday Software and Consulting, Inc.. All Rights Reserved.