Additional Notes

This section basically lists known limitations of HeaderDoc 8. We hope to improve in these areas in future versions. If you find issues not listed here, please file bugs.

• The man page output path is currently somewhat manual. To convert a header, etc. to a set of man pages, do something like the following:

  headerdoc2html [flags] -X filename.h hdxml2manxml filename/filename.xml xml2man filename/filename.xmml.mxml mv filename/*.1 /path/to/man/man1



• HeaderDoc 8 is somewhat slower than previous versions. This is because the entire parser has been rewritten from the ground up and now does a token-based parse of the input file.

  While this should significantly improve the correctness of output (colorizer bugs notwithstanding), it is doing a lot more work than before, and thus takes longer. We do still hope to improve other aspects of performance in future versions, however.



• HeaderDoc’s default color scheme matches XCode coloring. There are a number of files supplied as alternative color schemes, ranging from pleasant to utterly hideous and blinking (used mainly for testing). Swap out your headerDoc2HTML.config file as desired.


• GatherHeaderDoc’s default template is built-in. The format for this template is described in “Using GatherHeaderDoc”. Also see “Example gatherHeaderDoc Template” for an example of the template format.

© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)