chapter_10_section_4.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="New Tags">
        <TITLE>Tools: HeaderDoc User's Guide: New 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-CH201-BCIICEDJ" title="New Tags" 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> &gt; <!--a logicalPath="//apple_ref/doc/uid/TP30000943"  -->Reference Library<!--/a--> &gt; <!--a logicalPath="//apple_ref/doc/uid/TP30000440"  -->Documentation<!--/a--> &gt; <!--a logicalPath="//apple_ref/doc/uid/TP30000436"  -->Tools<!--/a--> &gt; <!--a logicalPath="//apple_ref/doc/uid/TP30000436-TP30000502"  -->Darwin<!--/a--> &gt; <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> &gt; <a logicalPath="//apple_ref/doc/uid/TP40001215-CH201" href="chapter_10_section_1.html#//apple_ref/doc/uid/TP40001215-CH201">HeaderDoc Release Notes</a> &gt; </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) {
            // loaded in frames
            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 {
            // not loaded frames
            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>');
        }
        //--></script>
        <!-- end Show/Hide frames -->

        </td><td align=right>
        
        <a href="chapter_10_section_3.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><a href="chapter_10_section_5.html" target="_self">Next Page &gt;</a></span>
        
        </td>
        </tr></table>
        
        <hr>
        
        <a name="BCIICEDJ" title="New Tags" turn_anchor="no"></a><h2>New Tags</h2>
<p>This section attempts to list all of the new tags added in
HeaderDoc 8 (some of which were actually available, but undocumented,
in HeaderDoc 7).</p>
<dl class="content_text"><br><dt class="content_text"><tt>@classdesign</tt></dt>
<dd class="content_text">Text block describing the overall design of a class</dd>
<br><dt class="content_text"><tt>@coclass</tt></dt>
<dd class="content_text">String describing a class that this class was designed
to work with</dd>
<br><dt class="content_text"><tt>@dependency</tt></dt>
<dd class="content_text">String describing a class upon which this class depends
heavily</dd>
<br><dt class="content_text"><tt>@exception</tt></dt>
<dd class="content_text">String describing an exception thrown by a function/method/class</dd>
<br><dt class="content_text"><tt>@functiongroup</tt></dt>
<dd class="content_text">Tag for grouping functions and methods; this takes priority
over the <tt>@group</tt> tag with
respect to functions and methods.</dd>
<br><dt class="content_text"><tt>@group</tt></dt>
<dd class="content_text">Tag for grouping data, functions, and so on, thus changing
the order in which they appear in the table of contents.<p>(Note:
the <tt>@functiongroup</tt> tag
takes priority over the <tt>@group</tt> tag
for functions.)</p></dd>
<br><dt class="content_text"><tt>@helper</tt></dt>
<dd class="content_text">String telling what helper classes this class uses</dd>
<br><dt class="content_text"><tt>@helps</tt></dt>
<dd class="content_text">For helper classes, string telling what sort of classes
this class was designed to help</dd>
<br><dt class="content_text"><tt>@instancesize</tt></dt>
<dd class="content_text">Text block containing the size of an instance of this
class</dd>
<br><dt class="content_text"><tt>@methodgroup</tt></dt>
<dd class="content_text">See <tt>@functiongroup</tt>.</dd>
<br><dt class="content_text"><tt>@ownership</tt></dt>
<dd class="content_text">String describing what class instantiates the current
class (for example, I/O Kit nubs)</dd>
<br><dt class="content_text"><tt>@performance</tt></dt>
<dd class="content_text">Text block to describe performance characteristics of
a class (for example, &#8220;This class is not appropriate for use in
high-performance environments&#8221;)</dd>
<br><dt class="content_text"><tt>@security</tt></dt>
<dd class="content_text">Text block to describe security considerations when
using this class</dd>
<br><dt class="content_text"><tt>@superclass</tt></dt>
<dd class="content_text">Adds superclass info to a C pseudoclass; also can be
used to cause members of the superclass to be merged into the subclass</dd>
<br><dt class="content_text"><tt>@throws</tt></dt>
<dd class="content_text">See <tt>@exception</tt>.</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) {
            // loaded in frames
            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 {
            // not loaded frames
            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>');
        }
        //--></script>
        <!-- end Show/Hide frames -->

        </td><td align=right>
        
        <a href="chapter_10_section_3.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><a href="chapter_10_section_5.html" target="_self">Next Page &gt;</a></span>
        
        </td>
        </tr></table>

        <br><hr><div align="center"><p class="content_text"> <!--#if expr="0=1" -->&#169; 1999, 2004 Apple Computer, Inc. All Rights Reserved. &#40;<!--#endif -->Last updated: 2004-10-27<!--#if expr="0=1" -->&#041;<!--#endif --></p></div>

        
        <!-- start of footer -->
        <!--#include virtual="/includes/framesetfooter" -->
        <!-- end of footer -->
    </BODY>
</html>