chapter_8_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>HeaderDoc Unfettered: Additional Notes</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="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="Unknown"  -->Technology TBD<!--/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-CH201" href="chapter_8_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_8_section_4.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><!-- Next button --></span>
        
        </td>
        </tr></table>
        
        <hr>
        
        <br><h2>Additional Notes</h2>
<p>This section basically lists known limitations of HeaderDoc
8. We hope to improve in these areas in future versions. If you
find issues not listed here, please file bugs.</p>
<ul class="content_text"><li class="content_text">The man page
output path is currently somewhat manual. To convert a header, etc.
to a set of man pages, do something like the following:<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>headerdoc2html [flags] -X filename.h</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>hdxml2manxml filename/filename.xml</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>xml2man filename/filename.xmml.mxml</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code>mv filename/*.1 /path/to/man/man1</code></pre></td><td><code><pre></pre></code></td></tr></table></td></tr></table></table></li><br>
<li class="content_text">HeaderDoc 8 is somewhat slower than previous versions. This
is because the entire parser has been rewritten from the ground
up and now does a token-based parse of the input file.<p>While
this should significantly improve the correctness of output (colorizer
bugs notwithstanding), it is doing a lot more work than before,
and thus takes longer. We do still hope to improve other aspects
of performance in future versions, however.</p></li><br>
<li class="content_text">HeaderDoc&#8217;s default color scheme matches XCode coloring.
There are a number of files supplied as alternative color schemes,
ranging from pleasant to utterly hideous and blinking (used mainly
for testing). Swap out your headerDoc2HTML.config file as desired.</li><br>
<li class="content_text">GatherHeaderDoc&#8217;s default template is built-in. The format
for this template is described in <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH350-BABDEHCI" href="../gatherheaderdoc/chapter_7_section_1.html#//apple_ref/doc/uid/TP40001215-CH350-BABDEHCI">&#8220;Using GatherHeaderDoc&#8221;</a></span>.
Also see <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH350-BABDFJGC" href="../gatherheaderdoc/chapter_7_section_4.html#//apple_ref/doc/uid/TP40001215-CH350-BABDFJGC">&#8220;Example gatherHeaderDoc Template&#8221;</a></span> for an example of the template format.</li><br></ul>

        <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_8_section_4.html" target="_self">&lt; Previous Page</a><span style="margin-left: 8px"><!-- Next button --></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>