记录Doxygen中的命名
Documenting namepaces in Doxygen
我开始用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
的文档也具有额外的<
,这是因为///<
用于在完成项目后进行记录,在这种情况下,命名空间的定义尚未完成。
相关文章:
- 将两个数组中的差异记录在第三个数组中
- 使 \page 和 \subpage 参考 doxygen 中的方法文档
- 禁止在控制台上记录谷神星
- 创建 Spdlog 异步文件记录器时遇到困难
- fastrtps:如何在发布/订阅级别使用 DDS 历史记录?
- 使用 Doxygen 记录枚举类值,而不启用EXTRACT_ALL
- 记录Doxygen中的命名
- 如何让 doxygen 记录 .tcc 文件中定义的模板类?
- Doxygen 未记录的字符串值
- 如何使用doxygen记录应用程序源文件
- 我如何用doxygen记录一个富特枚举
- 使用 Doxygen 或类似方法记录枚举标志
- 如何在 Doxygen 中记录重载函数
- Doxygen 不显示如何从其他类调用记录的成员函数(包括构造函数)
- 如何使用 Doxygen 记录"enable_if"函数
- 如何让 Doxygen 记录在 C++ 文件中定义的类
- Doxygen:如何记录未 #defined 的宏
- Doxygen C++-没有在模板类中记录虚拟函数
- 使用 dOxygen 记录带有指定指针的 typedef'd 结构?
- 如何使用 Doxygen 记录C++函数中的局部变量