Doxygen配置选项
Doxygen有两种方法修改配置，一种是直接在Doxywizard[1]中修改，另一种是先保存配置，再修改配置文件然后重新加载。
Doxywizard中可以在Expert标签页查看及修改详细的配置项。Expert标签页Topics区域展示配置项类别，右侧展示选中类别下的配置项，左下角显示选中配置项的介绍及默认值。许多配置项都可以通过名称判断出其作用。
配置项类别有：
-
项目相关配置项——Project -
构建相关配置项——Build -
构建警告和进度消息相关配置项——Messages -
输入文件相关配置项——Input -
源文件浏览相关配置项——Source Browser -
字母表顺序类索引相关配置项——Index -
输出相关配置项——HTML、LaTeX、RTF、Man、XML、Docbook、AutoGen、PerlMod -
预处理相关配置项——Preprocessor -
外部引用相关配置项——External -
Dot工具相关配置项——Dot
Project
下面是一些Project中常用的配置项及设置效果
-
DOXYFILE_ENCODING——配置文件编码，默认为”UTF-8″ -
PROJECT_NAME——项目名称，用作大多数生成页面的标题 -
PROJECT_NUMBER——项目版本 -
PROJECT_BRIEF——项目简介 -
PROJECT_LOGO——项目Logo
-
OUTPUT_DIRECTORY——输出目录，相对路径或绝对路径，相对路径相对于Doxygen运行的目录，留空则使用当前目录 -
OUTPUT_LANGUAGE——输出语言，默认”English”，中文”Chinese” -
BRIEF_MEMBER_DESC——文件file及类class文档列出的成员下方是否包含简要成员描述，默认”YES”，”NO”关闭
-
REPEAT_BRIEF——在成员或函数的详细描述前预置简要描述，默认”YES”，”NO”关闭
-
INLINE_INHERITED_MEMB——在文档中展示所有继承的成员，构造函数、析构函数、赋值运算符及基类不会显示，默认”NO”，”YES”启用
-
FULL_PATH_NAMES——在文件列表和头文件中使用完整路径名称，默认”YES”，”NO”关闭
-
STRIP_FROM_PATH——去除路径中用户定义的部分（指定字符串与路径左侧匹配，支持指定相对路径或绝对路径），用于在文件列表中展示相对路径，留空将使用Doxygen运行路径，该项需要FULL_PATH_NAMES设置为”YES”，默认留空 -
STRIP_FROM_INC_PATH——去除类文档中说明使用该类需包含的头文件的路径中用户定义的部分，留空则仅显示包含类定义的头文件的名称，默认留空
-
SEPARATE_MEMBER_PAGES——为每个成员生成一个新的页面，设为”NO”则成员会作为包含它的文件或类或命名空间的文档的一部分，默认”NO”，”YES”启用
-
TAB_SIZE——tab中的空格数量，范围1-16，默认4 -
MARKDOWN_SUPPORT——Markdown支持，仅在向下兼容时关闭，默认”YES”，”NO”关闭，参见Doxygen-添加Markdown文件 -
TOC_INCLUDE_HEADINGS——设为非0值时，所有该等级以上的标头都自动包含在内容列表中（即使它们没有id属性），该功能目前仅应用于Markdown标头中且需要MARKDOWN_SUPPORT设置为”YES”，范围0-99，默认5
-
AUTOLINK_SUPPORT——将与文档中的类或命名空间一致的单词链接到它们所在的文档，在单词前添加’%’符号或将该项设为”NO”来防止链接，默认”YES”，”NO”关闭
# This is a level 1 header
## This is level 2 header
### This is level 3 header
#### This is level 4 header
##### This is level 5 header
###### This is level 6 header
Here is text for one paragraph.
CMiniFridge
%CMiniFridge
另外还有一些可能会用到的和语言、功能支持等方面相关的配置项，这里仅简单列举（同Doxygen配置顺序）：
-
JAVADOC_AUTOBRIEF -
JAVADOC_BANNER -
QT_AUTOBRIEF -
MULTILINE_CPP_IS_BRIEF -
PYTHON_DOCSTRING -
ALIASES -
OPTIMIZE_OUTPUT_FOR_C -
OPTIMIZE_OUTPUT_JAVA -
OPTIMIZE_FOR_FORTRAN -
OPTIMIZE_OUTPUT_VHDL -
OPTIMIZE_OUTPUT_SLICE -
EXTENSION_MAPPING -
BUILTIN_STL_SUPPORT -
CPP_CLI_SUPPORT -
SIP_SUPPORT -
IDL_PROPERTY_SUPPORT -
DISTRIBUTE_GROUP_DOC -
GROUP_NESTED_COMPOUNDS -
SUBGROUPING -
INLINE_GROUPED_CLASSES -
INLINE_SIMPLE_STRUCTS -
TYPEDEF_HIDES_STRUCT
参考资料
Doxywizard: https://www.doxygen.nl/manual/doxywizard_usage.html
原文始发于微信公众号（技术知识小记）：Doxygen-配置选项【一】
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/185011.html
