我正在尝试记录一个 C API,它全部包含在单个 C 头文件中。当我在文件上运行 doxygen 时,它给了我当前未记录的 C 宏的错误,但是当我为宏添加必要的文档时,尽管清除了未记录的错误,但宏和文档不会出现在 doxygen 生成的 html 输出中。
只有一小部分记录在案的头文件,即结构,实际上出现在任何 doxygen 输出中。我在配置设置或文档中看不到任何有助于澄清为什么 doxygen 没有将头文件中的记录代码放入其生成的输出中的任何内容。
有谁知道为什么会这样?
我正在尝试记录一个 C API,它全部包含在单个 C 头文件中。当我在文件上运行 doxygen 时,它给了我当前未记录的 C 宏的错误,但是当我为宏添加必要的文档时,尽管清除了未记录的错误,但宏和文档不会出现在 doxygen 生成的 html 输出中。
只有一小部分记录在案的头文件,即结构,实际上出现在任何 doxygen 输出中。我在配置设置或文档中看不到任何有助于澄清为什么 doxygen 没有将头文件中的记录代码放入其生成的输出中的任何内容。
有谁知道为什么会这样?
请参阅常见问题解答的第 2 项和第 3 项:http: //www.doxygen.org/manual/faq.html
简而言之,您可能缺少一个注释块@file
来记录您的头文件。