Apache HTTP Server Version 2.1
+Apache HTTP Server Version 2.5
Documenting Apache 2.0
-Apache 2.0 uses Doxygen to - document the APIs and global variables in the the code. This will explain +Apache > HTTP Server > Documentation > Version 2.5 > Developer Documentation
Documenting code in Apache 2.4
+ + +Apache 2.4 uses Doxygen to + document the APIs and global variables in the code. This will explain the basics of how to document using Doxygen.
@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
@@ -45,25 +53,25 @@
/**
- * 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)
- */
+ * 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, always include:
/**
- * @package Name of library header
- */
+ * @package Name of library header
+ */
Doxygen uses a new HTML file for each package. The HTML files are named @@ -72,7 +80,31 @@
For a further discussion of the possibilities please refer to the Doxygen site.