logo标签列表

文档未出现在Doxygen输出中

doxygen
7
我正在尝试记录一个包含在单个C头文件中的C API。当我运行doxygen时，它会给我一些未记录的C宏的错误信息，但是当我添加了必要的宏文档后，虽然未记录的错误已经消除，但是生成的doxygen html输出中没有出现这些带有文档的宏。
只有少部分已记录的头文件结构实际上出现在任何doxygen输出中。我无法在配置设置或文档中找到任何可以帮助澄清为什么doxygen不将头文件中的记录代码放入其生成的输出中的信息。
是否有人知道这是为什么？
2个回答
4
@file注释在文件中，FAQ中的解决方案对我没有影响。它们以基于类的方式编写，涉及命名空间，但由于我是一个纯C头文件，这可能解释了为什么FAQ解决方案不能帮助我。 - jwhitmore
2
@file应该可以工作，所以请提供一个自包含的示例（可以在这里或doxygen的错误跟踪器中）以便我自己重现问题。 - doxygen
糟糕！@file文档中包含了更多内容，但我真正缺失的是API函数。不幸的是，在头文件中，API函数被声明为指向C函数的指针。我正在使用"\fn"记录它们，但这些并没有显示出来。 - jwhitmore
0
在我的情况下，我试图将我的XML文件提供给氧气。它不能处理XML作为输入。你需要提供实际的源文件。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接