HeaderDoc

HeaderDoc is documentation generator developed and maintained by the Apple Computer company. Using specially commented source code files as input, HeaderDoc generates documentation for the code in HTML or XML format. Syntax for HeaderDoc comment tags is largely similar to, and as of HeaderDoc version 8, supportive of Javadoc tags. Apple's HeaderDoc project is freely distributed under the Apple Public Source License.

Supported plain text languages

• Bash
• Bourne Shell
• C Shell
• C Programming Language
• C++
• Korn Shell
• Java programming language
• Javascript
• MACH MIG definitions [1]
• Objective C
• Pascal programming language
• Perl
• PHP

The HeaderDoc tool set consists of the main utility, headerdoc2html, and gatherheaderdoc. The headerdoc2html tool generates a directory of either HTML (or optionally XML) files from the commented source files specified. Afterwards, the gatherheaderdoc utility may be executed to create a table of contents file for the documentation.

Apple's Xcode development environment contains features designed to assist the process of creating documentation using the HeaderDoc syntax and tools.

See also

• List of documentation generators
• Comparison of documentation generators

External links

• HeaderDoc Project Page
• Documentation for HeaderDoc syntax and utilities