c++ - 由定义保护的文档功能？

Question

我正在尝试记录一个由 #define 保护的函数。默认情况下，定义是关闭的。

#ifdef ___FOO_BAR___
  void FooBar(void);
#endif

Doxygen 正在处理该文件。我根据 Doxygen 的 Documenting the code 添加了 \Fn 命令和 Documentation at other places 部分:

#ifdef ___FOO_BAR___
  //! \Fn void FooBar()
  //! \brief ...
  //! \details ...
  DECLSPEC void API FooBar();
#endif

但是，函数 FooBar 没有被记录。使用 \fn 没有区别。将文档移到宏 block 之外没有任何区别。

我如何指示 Doxygen 为该函数生成文档，即使它受到定义的保护(以及如果 off 定义)？

---

上面是 #if\#else\#endif 的一部分，所以我不能使用预处理器技巧。我想要记录两组功能。在 \details 中，我们解释了该功能仅在启用特定定义时可用。

---

$ doxygen -version
1.8.9.1

Answer 1

尝试使用 PREDEFINED 标签来控制您喜欢的行为。你可以查看here获取更多信息。

我为了看看从 doxygen 包含的预处理器中扩展了什么 try

doxygen -d Preprocessor