记录Doxygen中的命名

Documenting namepaces in Doxygen

本文关键字:Doxygen 记录      更新时间:2023-10-16

我开始用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交换,也会发生这种情况

凸轮某人请解释我在哪里犯了错误??

"编译器标志"的问题确实是#include无法记录,注释(包括<(流入下一项的简要描述(即namespace NGE(。namespace NGE的文档也具有额外的<,这是因为///<用于在完成项目后进行记录,在这种情况下,命名空间的定义尚未完成。