Menu
Home
People
Places
Arts
History
Plants & Animals
Science
Life & Culture
Technology
Reference.org
HeaderDoc
open-in-new
<h2 id="supported-plain-text-languages">Supported plain text languages</h2> <ul><li><a href="/facts/AppleScript/cc3rc4wD">AppleScript</a></li> <li><a href="/facts/Bash_(Unix_shell)/RrYLtEJT">Bash</a></li> <li><a href="/facts/Bourne_Shell/wUCh3Qkl">Bourne Shell</a></li> <li><a href="/facts/C_Shell/8XRuIg0K">C Shell</a></li> <li><a href="/facts/C_Programming_Language/e9JD2RRK">C</a></li> <li><a href="/facts/C%252B%252B/Et0F2qn9">C++</a></li> <li><a href="/facts/Korn_Shell/MMp8fQ4A">Korn Shell</a></li> <li><a href="/facts/Java_(programming_language)/9ScgFyAL">Java</a></li> <li><a href="/facts/JavaScript/XhhIIEsl">JavaScript</a></li> <li><a href="/facts/Mach_(kernel)/rqK8DES2">Mach</a> MIG definitions <a href="https://developer.apple.com/mac/library/documentation/Darwin/Conceptual/KernelProgramming/boundaries/boundaries.html#//apple_ref/doc/uid/TP30000905-CH217-BEHJDFCA">[1]</a></li> <li><a href="/facts/Objective-C/5mM557BW">Objective-C</a></li> <li><a href="/facts/Pascal_programming_language/b3yvp8bF">Pascal</a></li> <li><a href="/facts/Perl/fx31kjlT">Perl</a></li> <li><a href="/facts/PHP/vU6YRJX0">PHP</a></li> <li><a href="/facts/Python_(programming_language)/YbuGqofa">Python</a></li> <li><a href="/facts/Ruby_(programming_language)/BeYSaPSR">Ruby</a></li> <li><a href="/facts/Tcl/s7fbKYtR">Tcl</a></li></ul> <p>The HeaderDoc tool set consists of the main utility, headerdoc2html, and gatherheaderdoc. The headerdoc2html tool generates a directory of either <a href="/facts/HTML/sSc3fT78">HTML</a> (or optionally <a href="/facts/XML/clNgUfWk">XML</a>) files from the commented source files specified. Afterwards, the gatherheaderdoc utility may be executed to create a <a href="/facts/Table_of_contents/g9uVzwlq">table of contents</a> file for the documentation. Finally, the resolveLinks utility may be used to resolve cross-references between multiple documentation collections. </p><p>Apple's <a href="/facts/Xcode/glURdIVT">Xcode</a> development environment contains features designed to assist the process of creating documentation using the HeaderDoc syntax and tools. </p> <h2 id="additional-features">Additional features</h2> <p>HeaderDoc has the following core features: </p> <ul><li>C preprocessing, allowing user-selected #define macros to alter the content, and allowing the user to pass command-line flags to ignore portions of the input.</li> <li>Syntax coloring with user-defined styles.</li> <li>Template-driven landing pages for indices.</li> <li>Cross-platform (written mostly in Perl).</li></ul> <p>The HeaderDoc suite also includes several tools that may be used independently: </p> <ul><li>MPGL—a set of tools designed to simplify creation of UNIX manual pages using a lightweight XML syntax consisting of a subset of XHTML plus section tags, parameter tags, etc. HeaderDoc also provides a bridging tool that helps generate manual pages from header comments for functions via HeaderDoc's XML output mode.</li> <li>resolveLinks—a tool that allows for rapid web site relinking when content moves to a different address through the use of embedded anchors and link requests.</li> <li>filtermacros.pl—a tool that can be used to filter out sections of headers based on C preprocessor macros. This is currently available only by downloading the source tarball. As of HeaderDoc 8.9, this functionality is built into the headerdoc2html tool itself.</li></ul> <h2 id="see-also">See also</h2> <ul> <li>Free and open-source software portal</li></ul> <ul><li><a href="/facts/Comparison_of_documentation_generators/xLydRU5z">Comparison of documentation generators</a></li> <li>Standard interface documentation</li></ul> <h2 id="external-links">External links</h2> <ul><li><a href="https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html">Legacy Documentation: HeaderDoc User Guide</a></li> <li><a href="http://opensource.apple.com">http://opensource.apple.com</a> Latest version] (currently 8.9.28)</li> <li><a href="http://lists.apple.com/mailman/listinfo/headerdoc-dev">HeaderDoc mailing list</a> (commonly used for getting help, patches, etc.)</li></ul>