chapter_1_section_2.html [plain text]
<html>
<head>
<META NAME="Generator" CONTENT="Gutenberg">
<META NAME="GeneratorVersion" CONTENT="v100.1">
<META http-equiv="content-type" CONTENT="text/html;charset=iso-8859-1">
<META NAME = "Copyright" CONTENT="Copyright 2004 Apple Computer, Inc. All Rights Reserved.">
<TITLE>Tools: HeaderDoc Unfettered: What is HeaderDoc?</TITLE>
<base target="content">
<LINK REL="stylesheet" TYPE="text/css" HREF="../Resources/CSS/frameset_styles.css">
<style type="text/css"></style>
<script language="JavaScript" src="../Resources/JavaScript/page.js"></script>
</head>
<BODY bgcolor="#ffffff" onload="initialize_page();"><a name="//apple_ref/doc/uid/TP40001215-CH345-DontLinkElementID_1020" title="What is HeaderDoc?" turn_anchor="no"></a>
<a name="top"></a>
<!-- start of header -->
<!--#include virtual="/includes/framesetheader" -->
<!-- end of header -->
<!-- start of path -->
<div class="breadcrumb"><a href="http://developer.apple.com/" target="_top">ADC Home</a> > <!--a logicalPath="//apple_ref/doc/uid/TP30000943" -->Reference Library<!--/a--> > <!--a logicalPath="//apple_ref/doc/uid/TP30000440" -->Documentation<!--/a--> > <!--a logicalPath="//apple_ref/doc/uid/TP30000436" -->Tools<!--/a--> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH345" href="chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">HeaderDoc Unfettered</a> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH345" href="chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">Introduction to HeaderDoc: API Documentation From Header Files</a> > </div><br>
<!-- end of path -->
<table width="100%" cellpadding=0 cellspacing=0 border=0 class="mini_nav_text"><tr>
<td align=left scope="row">
<!-- insert Show/Hide frames -->
<script type="text/javascript" language="JavaScript"><!--
if (self != top) {
document.write('<a href="'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="'+self.location+'" target="_top">Hide TOC</a>');
}
else {
document.write('<a href="../index.html?'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="../index.html?'+self.location+'" target="_top">Show TOC</a>');
}
<!-- end Show/Hide frames -->
</td><td align=right>
<a href="chapter_1_section_1.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_1_section_3.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<br><h2>What is HeaderDoc?</h2>
<p>HeaderDoc is a set of tools for embedding structured comments
in source code and header files written in various languages and
subsequently producing rich HTML and XML output from those comments.
HeaderDoc comments are similar in appearance to JavaDoc comments
in a Java source file, but traditional HeaderDoc comments provide
a slightly more formal tag set to allow greater control over HeaderDoc
behavior.</p>
<p>In addition to traditional HeaderDoc markup, HeaderDoc 8 supports
JavaDoc markup. HeaderDoc 8 also supports a number of languages:
Bourne shell (and Korn and Bourne Again), C Headers, C source code,
C shell, C++ headers, Java, JavaScript, Mach MIG definitions, Objective
C/C++ headers, Pascal, Perl, and PHP. Most of these languages (besides
C/C++/ObjC/Pascal) support documenting only functions or subroutines.</p>
<p>Also included with the main script (<tt>headerDoc2HTML</tt>)
is <tt>gatherHeaderDoc</tt>, a
utility script that creates a master table of contents for all documentation
generated by headerDoc2HTML. Information on running <tt>gatherHeaderDoc</tt> is
provided in <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH350-BABDEHCI" href="../gatherheaderdoc/chapter_4_section_1.html#//apple_ref/doc/uid/TP40001215-CH350-BABDEHCI">“Using gatherHeaderDoc”</a></span>.</p>
<p>Both scripts are typically installed in <code>/usr/bin</code>,
as <code>headerdoc2html</code> and <code>gatherheaderdoc</code>.</p>
<p>Finally, HeaderDoc comes with a series of tools for man page
generation, <code>xml2man</code> and <code>hdxml2manxml</code>.
The first tool , <code>xml2man</code>, converts an mdoc-like
XML dialect into mdoc-style man pages. The second tool, <code>hdxml2manxml</code>,
converts HeaderDoc XML (generated with the -X flag) into a series
of .mxml files suitable for use with <code>xml2man</code>.</p>
<br><br>
<table width="100%" cellpadding=0 cellspacing=0 border=0 class="mini_nav_text"><tr>
<td align=left scope="row">
<!-- insert Show/Hide frames -->
<script type="text/javascript" language="JavaScript"><!--
if (self != top) {
document.write('<a href="'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="'+self.location+'" target="_top">Hide TOC</a>');
}
else {
document.write('<a href="../index.html?'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="../index.html?'+self.location+'" target="_top">Show TOC</a>');
}
<!-- end Show/Hide frames -->
</td><td align=right>
<a href="chapter_1_section_1.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_1_section_3.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<br><hr><p class="content_text"> <!--#if expr="0=1" -->© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (<!--#endif -->Last updated: 2004-05-27<!--#if expr="0=1" -->)<!--#endif --></p>
<!-- start of footer -->
<!--#include virtual="/includes/framesetfooter" -->
<!-- end of footer -->
</BODY>
</html>