Introduction
This page documents the internals of the HeaderDoc family
of tools. For general user documentation, read the
HeaderDoc User Guide.
The HeaderDoc suite consists of several tools:
headerDoc2HTML.pl- The main HeaderDoc tool. Converts headers or source
code files to HTML or XML.
gatherHeaderDoc.pl- Gathers up HeaderDoc-generated HTML and generates
a master table of contents.
resolveLinks- Links the HeaderDoc-generated HTML pages together.
(Called by
gatherHeaderDoc.pl.)
xml2man- Converts a dialect of XML into manual pages.
hdxml2manxml- Converts HeaderDoc XML output into a form suitable
for use with
xml2man.
filtermacros.pl- Tool for filtering incoming content based on
C preprocessor directives.
headerwalk.pl- Sample code demonstrating reuse of the HeaderDoc
parser.
Some of these tools also use a number of Perl modules. These
modules are divided up into groups based on the role they serve.
Last Updated: Saturday, August 06, 2016
|