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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>Documenting code in Apache 2.4 - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body id="manual-page" class="no-sidebar"><div id="page-header">
  19 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
  20 <p class="apache">Apache HTTP Server Version 2.5</p>
  21 <img alt="" src="../images/feather.png" /></div>
  22 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  23 <div id="path">
  24 <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>
  25 <div class="toplang">
  26 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English">&nbsp;en&nbsp;</a> |
  27 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  28 </div>
  29
  30     <p>Apache 2.4 uses <a href="http://www.doxygen.org/">Doxygen</a> to
  31     document the APIs and global variables in the code. This will explain
  32     the basics of how to document using Doxygen.</p>
  33 </div>
  34 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  35 <div class="section">
  36 <h2><a name="brief" id="brief">Brief Description</a> <a title="Permanent link" href="#brief" class="permalink">&para;</a></h2>
  37     <p>To start a documentation block, use <code>/**</code><br />
  38     To end a documentation block, use <code>*/</code></p>
  39
  40     <p>In the middle of the block, there are multiple tags we can
  41     use:</p>
  42
  43     <div class="example"><p><code>
  44       Description of this functions purpose<br />
  45       @param parameter_name description<br />
  46       @return description<br />
  47       @deffunc signature of the function<br />
  48     </code></p></div>
  49
  50     <p>The <code>deffunc</code> is not always necessary. DoxyGen does not
  51     have a full parser  in it, so any prototype that use a macro in the
  52     return type declaration is too complex for scandoc. Those functions
  53     require a <code>deffunc</code>. An example (using &amp;gt; rather
  54     than &gt;):</p>
  55
  56     <div class="example"><p><code>
  57       /**<br />
  58  &nbsp;* return the final element of the pathname<br />
  59  &nbsp;* @param pathname The path to get the final element of<br />
  60  &nbsp;* @return the final element of the path<br />
  61  &nbsp;* @tip Examples:<br />
  62  &nbsp;* &lt;pre&gt;<br />
  63  &nbsp;*                 "/foo/bar/gum"   -&amp;gt; "gum"<br />
  64  &nbsp;*                 "/foo/bar/gum/"  -&amp;gt; ""<br />
  65  &nbsp;*                 "gum"            -&amp;gt; "gum"<br />
  66  &nbsp;*                 "wi\\n32\\stuff" -&amp;gt; "stuff"<br />
  67  &nbsp;* &lt;/pre&gt;<br />
  68  &nbsp;* @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
  69  &nbsp;*/
  70     </code></p></div>
  71
  72     <p>At the top of the header file, always include:</p>
  73     <div class="example"><p><code>
  74       /**<br />
  75  &nbsp;* @package Name of library header<br />
  76  &nbsp;*/
  77     </code></p></div>
  78
  79     <p>Doxygen uses a new HTML file for each package. The HTML files are named
  80     {Name_of_library_header}.html, so try to be concise with your names.</p>
  81
  82     <p>For a further discussion of the possibilities please refer to
  83     <a href="http://www.doxygen.org/">the Doxygen site</a>.</p>
  84 </div></div>
  85 <div class="bottomlang">
  86 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English">&nbsp;en&nbsp;</a> |
  87 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  88 </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>
  89 <script type="text/javascript"><!--//--><![CDATA[//><!--
  90 var comments_shortname = 'httpd';
  91 var comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/documenting.html';
  92 (function(w, d) {
  93     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
  94         d.write('<div id="comments_thread"><\/div>');
  95         var s = d.createElement('script');
  96         s.type = 'text/javascript';
  97         s.async = true;
  98         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
  99         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 100     }
 101     else {
 102         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 103     }
 104 })(window, document);
 105 //--><!]]></script></div><div id="footer">
 106 <p class="apache">Copyright 2019 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>
 107 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
 108 if (typeof(prettyPrint) !== 'undefined') {
 109     prettyPrint();
 110 }
 111 //--><!]]></script>
 112 </body></html>