Distributed applications

An alternate tool is zdoc.

Two applications are distributed, autodoc and tkautodoc. The difference between them is that autodoc starts scanning immediately, tkautodoc on the other hand pops up a graphical interface, allowing for interactive redefinition of some options before the start of the scan.

General invocation of both is as (tk)autodoc ?-option value?....

Recognized options are:

-v: Possible values are 0 and 1. If set to 1 the values of all options are written to stdout. Defaults to 0.
-srcdir: The directory containing the distribution to be documented. Defaults to the current working directory.
-outputdir: The directory to write the generated HTML pages into. Defaults to subdirectory 'html' of the current working directory. Will be made, if not in existence already.
-tables: Possible values are 0 and 1. Has effect only if the distribution contains '.doc'-files generating additional pages. Influences the layout of the homepage. If set to 1 distribution description and links to the additional pages are placed side by side. Otherwise the additional links are placed below the description. Defaults to 0.
-replyaddr: The mail-address used at the bottom of every page. Defaults to [logname]@[info hostname]. 'logname' is defined in the package Pool_Base.
-psort: Possible values are 0 and 1. Determines wether procedure/method definitions of a file/class are written alphabetically sorted (1), or in the order encountered during the scan (0). Defaults to 1.
-ptable: Possible values are 0 and 1. Determines wether procedure/method definitions of a file/class are written as table (1) or definition list (0). Defaults to 1.
-up-link: The url to use as target in the uplink to the site containing the generated documentation. Ignored if neither -up-title nor -up-image is set.
-up-title: The string to use in the uplink to the site containing the generated documentation.
-up-image: The symbolic name of the image to use in the uplink to the site containing the generated documentation, as defined with a call imgDef.
-up-imglink: A boolean flag. Determines wether the image is made a part of the generated uplink or not. Ignored if no text was given, the image has to be the link in such a case.
-exclude: A list of glob patterns. All files with names matching at least one of the patterns will be excluded from the scan and documentation processing. This option takes effect while the system is searching for files to document and while searching for additional .doc and .predoc files.
-clisttype: Either one of comma or par. Defines the appearance of the lists used in classes to reference superclasses, options, methods and member variables.
-no-problems: Boolean option. If set the system will not write the accumulated problem reports / pages. It will still write that there are problems and how many, if any. Default is 0 == no supression.
-css: Boolean option to control support for cascading style sheets (CSS). Support is enabled by default.
-fsort-fullpath: Boolean option. If set the listing of files in their index is sorted by their full path. Else the first letter of the real filename (directories stripped).
-file-prefix: In effect only if -fsort-fullpath is set. Defines a prefix to remove from the path before taking the first letter.
-class-prefix: Defines a prefix to remove from the namespace of a class before taking the first letter.
-proc-prefix: Defines a prefix to remove from the namespace of a procedure before taking the first letter.
-namespace-prefix: Defines a prefix to remove from the namespace of a namespace before taking the first letter.
-itk-opt-alias: The name of a custom command found in the code to scan and equivalent to itk_options.

Both applications read the file '.autodocrc' in the home directory of the caller, if present, and incorporate any option-values defined in it. These definitions take precedence over the hardwired defaults, but can be overridden by the command line.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,