home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 November / PCWorld_2003-11_cd.bin / Komunik / apache / apache_2.0.47-win32-x86-no_ssl.msi / Data.Cab / F250713_documenting.html.en < prev    next >
Extensible Markup Language  |  2003-05-29  |  5KB  |  84 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>Documenting Apache 2.0 - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page" class="no-sidebar"><div id="page-header">
  14. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Documenting Apache 2.0</h1>
  20. <div class="toplang">
  21. <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a></p>
  22. </div>
  23.  
  24.     <p>Apache 2.0 uses <a href="http://www.doxygen.org/">Doxygen</a> to
  25.     document the APIs and global variables in the the code. This will explain
  26.     the basics of how to document using Doxygen.</p>
  27. </div>
  28. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  29. <div class="section">
  30. <h2><a name="brief" id="brief">Brief Description</a></h2>
  31.     <p>To start a documentation block, use <code>/**</code><br />
  32.     To end a documentation block, use <code>*/</code></p>
  33.  
  34.     <p>In the middle of the block, there are multiple tags we can
  35.     use:</p>
  36.  
  37.     <div class="example"><p><code>
  38.       Description of this functions purpose<br />
  39.       @param parameter_name description<br />
  40.       @return description<br />
  41.       @deffunc signature of the function<br />
  42.     </code></p></div>
  43.       
  44.     <p>The <code>deffunc</code> is not always necessary. DoxyGen does not
  45.     have a full parser  in it, so any prototype that use a macro in the
  46.     return type declaration is too complex for scandoc. Those functions
  47.     require a <code>deffunc</code>. An example (using &gt; rather
  48.     than >):</p>
  49.  
  50.     <div class="example"><p><code>
  51.       /**<br />
  52.   * return the final element of the pathname<br />
  53.   * @param pathname The path to get the final element of<br />
  54.   * @return the final element of the path<br />
  55.   * @tip Examples:<br />
  56.   * <pre><br />
  57.   *                 "/foo/bar/gum"   -&gt; "gum"<br />
  58.   *                 "/foo/bar/gum/"  -&gt; ""<br />
  59.   *                 "gum"            -&gt; "gum"<br />
  60.   *                 "wi\\n32\\stuff" -&gt; "stuff"<br />
  61.   * </pre><br />
  62.   * @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
  63.   */
  64.     </code></p></div>
  65.  
  66.     <p>At the top of the header file, always include:</p>
  67.     <div class="example"><p><code>
  68.       /**<br />
  69.   * @package Name of library header<br />
  70.   */
  71.     </code></p></div>
  72.  
  73.     <p>Doxygen uses a new HTML file for each package. The HTML files are named
  74.     {Name_of_library_header}.html, so try to be concise with your names.</p>
  75.  
  76.     <p>For a further discussion of the possibilities please refer to
  77.     <a href="http://www.doxygen.org/">the Doxygen site</a>.</p>
  78. </div></div>
  79. <div class="bottomlang">
  80. <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a></p>
  81. </div><div id="footer">
  82. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  83. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  84. </body></html>