Apache HTTP 服务器版本 2.4
Apache HTTP 服务器版本 2.4
Apache 2.4使用Doxygen在代码中记录API和全局变量。这将解释如何使用Doxygen进行记录的基础知识。
若要开始文档块，请使用/**
要结束文档块，请使用*/
在块的中间，可以使用多个标签：
Description of this functions purpose
@param parameter_name description
@return description
@deffunc signature of the function
在deffunc并不总是必要的。DoxyGen中没有完整的解析器，因此，任何在返回类型声明中使用宏的原型对于scandoc来说都过于复杂。这些功能需要一个deffunc。一个示例（使用＆gt;而不是>）：
/**
* 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)
*/
在头文件的顶部，始终包括：
/**
* @package Name of library header
*/
Doxygen为每个程序包使用一个新的HTML文件。HTML文件的名称为{Name_of_library_header} .html，因此请尽量简洁。
有关可能性的进一步讨论，请参考 Doxygen网站。