HeaderDoc
From Wikipedia, the free encyclopedia
| HeaderDoc | |
|---|---|
| Developer | Apple Inc. |
| Initial release | September 13, 2000 |
| Stable release | 8.9
/ June 8, 2009 |
| Written in | Perl, C (helpers) |
| Operating system | Mac OS X, UNIX, Linux |
| Type | Documentation generator |
| License | Apple Public Source License 2.0 |
| Website | developer |
HeaderDoc is a documentation generator developed and maintained by Apple Inc. 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. HeaderDoc 8.7 and later also provides partial support for many Doxygen tags (@ form only, and must conform to HeaderDoc tag ordering rules). Apple's HeaderDoc project is free, open source software distributed under the Apple Public Source License.
- AppleScript
- Bash
- Bourne Shell
- C Shell
- C
- C++
- Korn Shell
- Java
- JavaScript
- Mach MIG definitions
- Objective-C
- Pascal
- Perl
- PHP
- Python
- Ruby
- Tcl
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. Finally, the resolveLinks utility may be used to resolve cross-references between multiple documentation collections.
Apple's Xcode development environment contains features designed to assist the process of creating documentation using the HeaderDoc syntax and tools.
