chapter_2_section_5.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: Tags for Frameworks</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-DontLinkElementID_1051" title="Tags for Frameworks" 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="../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_2_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_2_section_4.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_2_section_6.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<br><h2>Tags for Frameworks</h2>
<p>Framework documentation should be inserted into a file ending
in <code>.hdoc</code>. Running HeaderDoc on this file generates
a documentation tree with special hidden markup that gatherHeaderDoc
will insert into the appropriate place within your TOC template
(or at the top of the built-in template).</p>
<p></p><br><table border = "1" cellpadding = "3">
<tr>
<th scope="col"><div align="left"><b><p>Tag</p></b></div></th>
<th scope="col"><div align="left"><b><p> Example</p></b></div></th>
<th scope="col"><div align="left"><b><p>Identifies</p></b></div></th>
<th scope="col"><div align="left"><b><p>Fields </p></b></div></th>
</tr>
<tr>
<td class="content_text" scope="row"><p><tt>@framework</tt> </p></td>
<td class="content_text"><p><tt>@framework Kernel Framework</tt></p></td>
<td class="content_text"><p>The name of the framework.</p></td>
<td class="content_text"><p> 1 </p></td>
</tr>
<tr>
<td class="content_text" scope="row"><p><tt>@abstract</tt> </p></td>
<td class="content_text"><p><tt>@abstract In-kernel device driver
framework</tt></p></td>
<td class="content_text"><p>A short string that briefly describes a framework. This
should not contain multiple lines (at least for the default template)
for aesthetic reasons. Save the detailed descriptions for the <tt>@discussion</tt> tag.</p></td>
<td class="content_text"><p> 1 </p></td>
</tr>
<tr>
<td class="content_text" scope="row"><p><tt>@discussion</tt> </p></td>
<td class="content_text"><p><tt>@discussion The kernel framework
contains functions useful to in-kernel device drivers.</tt></p></td>
<td class="content_text"><p>A detailed description of the framework. This may contain
multiple paragraphs, and can contain HTML markup.</p></td>
<td class="content_text"><p> 1 </p></td>
</tr>
</table><br>
<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_2_section_4.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_2_section_6.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>