chapter_4_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: Example gatherHeaderDoc Template</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-CH350-BABDFJGC" title="Example gatherHeaderDoc Template" 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/TP40001215-CH345" href="../intro/chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">HeaderDoc Unfettered</a> &gt; <a logicalPath="//apple_ref/doc/uid/TP40001215-CH350" href="chapter_4_section_1.html#//apple_ref/doc/uid/TP40001215-CH350">Using gatherHeaderDoc</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_4_section_4.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><a href="../mpgl/chapter_5_section_1.html" target="_self">Next Page &gt;</a></span>
        
        </td>
        </tr></table>
        
        <hr>
        
        <a name="BABDFJGC" title="Example gatherHeaderDoc Template" turn_anchor="no"></a><br><h2>Example gatherHeaderDoc Template</h2>
<p>The following is an example template for gatherHeaderDoc:</p>
<table><table cellpadding="8" width="100%" bgcolor="#F1F5F9" style="border: 1px solid #C9D1D7;"><tr><td scope="row"><table bgcolor="#F1F5F9" width="100%" border="0" cellspacing="0" cellpadding="0"><tr><td><pre><code>&lt;html&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;head&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;title&gt;API Reference: Device Drivers (Kernel/IOKit)&lt;/title&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;style type=&quot;text/css&quot;&gt;&lt;!--#pagehead {</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    FONT-WEIGHT: bold; FONT-SIZE: 32px; COLOR: #000000;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    FONT-FAMILY: lucida grande, geneva, helvetica, arial, sans-serif; }</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    td { font-size: 10px; } a:link {text-decoration: none;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    color: #0000ff;} a:visited {text-decoration: none;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    color: #0000ff;} a:visited:hover {text-decoration: underline;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    color: #ff6600;} a:active {text-decoration: none;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    color: #ff6600;} a:hover {text-decoration: underline;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    color: #ff6600;} h4 {text-decoration: none;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-size: tiny; font-weight: bold;} body {text-decoration: none;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-family: lucida grande, geneva, helvetica, arial, sans-serif;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    font-size: 10pt;} --&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;/style&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;/head&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> &lt;Meta name=&quot;ROBOTS&quot; content=&quot;NOINDEX&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code></code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;body bgcolor=&quot;#ffffff&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;center&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code></code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;!-- start of header --&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;!--#include virtual=&quot;/path/to/header.html&quot;--&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;!-- end of header --&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code></code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;0&quot; width=&quot;600&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code></code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr height=&quot;5&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td width=&quot;600&quot; height=&quot;5&quot;&gt;&lt;br&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td width=&quot;600&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>            &lt;div id=&quot;pagehead&quot;&gt;$$framework@@&lt;/div&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr height=&quot;10&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td width=&quot;600&quot; height=&quot;10&quot;&gt;&lt;br&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td valign=&quot;top&quot; width=&quot;600&quot;&gt;&lt;font face=&quot;Geneva,Helvetica,Arial&quot;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        size=&quot;2&quot;&gt;&lt;span id=&quot;bodytext&quot;&gt; $$frameworkdiscussion@@ &lt;/span&gt;&lt;/font&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr height=&quot;10&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td height=&quot;10&quot; width=&quot;600&quot;&gt;&lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr height=&quot;5&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td height=&quot;5&quot; width=&quot;600&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>            &lt;hr alt=&quot;&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>            &lt;br&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;td width=&quot;600&quot; align=&quot;center&quot; valign=&quot;top&quot;&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>            &lt;H2&gt;Headers&lt;/H2&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code></code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>                $$headerlist cols=3 order=down atts=border=&quot;0&quot;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>                cellpadding=&quot;1&quot; cellspacing=&quot;0&quot; width=&quot;420&quot;@@</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;H2&gt;Functions&lt;/H2&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>                $$functionlist cols=3 order=down atts=border=&quot;0&quot;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>                cellpadding=&quot;1&quot; cellspacing=&quot;0&quot; width=&quot;420&quot;@@</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>        &lt;/td&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>    &lt;/tr&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;/table&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;/center&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;/body&gt;</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>&lt;/html&gt;</code></pre></td><td><code><pre></pre></code></td></tr></table></td></tr></table></table>

        <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_4_section_4.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><a href="../mpgl/chapter_5_section_1.html" target="_self">Next Page &gt;</a></span>
        
        </td>
        </tr></table>

        <br><hr><p class="content_text"> <!--#if expr="0=1" -->&#169; 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>