mirror of
https://github.com/apache/httpd.git
synced 2025-05-31 12:21:16 +03:00
aeff28fc12
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1340707 13f79535-47bb-0310-9956-ffa450edef68
112 lines
6.4 KiB
XML
112 lines
6.4 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
This file is generated from xml source: DO NOT EDIT
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
-->
|
|
<title>Documenting code in Apache 2.4 - Apache HTTP Server</title>
|
|
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
|
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
|
<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" />
|
|
<script src="../style/scripts/prettify.js" type="text/javascript">
|
|
</script>
|
|
|
|
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
|
<body id="manual-page" class="no-sidebar"><div id="page-header">
|
|
<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>
|
|
<p class="apache">Apache HTTP Server Version 2.5</p>
|
|
<img alt="" src="../images/feather.gif" /></div>
|
|
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
|
<div id="path">
|
|
<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.5</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Documenting code in Apache 2.4</h1>
|
|
<div class="toplang">
|
|
<p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a> |
|
|
<a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
|
|
</div>
|
|
|
|
<p>Apache 2.4 uses <a href="http://www.doxygen.org/">Doxygen</a> to
|
|
document the APIs and global variables in the code. This will explain
|
|
the basics of how to document using Doxygen.</p>
|
|
</div>
|
|
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
|
<div class="section">
|
|
<h2><a name="brief" id="brief">Brief Description</a></h2>
|
|
<p>To start a documentation block, use <code>/**</code><br />
|
|
To end a documentation block, use <code>*/</code></p>
|
|
|
|
<p>In the middle of the block, there are multiple tags we can
|
|
use:</p>
|
|
|
|
<div class="example"><p><code>
|
|
Description of this functions purpose<br />
|
|
@param parameter_name description<br />
|
|
@return description<br />
|
|
@deffunc signature of the function<br />
|
|
</code></p></div>
|
|
|
|
<p>The <code>deffunc</code> is not always necessary. DoxyGen does not
|
|
have a full parser in it, so any prototype that use a macro in the
|
|
return type declaration is too complex for scandoc. Those functions
|
|
require a <code>deffunc</code>. An example (using &gt; rather
|
|
than >):</p>
|
|
|
|
<div class="example"><p><code>
|
|
/**<br />
|
|
* return the final element of the pathname<br />
|
|
* @param pathname The path to get the final element of<br />
|
|
* @return the final element of the path<br />
|
|
* @tip Examples:<br />
|
|
* <pre><br />
|
|
* "/foo/bar/gum" -&gt; "gum"<br />
|
|
* "/foo/bar/gum/" -&gt; ""<br />
|
|
* "gum" -&gt; "gum"<br />
|
|
* "wi\\n32\\stuff" -&gt; "stuff"<br />
|
|
* </pre><br />
|
|
* @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
|
|
*/
|
|
</code></p></div>
|
|
|
|
<p>At the top of the header file, always include:</p>
|
|
<div class="example"><p><code>
|
|
/**<br />
|
|
* @package Name of library header<br />
|
|
*/
|
|
</code></p></div>
|
|
|
|
<p>Doxygen uses a new HTML file for each package. The HTML files are named
|
|
{Name_of_library_header}.html, so try to be concise with your names.</p>
|
|
|
|
<p>For a further discussion of the possibilities please refer to
|
|
<a href="http://www.doxygen.org/">the Doxygen site</a>.</p>
|
|
</div></div>
|
|
<div class="bottomlang">
|
|
<p><span>Available Languages: </span><a href="../en/developer/documenting.html" title="English"> en </a> |
|
|
<a href="../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
|
|
</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>This section is experimental!</strong><br />Comments placed here should not be expected
|
|
to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
|
|
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
|
var disqus_shortname = 'httpd';
|
|
var disqus_identifier = 'http://httpd.apache.org/docs/2.4/developer/documenting.html.en';
|
|
(function(w, d) {
|
|
var disabled = true;
|
|
if (w.location.hostname.toLowerCase() == "httpd.apache.org" && disabled !== true) {
|
|
d.write('<div id="disqus_thread"><\/div>');
|
|
var s = d.createElement('script');
|
|
s.type = 'text/javascript';
|
|
s.async = true;
|
|
s.src = 'http' + '://' + disqus_shortname + '.disqus.com/embed.js';
|
|
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
|
}
|
|
else {
|
|
d.write('<div id="disqus_thread">Comments are disabled for this page at the moment.<\/div>');
|
|
}
|
|
})(window, document);
|
|
//--><!]]></script></div><div id="footer">
|
|
<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>
|
|
<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[//><!--
|
|
if (typeof(prettyPrint) !== 'undefined') {
|
|
prettyPrint();
|
|
}
|
|
//--><!]]></script>
|
|
</body></html> |