www/apache
1
0
Fork 0
mirror of https://github.com/apache/httpd.git synced 2025-08-01 07:26:57 +03:00
Code Activity

Move API.html over to manual/developer, begin some cleanup.

Browse Source 
Could a DoxyGen'er please update the guidlines in documenting.html?


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@91108 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
William A. Rowe Jr
2001-09-22 15:45:22 +00:00
parent c43a224483
commit f7c23a7e8b
5 changed files with 80 additions and 1214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/manual/developer/documenting.html Normal file
View File

@ -0,0 +1,64 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<title>Documenting Apache 2.0</title>
</head>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#000080"
ALINK="#FF0000"
>
<!--#include virtual="header.html" -->
<h1 align="center">Documentating Apache 2.0</h1>
<p>Apache 2.0 uses DoxyGen to document the API's and global variables in the
the code. This will explain the basics of how to document using DoxyGen.
<p>To start a documentation block, use /**<br />
To end a documentation block, use */</p>
<p>In the middle of the block, there are multiple tags we can use:</p>
<pre>
Description of this functions purpose
@param parameter_name description
</p>
<p>The deffunc 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 deffunc.</p>
<p>An example (using &&gt; rather than &gt;):</p>
<pre>
/**
* return the final element of the pathname
* @param pathname The path to get the final element of
* @return the final element of the path
* @tip Examples:
* &lt;pre&gt;
* "/foo/bar/gum" -&&gt; "gum"
* "/foo/bar/gum/" -&&gt; ""
* "gum" -&&gt; "gum"
* "wi\\n32\\stuff" -&&gt; "stuff"
* &lt;/pre&gt;
* @deffunc const char * ap_filename_of_pathname(const char *pathname)
*/
</pre>
<p>At the top of the header file, always include:</p>
<pre>
/**
* @package Name of library header
*/
</pre>
<p>ScanDoc 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>
<!--#include virtual="footer.html" -->
</body>
</html>