c++ - 氧气警告 : ignoring unknown tag

标签 c++ c++11 documentation doxygen documentation-generation

使用 Doxygen 生成文档。收到“警告:忽略未知标记”错误,我不明白为什么。

最小的、完整的和可验证的示例:

/** This is a test */
#include <iostream>

/** \fn foo */
int foo() {
    return 0;
}

int main() {   
    std::cout << "hello world" << std::endl;
    return 0;
}

错误:

[53]: doxygen .\myTest.cpp
Warning: ignoring unknown tag `This' at line 1, file .\myTest.cpp
Warning: ignoring unknown tag `is' at line 1, file .\myTest.cpp
Warning: ignoring unknown tag `a' at line 1, file .\myTest.cpp
Warning: ignoring unknown tag `test' at line 1, file .\myTest.cpp
Warning: ignoring unknown tag `fn' at line 4, file .\myTest.cpp
Warning: ignoring unknown tag `foo' at line 4, file .\myTest.cpp
Warning: ignoring unknown tag `int' at line 5, file .\myTest.cpp
Warning: ignoring unknown tag `foo' at line 5, file .\myTest.cpp
Warning: ignoring unknown tag `return' at line 6, file .\myTest.cpp
Warning: ignoring unknown tag `0' at line 6, file .\myTest.cpp
Warning: ignoring unknown tag `int' at line 9, file .\myTest.cpp
Warning: ignoring unknown tag `main' at line 9, file .\myTest.cpp
Warning: ignoring unknown tag `std' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `cout' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `hello' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `world' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `std' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `endl' at line 10, file .\myTest.cpp
Warning: ignoring unknown tag `return' at line 11, file .\myTest.cpp
Warning: ignoring unknown tag `0' at line 11, file .\myTest.cpp
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for files to exclude
Searching for files to process...
...other stuff...

谢谢,真诚的,基思 :^)

最佳答案

您将文件传递给 doxygen,就好像它是配置文件,而不是 cpp。这就是为什么它会在每个单词上给您一个错误。

To generate the documentation you can now enter:

doxygen <config-file>

参见 http://www.doxygen.nl/manual/starting.html#step2

相反,在您的源旁边生成一个配置文件:

doxygen -g myconfig.conf

然后运行doxygen:

doxygen myconfig.conf

由于默认为 INPUT =,这将默认从当前目录中的文件构建文档.

关于c++ - 氧气警告 : ignoring unknown tag,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/45743805/

相关文章:

java - 如何记录第 3 方库的修改?

c# - 如何设置 monodoc 以与 transifex.com 一起使用?

c++ - 在 C++ 中使公共(public)数据成员不可访问

c++0x std::function 作为方法参数

c++ - 无法使用在同一类中使用成员函数的线程进行编译

c# - C# 摘要注释中的 XML 字符串

c++ - 编译时计算头文件中的常量

c++ - Flex token 不适用于 char* 哈希表

c++ - 我可以将多个线程分配给 OpenMP 中的一个代码段吗?

c++ - 在 Qt 框架中控制多个 UI 文件