由定义保护的文档功能？

Question

我试图记录由#define保护的功能。默认情况下，定义处于关闭状态。

#ifdef ___FOO_BAR___
  void FooBar(void);
#endif

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

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

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

如何指示Doxygen为该函数生成文档，即使它由一个define（以及如果 off 定义）？

以上是#if \ #else \ #endif的一部分，因此我无法使用预处理器技巧。我希望记录这两组功能。在\details中，我们解释该函数仅在启用特定定义时可用。

$ doxygen -version
1.8.9.1

Answer 1

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

我想看看doxygen包含的预处理器尝试扩展了什么

doxygen -d Preprocessor