chapter_3_section_1.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: Using 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-CH337" title="Using HeaderDoc" turn_anchor="yes"></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="../intro/chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">HeaderDoc Unfettered</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="../tags/chapter_2_section_11.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_3_section_2.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<a name="//apple_ref/doc/uid/TP40001215-CH337-CDEBBJJA" turn_anchor="no"></a><a name="CDEBBJJA" turn_anchor="no"></a><h1 class="page_title">Using HeaderDoc</h1><p>HeaderDoc includes two scripts, <code>headerDoc2HTML.pl</code>,
which generates documentation for each header it encounters, and <code>gatherHeaderDoc.pl</code>,
which finds these islands of documentation and assembles a master
table of contents linking them together.</p>
<p>This chapter describes <code>headerDoc2HTML.pl</code>.
For information on <code>gatherHeaderDoc</code>, see <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>
<h4><b>Contents:</b></h4>
<blockquote class="content_text">
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1063" href="chapter_3_section_2.html#//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1063">Running headerDoc2HTML.pl</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1064" href="chapter_3_section_3.html#//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1064">Running the Scripts Using MacPerl</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1065" href="chapter_3_section_4.html#//apple_ref/doc/uid/TP40001215-CH337-DontLinkElementID_1065">Cocoa Front End</a>
<br>
</blockquote>
<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="../tags/chapter_2_section_11.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_3_section_2.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>