chapter_1_section_3.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: Organization of this Document</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_1021" title="Organization of this Document" 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_2.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="../tags/chapter_2_section_1.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<br><h2>Organization of this Document</h2>
<p>This document is divided into several chapters describing
various aspects of the tool suite..</p>
<ul class="content_text"><li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CHDJFEGF" href="../tags/chapter_2_section_1.html#//apple_ref/doc/uid/TP40001215-CH346-CHDJFEGF">“HeaderDoc Tags”</a></span> explains how
to add HeaderDoc markup to header (and source code) files.</li><br>
<li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH337-CDEBBJJA" href="../usage/chapter_3_section_1.html#//apple_ref/doc/uid/TP40001215-CH337-CDEBBJJA">“Using HeaderDoc”</a></span> explains the
syntax for the HeaderDoc command-line tool itself.</li><br>
<li class="content_text"><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> explains
how to use gatherHeaderDoc to produce landing pages and cross-linked
trees of related documentation.</li><br>
<li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH357-CDEBBJJA" href="../mpgl/chapter_5_section_1.html#//apple_ref/doc/uid/TP40001215-CH357-CDEBBJJA">“Using the MPGL Suite”</a></span> exmplains
how to use the Manual Page Generation Language (MPGL) tool suite.</li><br>
<li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH348-CEGJFJIB" href="../config/chapter_6_section_1.html#//apple_ref/doc/uid/TP40001215-CH348-CEGJFJIB">“Configuring HeaderDoc”</a></span> explains
the HeaderDoc configuration file.</li><br>
<li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH347-BABJIFFD" href="../anchors/chapter_7_section_1.html#//apple_ref/doc/uid/TP40001215-CH347-BABJIFFD">“Symbol Markers for HTML-Based Documentation”</a></span> describes the
symbol markers used by HeaderDoc and various other utilities to
provide linking functionality.</li><br>
<li class="content_text"><span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH349-CHDGBFAJ" href="../classhierarchy/chapter_8_section_1.html#//apple_ref/doc/uid/TP40001215-CH349-CHDGBFAJ">“HeaderDoc Class Hierarchy”</a></span> describes
the class hierarchy of the HeaderDoc tool itself.</li><br></ul>
<p></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_2.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="../tags/chapter_2_section_1.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>