< Previous PageNext Page > |
|
In addition to the classes shown above, the headerDoc2HTML
script
also uses the non–object-oriented modules Utilities.pm, ClassArray.pm,
and BlockParse.pm. Most
class instances are instantiated from headerDoc2HTML.pl
based
on the results of a call to blockParse
.
The ParseTree
class is instantiated
in the block parser itself. It contains a token tree and a set of
operations on that tree (print the tree, return a text or html representation
of the tree, walk the parse tree for parameters, walk the parse
tree for embedded headerdoc markup, and so on).
The ParserState
class is also instantiated
in the block parser. It contains only three methods (new
, _initialize
,
and print
), and is primarily just a giant
hash with some pre-defined values.
The IncludeHash
class is essentially
just a simple data structure to handle basic information about #include
directives. It has two methods (new
and _initialize
).
The gatherHeaderDoc
tool uses an external
program, resolveLinks
, to convert special “link request”
comments into links to other files in the directory being processed.
This tool (written in C) resides in the bin
directory
within the HeaderDoc modules directory.
HeaderDoc uses xmllint
(from libxml)
to convert HTML into XHTML when generating XML output. HeaderDoc
also uses hdxml2manxml
and xml2man
from
the MPGL suite to generate man pages.
< Previous PageNext Page > |
© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-10-27)