由define保护的文档功能
Document function guarded by a define?
我正试图记录一个由#define
保护的函数。默认情况下,define处于禁用状态。
#ifdef ___FOO_BAR___
void FooBar(void);
#endif
Doxygen正在处理该文件。我已经根据Doxygen的文档代码和其他地方的文档部分添加了Fn
命令:
#ifdef ___FOO_BAR___
//! Fn void FooBar()
//! brief ...
//! details ...
DECLSPEC void API FooBar();
#endif
但是,函数FooBar
没有被记录。使用fn
没有区别。将文档移到宏块之外也没有什么区别。
我如何指示Doxygen为该函数生成文档,即使它由define(以及define ifoff)保护?
以上是#if #else #endif
的一部分,所以我不能使用预处理器技巧。我想把这两套功能都记录下来。在details
中,我们解释了该功能仅在启用特定定义时可用。
$ doxygen -version
1.8.9.1
尝试使用PREDEFINED标记来控制您喜欢的行为。你可以在这里查看更多信息。
我订购了看看从包含脱氧氧的预处理器扩展了什么,试试
doxygen -d Preprocessor
相关文章:
- 正在查找文档以获得PS4平台的C++中的设备信息
- 如何在文档文件夹中创建目录
- 当Microsoft文档仅包含 C# 示例时,如何查找 C++ 包含文件名
- 通过构造函数创建一些值并尝试添加到文档中使用 rapidjson 不起作用
- 关于类的 Python 文档 - 对C++的引用不正确
- C++/autoconf 等效于文档库要求.txt的要求是什么?
- mbed:使用 USB 文档库编译会导致错误
- C++ VISUAL STUDIO:GLFWwindow没有初始化,即使它是在文档中编写的并且以前工作过
- 使用 yaml-cpp 更新 YAML 文档的节点和值
- 在加载 MSHTML 文档之前从 MSHTML 文档中删除无效的 URL
- 如何在C++中表示JSON文档的递归对象结构?
- 如何查找 Redshift Maya API 文档?
- 如何使用值模板编写文档测试用例?
- 如何使用 Gradle DSL(领域特定语言)上的文档?
- ncurses 找不到任何关于cchar_t的文档
- 提取狮身人面像文档中的C++代码片段
- 关于 API 文档和设备操作 在助手-sdk-cpp 上
- Doxygen:为什么@name使以下所有功能都被视为文档
- 在C++头文件中的原型上复制的功能文档 -> Doxygen
- 由define保护的文档功能