From: André Malo Date: Sat, 5 Apr 2003 01:27:34 +0000 (+0000) Subject: new XML X-Git-Tag: pre_ajp_proxy~1913 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66ebad0a7cd09b04c04f3af7a1fe791f2a101a59;p=thirdparty%2Fapache%2Fhttpd.git new XML git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@99221 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/developer/documenting.html b/docs/manual/developer/documenting.html deleted file mode 100644 index 77199bcddc8..00000000000 --- a/docs/manual/developer/documenting.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Documenting Apache 2.0 - - - - - - -

Documentating Apache 2.0

- -

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.

- -

To start a documentation block, use /**
- To end a documentation block, use */

- -

In the middle of the block, there are multiple tags we can - use:

-
-    Description of this functions purpose
-    @param parameter_name description
-
-
-

-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.
-
-

-An example (using > rather than >):
-
-
-/**
- * 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"   -&gt; "gum"
- *                 "/foo/bar/gum/"  -&gt; ""
- *                 "gum"            -&gt; "gum"
- *                 "wi\\n32\\stuff" -&gt; "stuff"
- * </pre>
- * @deffunc const char * ap_filename_of_pathname(const char *pathname)
- */
-
-
-

-At the top of the header file, 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.
-
- - - - diff --git a/docs/manual/developer/documenting.html.en b/docs/manual/developer/documenting.html.en new file mode 100644 index 00000000000..5fef9988e4a --- /dev/null +++ b/docs/manual/developer/documenting.html.en @@ -0,0 +1,78 @@ + + + +Documenting Apache 2.0 - Apache HTTP Server + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+
+Apache > HTTP Server > Documentation > Version 2.1

Documenting Apache 2.0

+

Apache 2.0 uses Doxygen to + document the APIs and global variables in the the code. This will explain + the basics of how to document using Doxygen.

+
+
top
+
+

Brief Description

+

To start a documentation block, use /**
+ To end a documentation block, use */

+ +

In the middle of the block, there are multiple tags we can + use:

+ +

+ Description of this functions purpose
+ @param parameter_name description
+ @return description
+ @deffunc signature of the function
+

+ +

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. An example (using &gt; rather + than >):

+ +

+ /**
+  * 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" -&gt; "gum"
+  * "/foo/bar/gum/" -&gt; ""
+  * "gum" -&gt; "gum"
+  * "wi\\n32\\stuff" -&gt; "stuff"
+  * </pre>
+  * @deffunc const char * ap_filename_of_pathname(const char *pathname)
+  */ +

+ +

At the top of the header file, always include:

+

+ /**
+  * @package Name of library header
+  */ +

+ +

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.

+ +

For a further discussion of the possibilities please refer to + the Doxygen site.

+
+ + \ No newline at end of file diff --git a/docs/manual/developer/documenting.xml b/docs/manual/developer/documenting.xml new file mode 100644 index 00000000000..268ada8a8e2 --- /dev/null +++ b/docs/manual/developer/documenting.xml @@ -0,0 +1,66 @@ + + + + + + + +Documenting Apache 2.0 + + +

Apache 2.0 uses Doxygen to + document the APIs and global variables in the the code. This will explain + the basics of how to document using Doxygen.

+ + +
Brief Description +

To start a documentation block, use /**
+ To end a documentation block, use */

+ +

In the middle of the block, there are multiple tags we can + use:

+ + + Description of this functions purpose
+ @param parameter_name description
+ @return description
+ @deffunc signature of the function
+ + +

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. An example (using &gt; rather + than >):

+ + + /**
+  * 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" -&gt; "gum"
+  * "/foo/bar/gum/" -&gt; ""
+  * "gum" -&gt; "gum"
+  * "wi\\n32\\stuff" -&gt; "stuff"
+  * </pre>
+  * @deffunc const char * ap_filename_of_pathname(const char *pathname)
+  */ + + +

At the top of the header file, always include:

+ + /**
+  * @package Name of library header
+  */ + + +

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.

+ +

For a further discussion of the possibilities please refer to + the Doxygen site.

+
+ +