使用Doxygen记录预处理器选项

时间:2014-01-25 15:33:50

标签: c++ doxygen c-preprocessor

我有一个C ++包,如果用户定义了不同的预处理器常量,它允许不同的行为。例如,用户可以在makefile中使用/ D ALLOW_WIDE_CHAR来更改行为以支持宽字符。

我想用Doxygen记录这些选项,但Doxygen抱怨,因为代码中没有实际的#define。这取决于用户。

将配置添加到配置文件中的PREDEFINED列表没有帮助。

建议?

1 个答案:

答案 0 :(得分:2)

我找到的一个选项是创建一个额外的源文件,比如Doxygen.h,它没有编译,但被添加到Doxygen文件列表中。该文件可以使用#define来定义那些预处理器常量。不过,似乎应该有更好的解决方案。