Doxygen基础篇(四)——增加宏定义

前言:
  c/c++这样带宏定义的编程语言经常会用到预编译宏,部分代码是由宏控制的可选代码,但要让Doxygen正确处理这些代码可能需要手动添加宏定义。

1 代码被Doxygen忽视

  预编译宏中的代码可能被Doxygen忽视,生成的文档中不含有这部分代码的说明。如果一段代码被预编译宏控制为可选代码,预编译宏在其他文件甚至编译器的配置中定义,那么Doxygen不能解析到该宏定义,导致不能生成这段代码的文档说明,解决办法需要手动在Doxygen中添加相关的宏定义。

2 添加宏定义

 &emps;打开Doxygen向导,找到关于预定义宏的设置项。 Expert -> Topics -> Preprocessor -> PREDEFINED 。在该项中添加需要的宏设置。

Doxygen基础篇(四)——增加宏定义

前言:
  c/c++这样带宏定义的编程语言经常会用到预编译宏,部分代码是由宏控制的可选代码,但要让Doxygen正确处理这些代码可能需要手动添加宏定义。

1 代码被Doxygen忽视

  预编译宏中的代码可能被Doxygen忽视,生成的文档中不含有这部分代码的说明。如果一段代码被预编译宏控制为可选代码,预编译宏在其他文件甚至编译器的配置中定义,那么Doxygen不能解析到该宏定义,导致不能生成这段代码的文档说明,解决办法需要手动在Doxygen中添加相关的宏定义。

2 添加宏定义

 &emps;打开Doxygen向导,找到关于预定义宏的设置项。 Expert -> Topics -> Preprocessor -> PREDEFINED 。在该项中添加需要的宏设置。

Preprocessor.png

  当定义的宏带值时,使用 = 进行赋值,但等号前后不能加空格,否则无法识别。例如: SWITCH=1

  当定义的宏带值时,使用 = 进行赋值,但等号前后不能加空格,否则无法识别。例如: SWITCH=1