HEADERDOC2HTML(1) BSD General Commands Manual HEADERDOC2HTML(1)
NAME
headerdoc2html -- header documentation processor
SYNOPSIS
headerdoc2html [-HXdhquvx] [-o output_dir] file [file ...]
DESCRIPTION
Headerdoc2html processes the header file or files and generates HTML doc-
umentation based on specially-formatted comments.
The options are as follows:
-H The -H option turns on inclusion of the htmlHeader line, as speci-
fied in the config file.
-X The -X option switches from HTML to XML output
-d The -d option turns on extra debugging output.
-h The -h option causes headerdoc to output an XML file containing
metadata about the resulting document.
-p The -p option turns on the C preprocessor.
-q The -q option causes headerdoc to be excessively quiet.
-u The -u option causes headerdoc to produce unsorted output.
-v The -v option causes headerdoc to print version information.
-x The -x option causes headerdoc to export fils in a format suitable
for inclusion in a database.
If no options are specified, headerdoc will produce directories contain-
ing its standard HTML output.
FILES
/$HOME/Library/Preferences/com.apple.headerDoc2HTML.config
SEE ALSO
gatherheaderdoc(1)
For more information, see the headerdoc documentation. It can be found
in /Developer/Documentation/DeveloperTools if you have the developer
tools package installed, or at http://developer.apple.com in the devel-
oper tools documentation section.
Darwin June 13, 2003 Darwin
Mac OS X 10.6 - Generated Thu Sep 17 20:07:48 CDT 2009