842ae4bd224140319ae7feec1872b93dfd491143fielding<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
842ae4bd224140319ae7feec1872b93dfd491143fielding<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
842ae4bd224140319ae7feec1872b93dfd491143fielding<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
842ae4bd224140319ae7feec1872b93dfd491143fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes This file is generated from xml source: DO NOT EDIT
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<title>Documenting code in Apache 2.4 - Apache HTTP Server Version 2.5</title>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<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" />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<script src="/style/scripts/prettify.min.js" type="text/javascript">
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<body id="manual-page" class="no-sidebar"><div id="page-header">
e8f95a682820a599fe41b22977010636be5c2717jim<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>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<p class="apache">Apache HTTP Server Version 2.5</p>
1747d30b98aa1bdbc43994c02cd46ab4cb9319e4fielding<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<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>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<p><span>Available Languages: </span><a href="/en/developer/documenting.html" title="English"> en </a> |
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<a href="/zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <p>Apache 2.4 uses <a href="http://www.doxygen.org/">Doxygen</a> to
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes document the APIs and global variables in the code. This will explain
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes the basics of how to document using Doxygen.</p>
5c0419d51818eb02045cf923a9fe456127a44c60wrowe<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<h2><a name="brief" id="brief">Brief Description</a></h2>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <p>To start a documentation block, use <code>/**</code><br />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes To end a documentation block, use <code>*/</code></p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <p>In the middle of the block, there are multiple tags we can
d266c3777146d36a4c23c17aad6f153aebea1bf4jorton Description of this functions purpose<br />
d266c3777146d36a4c23c17aad6f153aebea1bf4jorton @param parameter_name description<br />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes @return description<br />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes @deffunc signature of the function<br />
22f8da8087791fcb95b836c8a81937c5a9bba202bnicholes <p>The <code>deffunc</code> is not always necessary. DoxyGen does not
22f8da8087791fcb95b836c8a81937c5a9bba202bnicholes have a full parser in it, so any prototype that use a macro in the
22f8da8087791fcb95b836c8a81937c5a9bba202bnicholes return type declaration is too complex for scandoc. Those functions
22f8da8087791fcb95b836c8a81937c5a9bba202bnicholes require a <code>deffunc</code>. An example (using &gt; rather
22f8da8087791fcb95b836c8a81937c5a9bba202bnicholes than >):</p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes * return the final element of the pathname<br />
0568280364eb026393be492ebc732795c4934643jorton * @param pathname The path to get the final element of<br />
0568280364eb026393be492ebc732795c4934643jorton * @return the final element of the path<br />
0568280364eb026393be492ebc732795c4934643jorton * @tip Examples:<br />
0568280364eb026393be492ebc732795c4934643jorton * <pre><br />
0568280364eb026393be492ebc732795c4934643jorton * "gum" -&gt; "gum"<br />
0568280364eb026393be492ebc732795c4934643jorton * "wi\\n32\\stuff" -&gt; "stuff"<br />
0568280364eb026393be492ebc732795c4934643jorton * </pre><br />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes * @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <p>At the top of the header file, always include:</p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes * @package Name of library header<br />
796e4a7141265d8ed7036e4628161c6eafb2a789jorton <p>Doxygen uses a new HTML file for each package. The HTML files are named
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes {Name_of_library_header}.html, so try to be concise with your names.</p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <p>For a further discussion of the possibilities please refer to
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes <a href="http://www.doxygen.org/">the Doxygen site</a>.</p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<p><span>Available Languages: </span><a href="/en/developer/documenting.html" title="English"> en </a> |
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<a href="/zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes</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>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<script type="text/javascript"><!--//--><![CDATA[//><!--
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholesvar comments_shortname = 'httpd';
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholesvar comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/documenting.html';
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes(function(w, d) {
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes d.write('<div id="comments_thread"><\/div>');
8113dac419143273351446c3ad653f3fe5ba5cfdwrowe var s = d.createElement('script');
e8f95a682820a599fe41b22977010636be5c2717jim s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
482f676c6c19b1c5bb5cca04dad11509c1da3a4cwrowe (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes})(window, document);
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<p class="apache">Copyright 2015 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>
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholes<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[//><!--
d5b12fe8ae917e654a33247fd4e59dc9e75170aebnicholesif (typeof(prettyPrint) !== 'undefined') {
a1790fb35c4b352dab721370985c623a9f8f5062rpluem prettyPrint();