文档没有出现在doxygen输出中

Question

我正在尝试记录一个C API，它全部包含在一个C头文件中。当我在文件上运行doxygen时，它给了我当前未记录的C宏的错误，但是当我为宏添加必要的文档时，虽然清除了未记录的错误，但是在doxygen生成的html输出中没有出现宏加文档。

只有一小部分记录的头文件（结构）实际出现在任何doxygen输出中。我在配置设置或文档中看不到任何有助于澄清为什么doxygen不会将头文件中的文档代码放入其生成的输出中的内容。

有人知道为什么会这样吗？

Answer 1

请参阅常见问题解答的第2项和第3项：http://www.doxygen.org/manual/faq.html

简而言之，您可能错过了一个带有@file的评论栏来记录您的头文件。