chapter_2_section_1.html [plain text]
<html>
<head>
<META NAME="Generator" CONTENT="Gutenberg">
<META NAME="GeneratorVersion" CONTENT="v103.5
">
<META http-equiv="content-type" CONTENT="text/html;charset=iso-8859-1">
<META NAME = "Copyright" CONTENT="Copyright 2004 Apple Computer, Inc. All Rights Reserved.">
<META NAME="IndexTitle" CONTENT="HeaderDoc Tags">
<TITLE>Tools: HeaderDoc User's Guide: HeaderDoc Tags</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" title="HeaderDoc Tags" 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/TP30000436-TP30000502" -->Darwin<!--/a--> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH345" href="../intro/chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">HeaderDoc User's Guide</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="../intro/chapter_1_section_4.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_2_section_2.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<a name="//apple_ref/doc/uid/TP40001215-CH346-CHDJFEGF" turn_anchor="no"></a><a name="CHDJFEGF" turn_anchor="no"></a><span class="page_title">HeaderDoc Tags</span><p>Tags, depending on type, generally require
either one field of information or two:</p>
<ul class="ul"><li class="li"><p><tt>@function</tt> [FunctionName]</p></li>
<li class="li"><p><tt> @param</tt> [parameterName]
[Some descriptive text...]</p></li></ul>
<p>In the tables below, the “Fields” column indicates the
number of textual fields each type of tag takes.</p>
<h4>Contents:</h4>
<blockquote class="content_text">
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_18" href="chapter_2_section_2.html#//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_18">Introduction to HeaderDoc Comments and Tags</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CIHDBHDC" href="chapter_2_section_3.html#//apple_ref/doc/uid/TP40001215-CH346-CIHDBHDC">Multiword Names</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CIHDAAGB" href="chapter_2_section_4.html#//apple_ref/doc/uid/TP40001215-CH346-CIHDAAGB">Automatic Tagging</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_20" href="chapter_2_section_5.html#//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_20">Tags for Frameworks</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_21" href="chapter_2_section_6.html#//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_21">Tags for All Headers</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CIHGEIDH" href="chapter_2_section_7.html#//apple_ref/doc/uid/TP40001215-CH346-CIHGEIDH">Tags Common to All API Types</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CIHCEBGD" href="chapter_2_section_8.html#//apple_ref/doc/uid/TP40001215-CH346-CIHCEBGD">Tags for All Languages</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-CIHDCIGC" href="chapter_2_section_9.html#//apple_ref/doc/uid/TP40001215-CH346-CIHDCIGC">C Pseudoclass Tags</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_33" href="chapter_2_section_10.html#//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_33">Tags for C++ Headers</a>
<br>
<a logicalPath="//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_35" href="chapter_2_section_11.html#//apple_ref/doc/uid/TP40001215-CH346-DontLinkElementID_35">Tags for Objective-C Headers</a>
<br>
</blockquote><br>
<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="../intro/chapter_1_section_4.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_2_section_2.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<br><hr><div align="center"><p class="content_text"> <!--#if expr="0=1" -->© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (<!--#endif -->Last updated: 2004-10-27<!--#if expr="0=1" -->)<!--#endif --></p></div>
<!-- start of footer -->
<!--#include virtual="/includes/framesetfooter" -->
<!-- end of footer -->
</BODY>
</html>