Gecko [ v3.cesa.co.za ]

Name	Size	Permission	Date
API.html	63 KB	-rw-r--r--	2026-06-12 05:08
debugging.html	4.26 KB	-rw-r--r--	2026-06-12 05:08
documenting.html	6.71 KB	-rw-r--r--	2026-06-12 05:08
filters.html	14.41 KB	-rw-r--r--	2026-06-12 05:08
hooks.html	12.94 KB	-rw-r--r--	2026-06-12 05:08
index.html	7.15 KB	-rw-r--r--	2026-06-12 05:08
modguide.html	69.74 KB	-rw-r--r--	2026-06-12 05:08
modules.html	14.09 KB	-rw-r--r--	2026-06-12 05:08
new_api_2_4.html	28.11 KB	-rw-r--r--	2026-06-12 05:08
output-filters.html	29.75 KB	-rw-r--r--	2026-06-12 05:08
request.html	29.99 KB	-rw-r--r--	2026-06-12 05:08
thread_safety.html	17.17 KB	-rw-r--r--	2026-06-12 05:08

Rename

<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="width=device-width, initial-scale=1" name="viewport">

<title>Documenting code in Apache 2.4 - Apache HTTP Server Version 2.4</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.min.js">
</script>

<p>Apache 2.4 uses <a href="https://www.doxygen.nl/">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 id="brief">Brief Description <a title="Permanent link" href="#brief" class="permalink">&para;</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 &amp;gt; rather
    than &gt;):</p>

<div class="example"><p><code>
      /**<br>
 &nbsp;* return the final element of the pathname<br>
 &nbsp;* @param pathname The path to get the final element of<br>
 &nbsp;* @return the final element of the path<br>
 &nbsp;* @tip Examples:<br>
 &nbsp;* &lt;pre&gt;<br>
 &nbsp;*                 "/foo/bar/gum"   -&amp;gt; "gum"<br>
 &nbsp;*                 "/foo/bar/gum/"  -&amp;gt; ""<br>
 &nbsp;*                 "gum"            -&amp;gt; "gum"<br>
 &nbsp;*                 "wi\\n32\\stuff" -&amp;gt; "stuff"<br>
 &nbsp;* &lt;/pre&gt;<br>
 &nbsp;* @deffunc const char * ap_filename_of_pathname(const char *pathname)<br>
 &nbsp;*/
    </code></p></div>

<p>At the top of the header file, always include:</p>
    <div class="example"><p><code>
      /**<br>
 &nbsp;* @package Name of library header<br>
 &nbsp;*/
    </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="https://www.doxygen.nl/">the Doxygen site</a>.</p>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="../../en/developer/documenting.html" title="English">&nbsp;en&nbsp;</a> |
<a href="../../zh-cn/developer/documenting.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2026 The Apache Software Foundation.<br>Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="../mod/index.html">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="https://cwiki.apache.org/confluence/display/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a> | <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2">Report a bug</a></p></div><script><![CDATA[//><!]]></script>
</body></html>