c++ - 在 Doxygen 中记录命名空间

Question

我开始用 doxygen 记录我的所有代码。我对文件文档没有问题，但是在为多个文件生成文档时遇到了一个小问题。

例如：

在一些头文件中（我只使用 C/C++ 代码项目）我有以下代码：

#include "../config/compiler.h"  ///< Compiler flags

namespace nge                    ///< NGE namespace
{
... some code...
}

运行 doxywizard 后，如果我查找命名空间的文档，我将看到 NGE 命名空间，但不会得到：

NGE | NGE namespace

我明白了

NGE | Compiler flags

即使我/// NGE namespace与/// @namespace NGE namespace

凸轮有人请解释我在哪里犯了错误？

score 3 · Accepted Answer

“编译器标志”的问题确实是#include无法记录的，并且注释（包括<）流入下一项的简要描述（即namespace NGE）。的文档namespace NGE也有额外<的事实是由于///<在一个完整的项目之后用于记录的事实，在这种情况下，命名空间的定义还没有完成。

1 回答 1