granicus.if.org Git - apache/blob - docs/manual/developer/documenting.html.en

   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 code in Apache 2.4 - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page" class="no-sidebar"><div id="page-header">
  17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="../images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  21 <div id="path">
  22 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Documenting code in Apache 2.4</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  26 </div>
  27
  28     <p>Apache 2.4 uses <a href="http://www.doxygen.org/">Doxygen</a> to
  29     document the APIs and global variables in the code. This will explain
  30     the basics of how to document using Doxygen.</p>
  31 </div>
  32 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  33 <div class="section">
  34 <h2><a name="brief" id="brief">Brief Description</a></h2>
  35     <p>To start a documentation block, use <code>/**</code><br />
  36     To end a documentation block, use <code>*/</code></p>
  37
  38     <p>In the middle of the block, there are multiple tags we can
  39     use:</p>
  40
  41     <div class="example"><p><code>
  42       Description of this functions purpose<br />
  43       @param parameter_name description<br />
  44       @return description<br />
  45       @deffunc signature of the function<br />
  46     </code></p></div>
  47
  48     <p>The <code>deffunc</code> is not always necessary. DoxyGen does not
  49     have a full parser  in it, so any prototype that use a macro in the
  50     return type declaration is too complex for scandoc. Those functions
  51     require a <code>deffunc</code>. An example (using &amp;gt; rather
  52     than &gt;):</p>
  53
  54     <div class="example"><p><code>
  55       /**<br />
  56  &nbsp;* return the final element of the pathname<br />
  57  &nbsp;* @param pathname The path to get the final element of<br />
  58  &nbsp;* @return the final element of the path<br />
  59  &nbsp;* @tip Examples:<br />
  60  &nbsp;* &lt;pre&gt;<br />
  61  &nbsp;*                 "/foo/bar/gum"   -&amp;gt; "gum"<br />
  62  &nbsp;*                 "/foo/bar/gum/"  -&amp;gt; ""<br />
  63  &nbsp;*                 "gum"            -&amp;gt; "gum"<br />
  64  &nbsp;*                 "wi\\n32\\stuff" -&amp;gt; "stuff"<br />
  65  &nbsp;* &lt;/pre&gt;<br />
  66  &nbsp;* @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
  67  &nbsp;*/
  68     </code></p></div>
  69
  70     <p>At the top of the header file, always include:</p>
  71     <div class="example"><p><code>
  72       /**<br />
  73  &nbsp;* @package Name of library header<br />
  74  &nbsp;*/
  75     </code></p></div>
  76
  77     <p>Doxygen uses a new HTML file for each package. The HTML files are named
  78     {Name_of_library_header}.html, so try to be concise with your names.</p>
  79
  80     <p>For a further discussion of the possibilities please refer to
  81     <a href="http://www.doxygen.org/">the Doxygen site</a>.</p>
  82 </div></div>
  83 <div class="bottomlang">
  84 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English">&nbsp;en&nbsp;</a> |
  85 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  86 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
  87 <script type="text/javascript"><!--//--><![CDATA[//><!--
  88 var comments_shortname = 'httpd';
  89 var comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/documenting.html';
  90 (function(w, d) {
  91     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
  92         d.write('<div id="comments_thread"><\/div>');
  93         var s = d.createElement('script');
  94         s.type = 'text/javascript';
  95         s.async = true;
  96         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
  97         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
  98     }
  99     else {
 100         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 101     }
 102 })(window, document);
 103 //--><!]]></script></div><div id="footer">
 104 <p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 105 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 106 if (typeof(prettyPrint) !== 'undefined') {
 107     prettyPrint();
 108 }
 109 //--><!]]></script>
 110 </body></html>