www/apache
1
0
Fork 0
mirror of https://github.com/apache/httpd.git synced 2025-08-07 04:02:58 +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

43
docs/manual/developer/documenting
View File

@@ -1,43 +0,0 @@
Apache 2.0 is using ScanDoc to document the API's and global variables in
the code. This will explain the basics of how to document using Scandoc.
To start a scandoc block, use /**
To end a scandoc block, use */
In the middle of the block, there are multiple tags we can use:
Description of this functions purpose
@param parameter_name description
@tip Any information the programmer should know
@deffunc function prototype.
The deffunc is not always necessary. ScanDoc 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.
An example:
/**
* 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:
* <PRE>
* "/foo/bar/gum" -> "gum"
* "/foo/bar/gum/" -> ""
* "gum" -> "gum"
* "wi\\n32\\stuff" -> "stuff"
* </PRE>
* @deffunc const char * ap_filename_of_pathname(const char *pathname)
*/
At the top of the header file, we always include
/**
* @package Name of library header
*/
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

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>

20
docs/manual/developer/index.html
View File

@@ -16,10 +16,22 @@
<h1 align="center">Developer Documentation for Apache-2.0</h1> <h1 align="center">Developer Documentation for Apache-2.0</h1>
<p><a href="hooks.html">Apache Hook Functions</a></p> <p>Many of the documents on these Developer pages are lifted from Apache 1.3's
<p><a href="modules.html">Converting Apache 1.3 Modules to Apache 2.0</a></p> documentation. While they are all being updated to Apache 2.0, they are
<p><a href="debugging.html">Debugging Memory Allocation in APR</a></p> in different stages of progress. Please be patient, and point out any
<p><a href="../misc/API.html">Apache 1.3 API Notes</a></p> discrepancies or errors on the developer/ pages directly to the
dev@httpd.apache.org mailing list.</p>
<h3>Topics</h3>
<dl>
<dt><a href="API.html">Apache 2.0 API Notes</a></dt>
<dd>Overview of Apache's Application Programming Interface.</dd>
<dt><a href="hooks.html">Apache Hook Functions</a></dt>
<dt><a href="modules.html">Porting Apache 1.3 Modules</a></dt>
<dt><a href="debugging.html">Debugging Memory Allocation</a></dt>
<dt><a href="documenting.html">Documenting Apache 2.0</a></dt>
</dl>
<!--#include virtual="footer.html" --> <!--#include virtual="footer.html" -->
</body> </body>
</html> </html>

1161
docs/manual/misc/API.html
View File

File diff suppressed because it is too large Load Diff

6
docs/manual/misc/index.html
View File

@@ -20,12 +20,6 @@
Apache web server development project. Apache web server development project.
</P> </P>
<DL> <DL>
<DT><A
HREF="API.html"
>API</A>
</DT>
<DD>Description of Apache's Application Programming Interface.
</DD>
<DT><A HREF="custom_errordocs.html">How to use XSSI and Negotiation <DT><A HREF="custom_errordocs.html">How to use XSSI and Negotiation
for custom ErrorDocuments</A> for custom ErrorDocuments</A>
</DT> </DT>