github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/developer/documenting.html.en (about) 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 Apache 2.0 - Apache HTTP Server Version 2.2</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" /><link href="http://httpd.apache.org/docs/current/developer/documenting.html" rel="canonical" /></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/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> 20 <p class="apache">Apache HTTP Server Version 2.2</p> 21 <img alt="" src="../images/feather.gif" /></div> 22 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 23 <div id="path"> 24 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div class="retired"><h4>Please note</h4> 25 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 26 <p>You may follow <a href="http://httpd.apache.org/docs/current/developer/documenting.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Documenting Apache 2.0</h1> 27 <div class="toplang"> 28 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a> | 29 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p> 30 </div> 31 32 <p>Apache 2.0 uses <a href="http://www.doxygen.org/">Doxygen</a> to 33 document the APIs and global variables in the code. This will explain 34 the basics of how to document using Doxygen.</p> 35 </div> 36 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 37 <div class="section"> 38 <h2><a name="brief" id="brief">Brief Description</a></h2> 39 <p>To start a documentation block, use <code>/**</code><br /> 40 To end a documentation block, use <code>*/</code></p> 41 42 <p>In the middle of the block, there are multiple tags we can 43 use:</p> 44 45 <div class="example"><p><code> 46 Description of this functions purpose<br /> 47 @param parameter_name description<br /> 48 @return description<br /> 49 @deffunc signature of the function<br /> 50 </code></p></div> 51 52 <p>The <code>deffunc</code> is not always necessary. DoxyGen does not 53 have a full parser in it, so any prototype that use a macro in the 54 return type declaration is too complex for scandoc. Those functions 55 require a <code>deffunc</code>. An example (using &gt; rather 56 than >):</p> 57 58 <div class="example"><p><code> 59 /**<br /> 60 * return the final element of the pathname<br /> 61 * @param pathname The path to get the final element of<br /> 62 * @return the final element of the path<br /> 63 * @tip Examples:<br /> 64 * <pre><br /> 65 * "/foo/bar/gum" -&gt; "gum"<br /> 66 * "/foo/bar/gum/" -&gt; ""<br /> 67 * "gum" -&gt; "gum"<br /> 68 * "wi\\n32\\stuff" -&gt; "stuff"<br /> 69 * </pre><br /> 70 * @deffunc const char * ap_filename_of_pathname(const char *pathname)<br /> 71 */ 72 </code></p></div> 73 74 <p>At the top of the header file, always include:</p> 75 <div class="example"><p><code> 76 /**<br /> 77 * @package Name of library header<br /> 78 */ 79 </code></p></div> 80 81 <p>Doxygen uses a new HTML file for each package. The HTML files are named 82 {Name_of_library_header}.html, so try to be concise with your names.</p> 83 84 <p>For a further discussion of the possibilities please refer to 85 <a href="http://www.doxygen.org/">the Doxygen site</a>.</p> 86 </div></div> 87 <div class="bottomlang"> 88 <p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a> | 89 <a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p> 90 </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&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> 91 <script type="text/javascript"><!--//--><![CDATA[//><!-- 92 var comments_shortname = 'httpd'; 93 var comments_identifier = 'http://httpd.apache.org/docs/2.2/developer/documenting.html'; 94 (function(w, d) { 95 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 96 d.write('<div id="comments_thread"><\/div>'); 97 var s = d.createElement('script'); 98 s.type = 'text/javascript'; 99 s.async = true; 100 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 101 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 102 } 103 else { 104 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 105 } 106 })(window, document); 107 //--><!]]></script></div><div id="footer"> 108 <p class="apache">Copyright 2017 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> 109 <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[//><!-- 110 if (typeof(prettyPrint) !== 'undefined') { 111 prettyPrint(); 112 } 113 //--><!]]></script> 114 </body></html>