Apache HTTP Server 版本 2.4
Apache HTTP Server 版本 2.4
Apache 2.4 使用 Doxygen 来记录代码中的 API 和全局变量。这将解释如何使用 Doxygen 进行文档的基本知识。
要开始一个文档块，请使用 /**
要结束一个文档块，请使用 */
在块的中间，我们可以使用多个标签
此函数目的的描述
@param parameter_name 描述
@return 描述
@deffunc 函数签名
deffunc 不总是必要的。DoxyGen 没有完整的解析器，因此任何在返回类型声明中使用宏的原型对于 scandoc 来说都过于复杂。这些函数需要一个 deffunc。一个例子（使用 > 而不是 >）
/**
* 返回路径名的最后一个元素
* @param pathname 要获取最后一个元素的路径
* @return 路径的最后一个元素
* @tip 示例
* <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 库头文件名称
*/
Doxygen 为每个包使用一个新的 HTML 文件。HTML 文件名为 {Name_of_library_header}.html，因此请尽量简明您的名称。
有关更多可能性，请参阅 Doxygen 网站。