由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

最新更新