chapter_3_section_4.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>HeaderDoc Unfettered: Automatic Tagging</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-CH346-CIHDAAGB" title="Automatic Tagging" 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="Unknown" -->Technology TBD<!--/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> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH346" href="chapter_3_section_1.html#//apple_ref/doc/uid/TP40001215-CH346">HeaderDoc Tags</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_3_section_3.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_3_section_5.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<a name="CIHDAAGB" title="Automatic Tagging" turn_anchor="no"></a><br><h2>Automatic Tagging</h2>
<p>Beginning in HeaderDoc 8, certain tags are often not needed.
These include:</p>
<dl class="content_text"><br><dt class="content_text">Numbered
lists</dt>
<dd class="content_text">It is no longer necessary to mark up numbered lists
with <tt><ol><li></tt>.
HeaderDoc will automatically detect numbered lists.</dd>
<br><dt class="content_text">Declaration types</dt>
<dd class="content_text">Declaration type tags such as <b>@function</b>, <b>@class</b>,
and <b>@typedef</b> are no longer required unless you
are trying to override HeaderDoc’s normal behavior (such as using <b>@class</b> or <b>@interface</b> to
change the display of a <code>typedef struct</code>.</dd>
<br><dt class="content_text">Availability macros</dt>
<dd class="content_text">It is no longer necessary to ignore availability macros
with <b>@ignore</b>. The file <code>Availability.list</code> in
the HeaderDoc modules directory contains a mapping of availability
macros to strings. When any macros described in this file appear
in a declaration, the corresponding text will automatically be added
to its documentation as an availability attribute.<p>You can
add your own availability macros by adding them to the <code>Availability.list</code> file
or by adding an <b>@availabilitymacro</b> block in your headers.</p></dd></dl>
<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_3_section_3.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_3_section_5.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>