配置文件是一个自由格式的 ASCII 文本文件,其结构类似于 Makefile
,默认名称为 Doxyfile
。它由 doxygen
解析。该文件可以包含制表符和换行符以进行格式化。文件中的语句区分大小写。
配置文件本质上由一系列赋值语句组成。每个语句都包含一个用大写字母书写的 TAG_NAME
,后跟等号 (=
) 和一个或多个值。如果同一个标签被多次赋值,则最后一次赋值将覆盖任何较早的赋值。对于将列表作为参数的标签,可以使用 +=
运算符代替 =
来将新值附加到列表。值是 非空白字符序列。如果值应包含一个或多个空格,则必须用引号 ("..."
) 括起来。可以通过在行的最后一个非空白字符处插入反斜杠 (\
) 来连接多行。
注释以井号 (#
) 开头,并在行尾结束。注释可以放置在文件中的任何位置(除了引号内)。以两个井号 (##
) 开头的注释在更新配置文件时会保留,当它们位于 TAG_NAME
前面,或位于配置文件的开头或结尾时。
可以使用模式 $(ENV_VARIABLE_NAME)
展开环境变量。一个小例子
DOT_PATH = $(YOUR_DOT_PATH)
您还可以使用 @INCLUDE
标签从另一个配置文件中包含一部分配置文件,如下所示
@INCLUDE = config_file_name
将在当前工作目录中搜索包含文件。您还可以指定一个目录列表,在查找当前工作目录之前应先搜索这些目录。通过在 @INCLUDE
标签之前放置带有这些路径的 @INCLUDE_PATH
标签来完成此操作,例如
@INCLUDE_PATH = my_config_dir
配置选项可以分为几个类别。下面是可识别的标签的字母索引,后跟按类别分组的标签描述。
DOXYFILE_ENCODING
此标签指定用于配置文件中所有后续字符的编码。默认值为 UTF-8,这也是此标签首次出现之前所有文本使用的编码。Doxygen 使用 libiconv
(或内置在 libc
中的 iconv)进行转码。有关可能的编码列表,请参阅 https://gnu.ac.cn/software/libiconv/。
默认值为:UTF-8
。
PROJECT_NAME
PROJECT_NAME
标签是一个单词(或用双引号括起来的单词序列,除非您使用的是 Doxywizard),它应该标识要为其生成文档的项目。此名称用于大多数生成的页面的标题以及其他一些位置。
默认值是:My Project
。
PROJECT_NUMBER
PROJECT_BRIEF
使用 PROJECT_BRIEF
标签可以为项目提供一个可选的单行描述,该描述显示在每个页面的顶部,并应使查看者快速了解项目的目的。请保持描述简短。
PROJECT_LOGO
使用 PROJECT_LOGO
标签可以指定一个包含在文档中的徽标或图标。徽标的最大高度不应超过 55 像素,最大宽度不应超过 200 像素。Doxygen 会将徽标复制到输出目录。
PROJECT_ICON
使用 PROJECT_ICON
标签可以指定一个图标,该图标在显示 HTML 文档时包含在选项卡中。Doxygen 会将徽标复制到输出目录。
OUTPUT_DIRECTORY
OUTPUT_DIRECTORY
标签用于指定将写入生成的文档的(相对或绝对)路径。如果输入相对路径,则该路径将相对于 Doxygen 启动的位置。如果留空,则将使用当前目录。
CREATE_SUBDIRS
如果将 CREATE_SUBDIRS
标签设置为 YES
,则 Doxygen 将在每种输出格式的输出目录下创建最多 4096 个子目录(在 2 个级别中),并将生成的文件分发到这些目录中。当向 Doxygen 提供大量源文件时,启用此选项可能很有用,否则将所有生成的文件放在同一目录中会导致文件系统的性能问题。调整 CREATE_SUBDIRS_LEVEL
以控制子目录的数量。
默认值是:NO
。
CREATE_SUBDIRS_LEVEL
控制当 CREATE_SUBDIRS
标签设置为 YES
时将创建的子目录数量。级别 0 表示 16 个目录,每个级别增量使目录数量翻倍,在级别 8 时产生 4096 个目录,这也是默认值和最大值。子目录组织在 2 个级别中,第一级始终有固定的 16 个目录。
最小值:0
,最大值:8
,默认值:8
。
此标签要求将标签 CREATE_SUBDIRS 设置为 YES
。
ALLOW_UNICODE_NAMES
如果将 ALLOW_UNICODE_NAMES
标签设置为 YES
,则 Doxygen 将允许非 ASCII 字符出现在生成文件的名称中。如果设置为 NO
,则将转义非 ASCII 字符,例如,Unicode U+3044 将使用 _xE3_x81_x84。
默认值是:NO
。
OUTPUT_LANGUAGE
OUTPUT_LANGUAGE
标签用于指定 Doxygen 生成的所有文档所使用的语言。Doxygen 将使用此信息以正确的语言生成所有常量输出。
可能的值为:Afrikaans
、Arabic
、Armenian
、Brazilian
、Bulgarian
、Catalan
、Chinese
、Chinese-Traditional
、Croatian
、Czech
、Danish
、Dutch
、English
(美国)、Esperanto
、Farsi
(波斯语)、Finnish
、French
、German
、Greek
、Hindi
、Hungarian
、Indonesian
、Italian
、Japanese
、Japanese-en
(带英文消息的日语)、Korean
、Korean-en
(带英文消息的韩语)、Latvian
、Lithuanian
、Macedonian
、Norwegian
、Persian
(波斯语)、Polish
、Portuguese
、Romanian
、Russian
、Serbian
、Serbian-Cyrillic
、Slovak
、Slovene
、Spanish
、Swedish
、Turkish
、Ukrainian
和 Vietnamese
。
默认值是:English
。
BRIEF_MEMBER_DESC
如果将 BRIEF_MEMBER_DESC
标签设置为 YES
,则 Doxygen 将在文件和类文档中列出的成员之后包含简短的成员描述(类似于 Javadoc
)。设置为 NO
以禁用此功能。
默认值是:YES
。
REPEAT_BRIEF
如果将 REPEAT_BRIEF
标签设置为 YES
,则 Doxygen 将在详细描述之前添加成员或函数的简短描述。
注意:如果 HIDE_UNDOC_MEMBERS 和 BRIEF_MEMBER_DESC 都设置为 NO
,则将完全禁止显示简短描述。
默认值是:YES
。
ABBREVIATE_BRIEF
此标签实现了一个准智能的简短描述缩写器,用于形成各种列表中的文本。如果在此列表中找到的每个字符串作为简短描述的开头文本,则将从文本中删除该字符串,并且在处理完整个列表后,将结果用作注释文本。否则,简短描述将按原样使用。如果留空,则将使用以下值($name
会自动替换为实体的名称):The $name class
、The $name widget
、The $name file
、is
、provides
、specifies
、contains
、represents
、a
、an
和 the
。
ALWAYS_DETAILED_SEC
如果 ALWAYS_DETAILED_SEC
和 REPEAT_BRIEF 标签都设置为 YES
,则即使只有简短描述,Doxygen 也会生成详细部分。
默认值是:NO
。
INLINE_INHERITED_MEMB
如果将 INLINE_INHERITED_MEMB
标签设置为 YES
,则 Doxygen 将在该类的文档中显示类的所有继承成员,就好像这些成员是普通的类成员一样。不会显示基类的构造函数、析构函数和赋值运算符。
默认值是:NO
。
FULL_PATH_NAMES
如果将 FULL_PATH_NAMES
标签设置为 YES
,则 Doxygen 将在文件列表和头文件中在文件名称前添加完整路径。如果设置为 NO
,则将使用使文件名唯一的短路径。
默认值是:YES
。
STRIP_FROM_PATH
STRIP_FROM_PATH
标签可用于剥离用户定义的部分路径。仅当指定字符串之一与路径的左侧部分匹配时,才进行剥离。该标签可用于在文件列表中显示相对路径。如果留空,则将 Doxygen 运行的目录用作要剥离的路径。
请注意,您可以在此处指定绝对路径,也可以指定相对路径,这些路径将相对于 Doxygen 启动的目录。
此标签要求将标签 FULL_PATH_NAMES 设置为 YES
。
STRIP_FROM_INC_PATH
STRIP_FROM_INC_PATH
标签可用于剥离类文档中提到的用户定义的部分路径,该路径告知读者为了使用类应包含哪个头文件。如果留空,则仅使用包含类定义的头文件名称。否则,应指定使用 -I
标志通常传递给编译器的 include 路径列表。
SHORT_NAMES
如果将 SHORT_NAMES
标签设置为 YES
,则 Doxygen 将生成更短(但可读性较差)的文件名。如果您的文件系统不支持长名称(如在 DOS、Mac 或 CD-ROM 上),这可能很有用。
默认值是:NO
。
JAVADOC_AUTOBRIEF
如果将 JAVADOC_AUTOBRIEF
标签设置为 YES
,则 Doxygen 会将 Javadoc 风格注释的第一行(直到第一个点号、问号或感叹号)解释为简短描述。如果设置为 NO
,则 Javadoc 风格的行为将与常规 Qt 风格注释类似(因此,对于简短描述,需要显式的 @brief 命令。)
默认值是:NO
。
JAVADOC_BANNER
如果将 JAVADOC_BANNER
标签设置为 YES
,则 Doxygen 会将类似这样的行解释为
/***************
作为 Javadoc 风格注释“横幅”的开头。如果设置为 NO
,则 Javadoc 风格的行为将与常规注释类似,并且 Doxygen 不会对其进行解释。
默认值是:NO
。
QT_AUTOBRIEF
如果将 QT_AUTOBRIEF
标签设置为 YES
,则 Doxygen 会将 Qt 风格注释的第一行(直到第一个点号、问号或感叹号)解释为简短描述。如果设置为 NO
,则 Qt 风格的行为将与常规 Qt 风格注释类似(因此,对于简短描述,需要显式的 \brief 命令。)
默认值是:NO
。
MULTILINE_CPP_IS_BRIEF
可以将 MULTILINE_CPP_IS_BRIEF
标签设置为 YES
,以使 Doxygen 将多行 C++ 特殊注释块(即 //!
或 ///
注释块)视为简短描述。这曾经是默认行为。新的默认行为是将多行 C++ 注释块视为详细描述。如果您更喜欢旧的行为,请将此标签设置为 YES
。
请注意,将此标签设置为 YES
也意味着不再识别 Rational Rose 注释。
默认值是:NO
。
PYTHON_DOCSTRING
默认情况下,Python 文档字符串显示为预格式化文本,并且不能使用 Doxygen 的特殊命令。通过将 PYTHON_DOCSTRING
设置为 NO
,可以使用 Doxygen 的特殊命令,并且文档字符串文档块的内容显示为 Doxygen 文档。
默认值是:YES
。
INHERIT_DOCS
如果将 INHERIT_DOCS
标签设置为 YES
,则未记录的成员将从它重新实现的任何已记录的成员继承文档。
默认值是:YES
。
SEPARATE_MEMBER_PAGES
如果将 SEPARATE_MEMBER_PAGES
标签设置为 YES
,则 Doxygen 将为每个成员生成一个新页面。如果设置为 NO
,则成员的文档将成为包含它的文件/类/命名空间的一部分。
默认值是:NO
。
TAB_SIZE
TAB_SIZE
标签可用于设置制表符中的空格数。Doxygen 使用此值将代码片段中的制表符替换为空格。
最小值:1
,最大值:16
,默认值:4
。
ALIASES
name=value
例如,添加
"sideeffect=@par Side Effects:^^"
将允许您在文档中使用命令 \sideeffect
(或 @sideeffect
),这将在文档中生成一个标题为“副作用:”的用户定义段落。请注意,您不能在别名的值部分使用 \n 来插入新行(在最终输出中)。您可以在别名的值部分使用 ^^
来插入新行,就好像原始文件中存在物理换行符一样。当您需要在别名的值部分使用文字 {
或 }
或 ,
时,您必须使用反斜杠 (\
) 对它们进行转义,这可能会导致与命令 \{
和 \}
冲突,对于这些命令,建议使用 @{
和 @}
版本或使用双重转义 (\\{
和 \\}
)。
OPTIMIZE_OUTPUT_FOR_C
如果您的项目仅包含 C 源代码,请将 OPTIMIZE_OUTPUT_FOR_C
标签设置为 YES
。然后,Doxygen 将生成更适合 C 的输出。例如,使用的一些名称将会不同。将省略所有成员的列表等等。
默认值是:NO
。
OPTIMIZE_OUTPUT_JAVA
如果您的项目仅包含 Java 或 Python 源代码,请将 OPTIMIZE_OUTPUT_JAVA
标签设置为 YES
。然后,Doxygen 将生成更适合该语言的输出。例如,命名空间将以包的形式呈现,限定的作用域将看起来不同等等。
默认值是:NO
。
OPTIMIZE_FOR_FORTRAN
如果您的项目包含 Fortran 源代码,请将 OPTIMIZE_FOR_FORTRAN
标签设置为 YES
。然后,Doxygen 将生成适合 Fortran 的输出。
默认值是:NO
。
OPTIMIZE_OUTPUT_VHDL
如果您的项目包含 VHDL 源代码,请将 OPTIMIZE_OUTPUT_VHDL
标签设置为 YES
。然后,Doxygen 将生成适合 VHDL 的输出。
默认值是:NO
。
OPTIMIZE_OUTPUT_SLICE
如果您的项目仅包含 Slice 源代码,请将 OPTIMIZE_OUTPUT_SLICE
标签设置为 YES
。然后,Doxygen 将生成更适合该语言的输出。例如,命名空间将以模块的形式呈现,类型将被分为更多的组等等。
默认值是:NO
。
EXTENSION_MAPPING
Doxygen 根据其解析文件的扩展名选择要使用的解析器。使用此标签,您可以为给定的扩展名分配要使用的解析器。Doxygen 具有内置的映射,但是您可以使用此标签覆盖或扩展它。格式为 ext=language
,其中 ext
是文件扩展名,而 language 是 Doxygen 支持的解析器之一:IDL、Java、JavaScript、Csharp (C#)、C、C++、Lex、D、PHP、md (Markdown)、Objective-C、Python、Slice、VHDL、Fortran(固定格式 Fortran:FortranFixed,自由格式 Fortran:FortranFree,未知格式 Fortran:Fortran。在后一种情况下,解析器会尝试猜测代码是固定格式还是自由格式代码,这是 Fortran 类型文件的默认值)。
例如,要使 Doxygen 将 .inc
文件视为 Fortran 文件(默认值为 PHP),并将 .f
文件视为 C 文件(默认值为 Fortran),请使用:inc=Fortran f=C
。
注意:对于没有扩展名的文件,您可以使用 no_extension
作为占位符。
请注意,对于自定义扩展名,您还需要设置 FILE_PATTERNS,否则 Doxygen 不会读取这些文件。当指定 no_extension
时,您应该将 *
添加到 FILE_PATTERNS。
请注意,另请参阅 默认文件扩展名映射 列表。
MARKDOWN_SUPPORT
如果启用了 MARKDOWN_SUPPORT
标签,则 Doxygen 会根据 Markdown 格式预处理所有注释,从而使文档更具可读性。有关详细信息,请参阅 https://daringfireball.net/projects/markdown/。Markdown 处理的输出将由 Doxygen 进一步处理,因此您可以将 Doxygen、HTML 和 XML 命令与 Markdown 格式混合使用。仅在出现向后兼容性问题时禁用。
默认值是:YES
。
TOC_INCLUDE_HEADINGS
当 TOC_INCLUDE_HEADINGS
标签设置为非零值时,所有达到该级别的标题都会自动包含在目录中,即使它们没有 id 属性也是如此。
最小值:0
,最大值:99
,默认值:6
。
此标签要求将标签 MARKDOWN_SUPPORT 设置为 YES
。
MARKDOWN_ID_STYLE
MARKDOWN_ID_STYLE
标签可用于指定生成 Markdown 标题标识符的算法。注意:每个标识符都是唯一的。
可能的值为:DOXYGEN
使用固定的 'autotoc_md' 字符串,后跟一个从 0 开始的序列号,而 GITHUB
使用标题的小写版本,并将所有空格替换为 '-' 并删除标点符号。
默认值为:DOXYGEN
。
此标签要求将标签 MARKDOWN_SUPPORT 设置为 YES
。
AUTOLINK_SUPPORT
启用后,Doxygen 会尝试将与文档中类或命名空间对应的单词链接到其对应的文档。可以通过在单词前面放置一个 %
符号来防止在个别情况下出现此类链接,或者通过将 AUTOLINK_SUPPORT
设置为 NO
来全局防止。AUTOLINK_IGNORE_WORDS
标签中列出的单词将排除在自动链接之外。
默认值是:YES
。
AUTOLINK_IGNORE_WORDS
此标签指定一个单词列表,当该列表与文档中单词的开头匹配时,如果通过 AUTOLINK_SUPPORT 启用,将禁止自动链接生成。此列表不影响使用 # 或 \link 或 \ref 命令显式创建的链接。
此标签要求将标签 AUTOLINK_SUPPORT 设置为 YES
。
BUILTIN_STL_SUPPORT
如果您使用 STL 类(例如 std::string
、std::vector
等),但不想包含(STL 源的标签文件)作为输入,则应将此标签设置为 YES
,以便让 Doxygen 匹配参数包含 STL 类的函数声明和定义(例如,func(std::string
); 与 func(std::string) {}
)。这还可以使涉及 STL 类的继承和协作图更完整和准确。
默认值是:NO
。
CPP_CLI_SUPPORT
如果您使用 Microsoft 的 C++/CLI 语言,则应将此选项设置为 YES
以启用解析支持。
默认值是:NO
。
SIP_SUPPORT
如果您的项目仅包含 sip 源代码,请将 SIP_SUPPORT
标签设置为 YES
。Doxygen 会像解析普通 C++ 一样解析它们,但会假设所有类在没有显式保护关键字的情况下使用 public 而不是 private 继承。
默认值是:NO
。
IDL_PROPERTY_SUPPORT
对于 Microsoft 的 IDL,有 propget
和 propput
属性来指示属性的 getter 和 setter 方法。将此选项设置为 YES
将使 Doxygen 在文档中用属性替换 get 和 set 方法。这仅在这些方法确实在获取或设置简单类型时才有效。如果不是这种情况,或者您想显示这些方法,则应将此选项设置为 NO
。
默认值是:YES
。
DISTRIBUTE_GROUP_DOC
如果文档中使用了成员分组,并且 DISTRIBUTE_GROUP_DOC
标签设置为 YES
,则 Doxygen 将为该组的其他成员重用该组中第一个成员(如果有)的文档。默认情况下,组的所有成员都必须显式记录。
默认值是:NO
。
GROUP_NESTED_COMPOUNDS
如果将结构或类添加到组中,并且启用了此选项,那么任何嵌套的类或结构也会添加到同一组中。默认情况下,此选项处于禁用状态,必须通过 \ingroup 显式添加嵌套的复合类型。
默认值是:NO
。
SUBGROUPING
将 SUBGROUPING
标签设置为 YES
,以允许同一类型的类成员组(例如,一组公共函数)作为该类型的子组(例如,在“公共函数”部分下)放置。将其设置为 NO
以防止子分组。或者,可以使用 \nosubgrouping 命令按类执行此操作。
默认值是:YES
。
INLINE_GROUPED_CLASSES
当 INLINE_GROUPED_CLASSES
标签设置为 YES
时,类、结构和联合会显示在它们包含的组中(例如,使用 \ingroup),而不是在单独的页面(对于 HTML 和 Man 页面)或部分(对于 和 RTF)。
请注意,此功能不能与 SEPARATE_MEMBER_PAGES 结合使用。
默认值是:NO
。
INLINE_SIMPLE_STRUCTS
当 INLINE_SIMPLE_STRUCTS
标签设置为 YES
时,仅包含公共数据字段或简单 typedef 字段的结构、类和联合将内联显示在它们定义的范围的文档中(即文件、命名空间或组文档),前提是已记录此范围。如果设置为 NO
,则结构、类和联合将显示在单独的页面(对于 HTML 和 Man 页面)或部分(对于 和 RTF)。
默认值是:NO
。
TYPEDEF_HIDES_STRUCT
启用 TYPEDEF_HIDES_STRUCT
标签后,结构、联合或枚举的 typedef 将被记录为具有 typedef 名称的结构、联合或枚举。因此,typedef struct TypeS {} TypeT
将在文档中显示为名称为 TypeT
的结构。禁用后,typedef 将显示为文件、命名空间或类的成员。并且该结构将命名为 TypeS
。如果编码约定规定所有复合类型都进行了 typedef 并且仅引用了 typedef,而从不引用标签名称,则这对于 C 代码通常很有用。
默认值是:NO
。
LOOKUP_CACHE_SIZE
可以使用 LOOKUP_CACHE_SIZE
设置符号查找缓存的大小。此缓存用于解析给定名称和范围的符号。由于这可能是一个开销很大的过程,并且通常同一个符号在代码中多次出现,因此 Doxygen 会保留预解析符号的缓存。如果缓存太小,Doxygen 会变慢。如果缓存太大,则会浪费内存。缓存大小由以下公式给出:。有效范围是 0..9,默认值为 0,对应于
个符号的缓存大小。在运行结束时,Doxygen 将报告缓存使用情况,并从速度的角度建议最佳缓存大小。
最小值:0
,最大值:9
,默认值:0
。
NUM_PROC_THREADS
NUM_PROC_THREADS
指定 Doxygen 在处理过程中允许使用的线程数。当设置为 0
时,Doxygen 将基于系统中可用的内核数进行设置。您可以将其显式设置为大于 0 的值,以更好地控制 CPU 负载和处理速度之间的平衡。目前,只有输入处理可以使用多个线程完成。由于这仍然是一个实验性功能,因此默认设置为 1,这实际上禁用了并行处理。请报告您遇到的任何问题。并行生成点图由 DOT_NUM_THREADS
设置控制。
最小值:0
,最大值:32
,默认值:1
。
TIMESTAMP
如果 TIMESTAMP
标签设置的值不是 NO
,那么每个生成的页面将包含该页面生成的日期或日期和时间。将其设置为 NO
有助于比较多次运行的输出结果。
可能的值有:YES
、NO
、DATETIME
和 DATE
。
默认值是:NO
。
EXTRACT_ALL
如果 EXTRACT_ALL
标签设置为 YES
,Doxygen 将假定文档中的所有实体都已记录,即使没有可用的文档。私有类成员和静态文件成员将被隐藏,除非 EXTRACT_PRIVATE 和 EXTRACT_STATIC 标签分别设置为 YES
。
YES
时,这也会禁用通常产生的有关未记录成员的警告。默认值是:NO
。
EXTRACT_PRIVATE
如果 EXTRACT_PRIVATE
标签设置为 YES
,则类的所有私有成员都将包含在文档中。
默认值是:NO
。
EXTRACT_PRIV_VIRTUAL
如果 EXTRACT_PRIV_VIRTUAL
标签设置为 YES
,则类中已记录的私有虚方法将包含在文档中。
默认值是:NO
。
EXTRACT_PACKAGE
如果 EXTRACT_PACKAGE
标签设置为 YES
,则所有具有包或内部作用域的成员都将包含在文档中。
默认值是:NO
。
EXTRACT_STATIC
如果 EXTRACT_STATIC
标签设置为 YES
,则文件的所有静态成员都将包含在文档中。
默认值是:NO
。
EXTRACT_LOCAL_CLASSES
如果 EXTRACT_LOCAL_CLASSES
标签设置为 YES
,则在源文件中本地定义的类(和结构体)将包含在文档中。如果设置为 NO
,则仅包含在头文件中定义的类。对 Java 源代码没有任何影响。
默认值是:YES
。
EXTRACT_LOCAL_METHODS
此标志仅对 Objective-C 代码有用。如果设置为 YES
,则在实现部分定义但不在接口中定义的本地方法将包含在文档中。如果设置为 NO
,则仅包含接口中的方法。
默认值是:NO
。
EXTRACT_ANON_NSPACES
如果此标志设置为 YES
,则匿名命名空间的成员将被提取并显示在文档中,作为名为 “anonymous_namespace{file}” 的命名空间,其中 file 将被替换为包含匿名命名空间的文件的基本名称。默认情况下,匿名命名空间是隐藏的。
默认值是:NO
。
RESOLVE_UNNAMED_PARAMS
如果此标志设置为 YES
,则声明中未命名参数的名称将由相应的定义确定。默认情况下,未命名参数在输出中保持未命名状态。
默认值是:YES
。
HIDE_UNDOC_MEMBERS
如果 HIDE_UNDOC_MEMBERS
标签设置为 YES
,Doxygen 将隐藏已记录的类或文件中的所有未记录成员。如果设置为 NO
,这些成员将包含在各种概述中,但不会生成文档部分。如果启用了 EXTRACT_ALL,则此选项无效。
默认值是:NO
。
HIDE_UNDOC_CLASSES
如果 HIDE_UNDOC_CLASSES
标签设置为 YES
,Doxygen 将隐藏类层次结构中通常可见的所有未记录类。如果设置为 NO
,这些类将包含在各种概述中。如果启用,此选项还将隐藏未记录的 C++ 概念。如果启用了 EXTRACT_ALL,则此选项无效。
默认值是:NO
。
HIDE_UNDOC_NAMESPACES
如果 HIDE_UNDOC_NAMESPACES
标签设置为 YES
,Doxygen 将隐藏命名空间层次结构中通常可见的所有未记录命名空间。如果设置为 NO
,这些命名空间将包含在各种概述中。如果启用了 EXTRACT_ALL,则此选项无效。
默认值是:YES
。
HIDE_FRIEND_COMPOUNDS
如果 HIDE_FRIEND_COMPOUNDS
标签设置为 YES
,Doxygen 将隐藏所有友元声明。如果设置为 NO
,这些声明将包含在文档中。
默认值是:NO
。
HIDE_IN_BODY_DOCS
如果 HIDE_IN_BODY_DOCS
标签设置为 YES
,Doxygen 将隐藏在函数主体内部找到的任何文档块。如果设置为 NO
,这些块将附加到函数的详细文档块中。
默认值是:NO
。
INTERNAL_DOCS
INTERNAL_DOCS
标签确定是否包含在 \internal 命令后键入的文档。如果标签设置为 NO
,则该文档将被排除。将其设置为 YES
以包含内部文档。
默认值是:NO
。
CASE_SENSE_NAMES
通过正确设置选项 CASE_SENSE_NAMES
,Doxygen 将更好地匹配底层文件系统的功能。
如果文件系统区分大小写(即,它支持同一目录中名称仅在大小写上不同的文件),则必须将此选项设置为 YES
,以便在输入中出现此类文件时正确处理它们。
对于不区分大小写的文件系统,应将此选项设置为 NO
,以便正确处理为仅在大小写上不同的符号(例如,两个类,一个名为 CLASS
,另一个名为 Class
)写入的输出文件,并且还支持引用文件而无需指定精确匹配的大小写。
在 Windows(包括 Cygwin)和 macOS 上,用户通常应将此选项设置为 NO
,而在 Linux 或其他 Unix 版本上,通常应将其设置为 YES
。
可能的值有:SYSTEM
、NO
和 YES
。
默认值为:SYSTEM
。
HIDE_SCOPE_NAMES
如果 HIDE_SCOPE_NAMES
标签设置为 NO
,则 Doxygen 将在文档中显示具有完整类和命名空间作用域的成员。如果设置为 YES
,则作用域将被隐藏。
默认值是:NO
。
HIDE_COMPOUND_REFERENCE
如果 HIDE_COMPOUND_REFERENCE
标签设置为 NO
(默认值),则 Doxygen 将在页面标题中附加其他文本,例如“类参考”。如果设置为 YES
,复合参考将被隐藏。
默认值是:NO
。
SHOW_HEADERFILE
如果 SHOW_HEADERFILE
标签设置为 YES
,则类的文档将显示使用该类需要包含哪个文件。
默认值是:YES
。
SHOW_INCLUDE_FILES
如果 SHOW_INCLUDE_FILES
标签设置为 YES
,则 Doxygen 将在文件的文档中列出该文件包含的文件列表。
默认值是:YES
。
SHOW_GROUPED_MEMB_INC
如果 SHOW_GROUPED_MEMB_INC
标签设置为 YES
,则 Doxygen 将为每个分组的成员在文档中添加一个包含语句,告诉读者要使用该成员需要包含哪个文件。
默认值是:NO
。
FORCE_LOCAL_INCLUDES
如果 FORCE_LOCAL_INCLUDES
标签设置为 YES
,则 Doxygen 将在文档中使用双引号而不是尖括号列出包含文件。
默认值是:NO
。
INLINE_INFO
如果 INLINE_INFO
标签设置为 YES
,则会在内联成员的文档中插入标签 [inline]。
默认值是:YES
。
SORT_MEMBER_DOCS
如果 SORT_MEMBER_DOCS
标签设置为 YES
,则 Doxygen 将按成员名称的字母顺序对文件和类成员的(详细)文档进行排序。如果设置为 NO
,则成员将按声明顺序显示。
默认值是:YES
。
SORT_BRIEF_DOCS
如果 SORT_BRIEF_DOCS
标签设置为 YES
,则 Doxygen 将按成员名称的字母顺序对文件、命名空间和类成员的简短描述进行排序。如果设置为 NO
,则成员将按声明顺序显示。请注意,这也会影响类列表中类的顺序。
默认值是:NO
。
SORT_MEMBERS_CTORS_1ST
如果 SORT_MEMBERS_CTORS_1ST
标签设置为 YES
,则 Doxygen 将对类成员的(简短和详细)文档进行排序,以便首先列出构造函数和析构函数。如果设置为 NO
,构造函数将按 SORT_BRIEF_DOCS 和 SORT_MEMBER_DOCS 定义的相应顺序显示。
NO
,则此选项将被忽略,不用于排序简短的成员文档。NO
,则此选项将被忽略,不用于排序详细的成员文档。默认值是:NO
。
SORT_GROUP_NAMES
如果 SORT_GROUP_NAMES
标签设置为 YES
,则 Doxygen 将按字母顺序对组名称的层次结构进行排序。如果设置为 NO
,组名称将按其定义的顺序显示。
默认值是:NO
。
SORT_BY_SCOPE_NAME
如果 SORT_BY_SCOPE_NAME
标签设置为 YES
,则类列表将按完全限定名称(包括命名空间)排序。如果设置为 NO
,则类列表将仅按类名称排序,不包括命名空间部分。
YES
,则此选项不是很实用。默认值是:NO
。
STRICT_PROTO_MATCHING
如果启用 STRICT_PROTO_MATCHING
选项,并且 Doxygen 无法正确解析函数的所有参数的类型,即使只有一个候选者,或者通过简单的字符串匹配可以明显选择哪个候选者,它也会拒绝成员函数的原型和实现之间的匹配。通过禁用 STRICT_PROTO_MATCHING
,Doxygen 在这种情况下仍然会接受原型和实现之间的匹配。
默认值是:NO
。
GENERATE_TODOLIST
GENERATE_TODOLIST
标签可用于启用 (YES
) 或禁用 (NO
) 待办事项列表。此列表是通过在文档中放置 \todo 命令创建的。
默认值是:YES
。
GENERATE_TESTLIST
GENERATE_TESTLIST
标签可用于启用 (YES
) 或禁用 (NO
) 测试列表。此列表是通过在文档中放置 \test 命令创建的。
默认值是:YES
。
GENERATE_BUGLIST
GENERATE_BUGLIST
标签可用于启用 (YES
) 或禁用 (NO
) 错误列表。此列表是通过在文档中放置 \bug 命令创建的。
默认值是:YES
。
GENERATE_DEPRECATEDLIST
GENERATE_DEPRECATEDLIST
标签可用于启用 (YES
) 或禁用 (NO
) 弃用列表。此列表是通过在文档中放置 \deprecated 命令创建的。
默认值是:YES
。
ENABLED_SECTIONS
ENABLED_SECTIONS
标签可用于启用条件文档节,这些文档节用 \if <section_label> ... \endif 和 \cond <section_label> ... \endcond 代码块标记。
MAX_INITIALIZER_LINES
MAX_INITIALIZER_LINES
标签确定变量或宏/定义的初始值在文档中显示的最大行数。如果初始值包含的行数超过此处指定的行数,则会被隐藏。使用值 0 完全隐藏初始值。可以使用文档中的 \showinitializer 或 \hideinitializer 命令来控制单个变量和宏/定义的值的显示,而无需考虑此设置。
最小值:0
,最大值:10000
,默认值:30
。
SHOW_USED_FILES
将 SHOW_USED_FILES
标签设置为 NO
可禁用在类和结构文档底部生成的文件列表。如果设置为 YES
,则列表将提及用于生成文档的文件。
默认值是:YES
。
SHOW_FILES
将 SHOW_FILES
标签设置为 NO
可禁用“文件”页面的生成。这将从“快速索引”和“文件夹树视图”(如果指定)中删除“文件”条目。
默认值是:YES
。
SHOW_NAMESPACES
将 SHOW_NAMESPACES
标签设置为 NO
可禁用“命名空间”页面的生成。这将从“快速索引”和“文件夹树视图”(如果指定)中删除“命名空间”条目。
默认值是:YES
。
FILE_VERSION_FILTER
FILE_VERSION_FILTER
标签可用于指定 Doxygen 应调用的程序或脚本,以获取每个文件的当前版本(通常来自版本控制系统)。Doxygen 将通过执行(通过 popen()
)命令 command input-file
来调用该程序,其中 command
是 FILE_VERSION_FILTER
标签的值,而 input-file
是 Doxygen 提供的输入文件的名称。程序写入标准输出的任何内容都将用作文件版本。
使用 shell 脚本作为 Unix 过滤器的示例
FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
CVS 的 shell 脚本示例
#!/bin/sh cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
Subversion 的 shell 脚本示例
#!/bin/sh svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'
ClearCase 的过滤器示例
FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
LAYOUT_FILE
LAYOUT_FILE
标签可用于指定 Doxygen 将解析的布局文件。布局文件以独立于输出格式的方式控制生成的输出文件的全局结构。要创建表示 Doxygen 默认值的布局文件,请使用 -l
选项运行 Doxygen。您可以选择在选项后指定文件名,如果省略,则 DoxygenLayout.xml
将用作布局文件的名称。有关信息,另请参见 更改页面布局 部分。
请注意,如果您从包含名为 DoxygenLayout.xml
的文件的目录中运行 Doxygen,则即使 LAYOUT_FILE
标签为空,Doxygen 也会自动解析它。
CITE_BIB_FILES
CITE_BIB_FILES
标签可用于指定一个或多个包含引用定义的 bib
文件。这必须是 .bib
文件列表。如果省略,则会自动附加 .bib
扩展名。这需要安装 bibtex
工具。有关更多信息,另请参阅 https://en.wikipedia.org/wiki/BibTeX。对于 ,可以使用 LATEX_BIB_STYLE 控制书目的样式。要使用此功能,您需要在搜索路径中提供
bibtex
和 perl
。另请参阅 \cite,了解如何创建引用。
EXTERNAL_TOOL_PATH
EXTERNAL_TOOL_PATH
标签可用于扩展搜索路径(PATH 环境变量),以便可以找到 latex
和 gs
等外部工具。EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin连同标准路径一起,doxygen 在启动外部工具时使用的完整搜索路径将变为
PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
QUIET
QUIET
标签可用于打开/关闭 Doxygen 生成到标准输出的消息。如果 QUIET
设置为 YES
,则表示消息已关闭。
默认值是:NO
。
WARNINGS
WARNINGS
标签可用于打开/关闭 Doxygen 生成到标准错误 (stderr
) 的警告消息。如果 WARNINGS
设置为 YES
,则表示警告已打开。
提示:在编写文档时打开警告。
默认值是:YES
。
WARN_IF_UNDOCUMENTED
如果 WARN_IF_UNDOCUMENTED
标签设置为 YES
,则 Doxygen 将为未记录的成员生成警告。如果 EXTRACT_ALL 设置为 YES
,则此标志将自动禁用。
默认值是:YES
。
WARN_IF_DOC_ERROR
如果 WARN_IF_DOC_ERROR
标签设置为 YES
,则 Doxygen 将为文档中的潜在错误生成警告,例如在已记录的函数中记录某些参数两次,或者记录不存在的参数或错误地使用标记命令。
默认值是:YES
。
WARN_IF_INCOMPLETE_DOC
如果 WARN_IF_INCOMPLETE_DOC
设置为 YES
,则 Doxygen 将警告函数参数文档不完整。如果设置为 NO
,则 Doxygen 将接受某些参数没有文档而不会发出警告。
默认值是:YES
。
WARN_NO_PARAMDOC
可以启用此 WARN_NO_PARAMDOC
选项,以获取已记录但没有参数或返回值文档的函数的警告。如果设置为 NO
,则 Doxygen 将仅警告错误的参数文档,而不警告缺少文档。如果 EXTRACT_ALL 设置为 YES
,则此标志将自动禁用。另请参阅 WARN_IF_INCOMPLETE_DOC。
默认值是:NO
。
WARN_IF_UNDOC_ENUM_VAL
如果 WARN_IF_UNDOC_ENUM_VAL
选项设置为 YES
,则 Doxygen 将警告未记录的枚举值。如果设置为 NO
,则 Doxygen 将接受未记录的枚举值。如果 EXTRACT_ALL 设置为 YES
,则此标志将自动禁用。
默认值是:NO
。
WARN_AS_ERROR
如果 WARN_AS_ERROR
标签设置为 YES
,则 Doxygen 在遇到警告时将立即停止。如果 WARN_AS_ERROR
标签设置为 FAIL_ON_WARNINGS
,则 Doxygen 将继续运行,就像 WARN_AS_ERROR
标签设置为 NO
一样,但在 Doxygen 进程结束时,Doxygen 将返回非零状态。如果 WARN_AS_ERROR
标签设置为 FAIL_ON_WARNINGS_PRINT
,则 Doxygen 的行为类似于 FAIL_ON_WARNINGS
,但如果未定义 WARN_LOGFILE,则 Doxygen 不会在其他消息之间写入警告消息,而是在运行结束时写入警告消息,如果定义了 WARN_LOGFILE,则警告消息除了在定义的文件中之外,还将在运行结束时显示,除非 WARN_LOGFILE 定义为 -
,即标准输出 (stdout
),在这种情况下,行为将与设置 FAIL_ON_WARNINGS
保持一致。
可能的值为:NO
、YES
、FAIL_ON_WARNINGS
和 FAIL_ON_WARNINGS_PRINT
。
默认值是:NO
。
WARN_FORMAT
WARN_FORMAT
标签确定 Doxygen 可以生成的警告消息的格式。字符串应包含 $file
、$line
和 $text
标签,这些标签将替换为警告的来源文件和行号以及警告文本。可选地,格式可能包含 $version
,它将被替换为文件的版本(如果可以通过 FILE_VERSION_FILTER 获取)。
默认值为:$file:$line: $text
。
WARN_LINE_FORMAT
在 WARN_FORMAT 命令的 $text
部分中,可能会给出对更具体位置的引用。为了更容易跳转到此位置(在 Doxygen 之外),用户可以定义自定义的“剪切”/“粘贴”字符串。
示例
WARN_LINE_FORMAT = "'vi $file +$line'"
默认值为:at line $line of file $file
。
WARN_LOGFILE
WARN_LOGFILE
标签可用于指定应将警告和错误消息写入的文件。如果留空,则输出将写入标准错误 (stderr
)。如果指定的文件无法打开进行写入,则警告和错误消息将写入标准错误。当指定文件 -
时,警告和错误消息将写入标准输出 (stdout
)。
INPUT
INPUT
标签用于指定包含文档化源文件的文件和/或目录。您可以输入文件名(例如 myfile.cpp
)或目录(例如 /usr/src/myproject
)。用空格分隔文件或目录。另请参阅 FILE_PATTERNS 和 EXTENSION_MAPPING
INPUT_ENCODING
此标签可用于指定 Doxygen 解析的源文件的字符编码。Doxygen 内部使用 UTF-8 编码。Doxygen 使用 libiconv
(或内置于 libc
中的 iconv
)进行转码。有关可能的编码列表,请参阅 libiconv 文档。
默认值为:UTF-8
。
INPUT_FILE_ENCODING
此标签可用于指定 Doxygen 解析的源文件的字符编码。INPUT_FILE_ENCODING
标签可用于指定每个文件模式的字符编码。Doxygen 会将文件名与每个模式进行比较,如果匹配,则应用该编码而不是默认的 INPUT_ENCODING。字符编码是以下形式的列表:pattern=encoding(例如 *.php=ISO-8859-1
)。
FILE_PATTERNS
如果 INPUT 标签的值包含目录,您可以使用 FILE_PATTERNS
标签来指定一个或多个通配符模式(例如 *.cpp
和 *.h
)来过滤目录中的源文件。
请注意,对于自定义扩展名或不直接支持的扩展名,您还需要为该扩展名设置 EXTENSION_MAPPING,否则 Doxygen 不会读取这些文件。
请注意,默认检查的文件模式列表可能与默认文件扩展名映射列表不同。
如果留空,则会测试以下模式:*.c
、*.cc
、*.cxx
、*.cxxm
、*.cpp
、*.cppm
、*.ccm
、*.c++
、*.c++m
、*.java
、*.ii
、*.ixx
、*.ipp
、*.i++
、*.inl
、*.idl
、*.ddl
、*.odl
、*.h
、*.hh
、*.hxx
、*.hpp
、*.h++
、*.ixx
、*.l
、*.cs
、*.d
、*.php
、*.php4
、*.php5
、*.phtml
、*.inc
、*.m
、*.markdown
、*.md
、*.mm
、*.dox
(作为 Doxygen C 注释提供)、*.py
、*.pyw
、*.f90
、*.f95
、*.f03
、*.f08
、*.f18
、*.f
、*.for
、*.vhd
、*.vhdl
、*.ucf
、*.qsf
和 *.ice
。
RECURSIVE
RECURSIVE
标签可用于指定是否也应在子目录中搜索输入文件。
默认值是:NO
。
EXCLUDE
EXCLUDE
标签可用于指定应从 INPUT 源文件中排除的文件和/或目录。这样,您可以轻松地从目录树中排除一个子目录,该目录树的根目录由 INPUT 标签指定。
请注意,相对路径是相对于运行 Doxygen 的目录的路径。
EXCLUDE_SYMLINKS
EXCLUDE_SYMLINKS
标签可用于选择是否从输入中排除作为符号链接(Unix 文件系统功能)的文件或目录。
默认值是:NO
。
EXCLUDE_PATTERNS
如果 INPUT 标签的值包含目录,您可以使用 EXCLUDE_PATTERNS
标签来指定一个或多个通配符模式,以从这些目录中排除某些文件。
请注意,通配符是与绝对路径的文件匹配的,因此要排除所有测试目录,例如,请使用模式 *
/test/
*
EXCLUDE_SYMBOLS
EXCLUDE_SYMBOLS
标签可用于指定一个或多个应从输出中排除的符号名称(命名空间、类、函数等)。符号名称可以是完全限定的名称、一个词,或者如果使用了通配符 *
,则可以是子字符串。例如:ANamespace
、AClass
、ANamespace::AClass
、ANamespace::*Test
EXAMPLE_PATH
EXAMPLE_PATH
标签可用于指定一个或多个包含要包含的示例代码片段的文件或目录(请参阅 \include 命令)。
EXAMPLE_PATTERNS
如果 EXAMPLE_PATH 标签的值包含目录,您可以使用 EXAMPLE_PATTERNS
标签来指定一个或多个通配符模式(例如 *.cpp
和 *.h
)来过滤目录中的源文件。如果留空,则包含所有文件。
EXAMPLE_RECURSIVE
如果 EXAMPLE_RECURSIVE
标签设置为 YES
,则将搜索子目录以查找要与 \include 或 \dontinclude 命令一起使用的输入文件,而不管 RECURSIVE 标签的值如何。
默认值是:NO
。
IMAGE_PATH
IMAGE_PATH
标签可用于指定一个或多个包含要包含在文档中的图像的文件或目录(请参阅 \image 命令)。
INPUT_FILTER
INPUT_FILTER
标签可用于指定 Doxygen 应该为每个输入文件调用以进行过滤的程序。Doxygen 将通过执行(通过 popen()
)命令来调用过滤程序
<filter> <input-file>
其中 <filter>
是 INPUT_FILTER
标签的值,而 <input-file>
是输入文件的名称。然后,Doxygen 将使用过滤程序写入标准输出的输出。如果指定了 FILTER_PATTERNS,则此标签将被忽略。
请注意,过滤器不得添加或删除行;它在扫描代码之前应用,而不是在生成输出代码时应用。如果添加或删除行,则锚点将不会正确放置。
请注意,Doxygen 将使用处理并写入标准输出的数据进行进一步处理,因此不应将其他任何内容(如调试语句或使用的命令(因此在 Windows 批处理文件的情况下,始终使用 @echo OFF
))写入标准输出。
请注意,对于自定义扩展名或不直接支持的扩展名,您还需要为该扩展名设置 EXTENSION_MAPPING,否则 Doxygen 不会正确处理这些文件。
FILTER_PATTERNS
FILTER_PATTERNS
标签可用于在每个文件模式的基础上指定过滤器。Doxygen 会将文件名与每个模式进行比较,如果匹配,则应用过滤器。过滤器是以下形式的列表:模式=过滤器(例如 *.cpp=my_cpp_filter
)。有关如何使用过滤器的更多信息,请参阅 INPUT_FILTER。如果 FILTER_PATTERNS
标签为空,或者如果没有模式与文件名匹配,则会应用 INPUT_FILTER。
请注意,对于自定义扩展名或不直接支持的扩展名,您还需要为该扩展名设置 EXTENSION_MAPPING,否则 Doxygen 不会正确处理这些文件。
FILTER_SOURCE_FILES
如果 FILTER_SOURCE_FILES
标签设置为 YES
,则输入过滤器(如果使用 INPUT_FILTER 设置)也将用于过滤用于生成要浏览的源文件的输入文件(即,当 SOURCE_BROWSER 设置为 YES
时)。
默认值是:NO
。
FILTER_SOURCE_PATTERNS
FILTER_SOURCE_PATTERNS
标签可用于按文件模式指定源过滤器。模式将覆盖 FILTER_PATTERN 的设置(如果有),并且还可以使用 *.ext=
(因此不命名过滤器)为特定模式禁用源过滤。
此标签要求将标签 FILTER_SOURCE_FILES 设置为 YES
。
USE_MDFILE_AS_MAINPAGE
如果 USE_MDFILE_AS_MAINPAGE
标签引用了作为输入一部分的 Markdown 文件的名称,则其内容将放置在主页(index.html
)上。如果您在 GitHub 上有一个项目,并且希望将介绍页面也用于 Doxygen 输出,这将非常有用。
IMPLICIT_DIR_DOCS
如果 IMPLICIT_DIR_DOCS
标签设置为 YES
,则在项目根目录的子目录中找到的任何 README.md
文件都将用作该子目录的文档,除非 README.md
以 \dir、\page 或 \mainpage 命令开头。如果设置为 NO
,则 README.md
文件需要以显式 \dir 命令开头才能用作目录文档。
默认值是:YES
。
FORTRAN_COMMENT_AFTER
Fortran 标准指定,对于固定格式的 Fortran 代码,从第 72 位起的所有字符都被视为注释。一种常见的扩展是允许在自动注释开始之前使用更长的行。设置 FORTRAN_COMMENT_AFTER
也将使在自动注释开始之前可以处理更长的行。
最小值:7
,最大值:10000
,默认值:72
。
SOURCE_BROWSER
如果 SOURCE_BROWSER
标签设置为 YES
,则会生成源文件列表。文档化的实体将与这些源文件交叉引用。
注意:要删除生成的输出中的所有源代码,请确保还将 VERBATIM_HEADERS 设置为 NO
。
默认值是:NO
。
INLINE_SOURCES
将 INLINE_SOURCES
标签设置为 YES
将函数、多行宏、枚举或列表初始化变量的主体直接包含到文档中。
默认值是:NO
。
STRIP_CODE_COMMENTS
将 STRIP_CODE_COMMENTS
标签设置为 YES
将指示 Doxygen 从生成的源代码片段中隐藏任何特殊的注释块。普通的 C、C++ 和 Fortran 注释将始终保持可见。
默认值是:YES
。
REFERENCED_BY_RELATION
如果 REFERENCED_BY_RELATION
标签设置为 YES
,则对于每个文档化的实体,将列出引用它的所有文档化函数。
默认值是:NO
。
REFERENCES_RELATION
如果 REFERENCES_RELATION
标签设置为 YES
,则对于每个文档化的函数,将列出该函数调用/使用的所有文档化实体。
默认值是:NO
。
REFERENCES_LINK_SOURCE
如果 REFERENCES_LINK_SOURCE
标签设置为 YES
并且 SOURCE_BROWSER 标签设置为 YES
,则 REFERENCES_RELATION 和 REFERENCED_BY_RELATION 列表中的函数的超链接将链接到源代码。否则,它们将链接到文档。
默认值是:YES
。
SOURCE_TOOLTIPS
如果启用 SOURCE_TOOLTIPS
(默认设置),则将鼠标悬停在源代码中的超链接上时,将显示一个带有其他信息的工具提示,例如原型、简短描述以及指向定义和文档的链接。由于这将使 HTML 文件更大,并且加载大型文件的速度稍慢,因此您可以选择禁用此功能。
默认值是:YES
。
此标签要求将标签 SOURCE_BROWSER 设置为 YES
。
USE_HTAGS
如果 USE_HTAGS
标签设置为 YES
,则对源代码的引用将指向由 htags(1)
工具生成的 HTML,而不是 Doxygen 内置的源代码浏览器。htags
工具是 GNU 全局源代码标记系统的一部分(请参阅 https://gnu.ac.cn/software/global/global.html)。您将需要 4.8.6 或更高版本。
要使用它,请执行以下操作
global
USE_HTAGS
doxygen
htags
(而 htags
又会调用 gtags
),因此这些工具必须可以通过命令行访问(即在搜索路径中)。htags
的输出。默认值是:NO
。
此标签要求将标签 SOURCE_BROWSER 设置为 YES
。
VERBATIM_HEADERS
如果将 VERBATIM_HEADERS
标签设置为 YES
,则 Doxygen 将为每个指定了包含文件的类生成头文件的逐字副本。设置为 NO
以禁用此功能。
默认值是:YES
。
CLANG_ASSISTED_PARSING
如果将 CLANG_ASSISTED_PARSING
标签设置为 YES
,则 Doxygen 将使用 clang 解析器进行更精确的解析,但代价是性能降低。这对于模板丰富的 C++ 代码特别有用,因为 Doxygen 的内置解析器缺少必要的类型信息。
-Duse_libclang=ON
选项生成。默认值是:NO
。
CLANG_ADD_INC_PATHS
如果将 CLANG_ASSISTED_PARSING
标签设置为 YES
且将 CLANG_ADD_INC_PATHS
标签设置为 YES
,则 Doxygen 将把每个输入的目录添加到包含路径中。
默认值是:YES
。
此标签要求将标签 CLANG_ASSISTED_PARSING 设置为 YES
。
CLANG_OPTIONS
如果启用了 clang 辅助解析,您可以为编译器提供通常在调用编译器时使用的命令行选项。请注意,Doxygen 已经为使用 INPUT 和 INCLUDE_PATH 指定的文件和目录设置了包含路径。
此标签要求将标签 CLANG_ASSISTED_PARSING 设置为 YES
。
CLANG_DATABASE_PATH
如果启用了 clang 辅助解析,您可以为 clang 解析器提供包含名为 compile_commands.json
的文件的目录路径。此文件是编译数据库,其中包含构建源文件时使用的选项。这等效于为 clang 工具(例如 clang-check
)指定 -p
选项。然后,这些选项将传递给解析器。使用 CLANG_OPTIONS 指定的任何选项也将被添加。
-Duse_libclang=ON
选项生成。ALPHABETICAL_INDEX
如果将 ALPHABETICAL_INDEX
标签设置为 YES
,则会生成所有化合物的字母索引。如果项目包含大量类、结构、联合或接口,则启用此选项。
默认值是:YES
。
IGNORE_PREFIX
IGNORE_PREFIX
标签可用于指定在生成索引标题时应忽略的前缀(或前缀列表)。IGNORE_PREFIX
标签适用于类、函数和成员名称。该实体将放置在字母列表中,其前缀移除后剩余的实体名称的首字母下。
此标签要求将标签 ALPHABETICAL_INDEX 设置为 YES
。
GENERATE_HTML
如果将 GENERATE_HTML
标签设置为 YES
,则 Doxygen 将生成 HTML 输出
默认值是:YES
。
HTML_OUTPUT
HTML_OUTPUT
标签用于指定 HTML 文档的放置位置。如果输入相对路径,则 OUTPUT_DIRECTORY 的值将置于其前面。
默认目录为:html
。
此标签要求将标签 GENERATE_HTML 设置为 YES
。
HTML_FILE_EXTENSION
HTML_FILE_EXTENSION
标签可用于指定每个生成的 HTML 页面的文件扩展名(例如:.htm、.php、.asp
)。
默认值为:.html
。
此标签要求将标签 GENERATE_HTML 设置为 YES
。
HTML_HEADER
HTML_HEADER
标签可用于为每个生成的 HTML 页面指定用户定义的 HTML 标题文件。如果标签留空,则 Doxygen 将生成标准标题。
要获得有效的 HTML,标题文件必须包含 Doxygen 需要的任何脚本和样式表,这取决于所使用的配置选项(例如,设置 GENERATE_TREEVIEW)。强烈建议使用
doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
中的默认标题开始,然后修改文件 new_header.html
。
另请参阅章节 Doxygen 用法,了解如何生成 Doxygen 通常使用的默认标题。
$title
$datetime
$date
$time
$year
$showdate(<format>)
<format>
指定的格式替换为当前日期和时间。 <format>
遵循为 \showdate 命令指定的规则,但 <format>
中不允许出现 )
。$doxygenversion
$projectname
$projectnumber
$projectbrief
$projectlogo
$generatedby
$projectname
生成于 $datetime
”的输出语言相关版本时。$stylesheet
doxygen.css
。$extrastylesheet
$treeview
$search
$searchbox
$mathjax
$relpath^
$relpath^
生成 HTML 输出目录根目录的相对路径,例如,使用 $relpath^doxygen.css
来引用标准样式表。$navpath
为了处理标题和页脚布局的差异(这取决于配置设置),标题还可以包含特殊块,这些特殊块将根据配置复制到输出或跳过。此类块具有以下形式
<!--BEGIN BLOCKNAME--> Some context copied when condition BLOCKNAME holds <!--END BLOCKNAME--> <!--BEGIN !BLOCKNAME--> Some context copied when condition BLOCKNAME does not hold <!--END !BLOCKNAME-->
支持以下块名称
DISABLE_INDEX
GENERATE_TREEVIEW
SEARCHENGINE
PROJECT_NAME
PROJECT_NUMBER
PROJECT_BRIEF
PROJECT_LOGO
FULL_SIDEBAR
TITLEAREA
此标签要求将标签 GENERATE_HTML 设置为 YES
。
HTML_FOOTER
HTML_FOOTER
标签可用于为每个生成的 HTML 页面指定用户定义的 HTML 页脚。如果该标签留空,Doxygen 将生成标准页脚。
有关如何生成默认页脚以及页脚内可以使用哪些特殊命令的更多信息,请参阅 HTML_HEADER。
另请参阅 Doxygen 使用部分,了解如何生成 Doxygen 通常使用的默认页脚。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_STYLESHEET
HTML_STYLESHEET
标签可用于指定每个 HTML 页面使用的用户定义的层叠样式表。它可用于微调 HTML 输出的外观。如果留空,Doxygen 将生成默认样式表。
另请参阅 Doxygen 使用部分,了解如何生成 Doxygen 通常使用的样式表。
HTML_STYLESHEET
) 将在未来被弃用。此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_EXTRA_STYLESHEET
HTML_EXTRA_STYLESHEET
标签可用于指定在 Doxygen 创建的标准样式表之后包含的其他用户定义的层叠样式表。使用此选项可以覆盖某些样式方面。这比使用 HTML_STYLESHEET 更可取,因为它不会替换标准样式表,因此对未来的更新更健壮。Doxygen 会将样式表文件复制到输出目录。body { background-color: #CCC; color: black; margin: 0; } div.contents { margin-bottom: 10px; padding: 12px; margin-left: auto; margin-right: auto; width: 960px; background-color: white; border-radius: 8px; } #titlearea { background-color: white; } hr.footer { display: none; } .footer { background-color: #AAA; }
YES
。HTML_EXTRA_FILES
HTML_EXTRA_FILES
标签可用于指定一个或多个额外的图像或其他源文件,这些文件应复制到 HTML 输出目录。请注意,这些文件将复制到基本 HTML 输出目录。在 HTML_HEADER 和/或 HTML_FOOTER 文件中使用 $relpath^
标记来加载这些文件。在 HTML_STYLESHEET 文件中,仅使用文件名。另请注意,这些文件将按原样复制;没有可用的命令或标记。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_COLORSTYLE
HTML_COLORSTYLE
标签可用于指定生成的 HTML 输出应使用深色主题还是浅色主题呈现。
可能的值为:LIGHT
始终生成浅色模式输出,DARK
始终生成深色模式输出,AUTO_LIGHT
根据用户首选项自动设置模式,如果没有设置首选项则使用浅色模式(默认值),AUTO_DARK
根据用户首选项自动设置模式,如果没有设置首选项则使用深色模式,TOGGLE
允许用户通过按钮在浅色模式和深色模式之间切换。
默认值为:AUTO_LIGHT
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_COLORSTYLE_HUE
HTML_COLORSTYLE_HUE
标签控制 HTML 输出的颜色。Doxygen 将根据此颜色调整样式表和背景图像中的颜色。色调指定为色轮上的一个角度,有关更多信息,请参阅 https://en.wikipedia.org/wiki/Hue。例如,值 0 表示红色,60 表示黄色,120 表示绿色,180 表示青色,240 表示蓝色,300 表示紫色,360 再次表示红色。
最小值:0
,最大值:359
,默认值:220
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_COLORSTYLE_SAT
HTML_COLORSTYLE_SAT
标签控制 HTML 输出中颜色的纯度(或饱和度)。对于值为 0 的情况,输出将仅使用灰度。值为 255 将产生最鲜艳的颜色。
最小值:0
,最大值:255
,默认值:100
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_COLORSTYLE_GAMMA
HTML_COLORSTYLE_GAMMA
标签控制应用于 HTML 输出中颜色亮度分量的伽玛校正。低于 100 的值会逐渐使输出变亮,而高于 100 的值会使输出变暗。该值除以 100 是应用的实际伽玛值,因此 80 表示伽玛值为 0.8,220 表示伽玛值为 2.2,而 100 不会更改伽玛值。
最小值:40
,最大值:240
,默认值:80
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_DYNAMIC_MENUS
如果将 HTML_DYNAMIC_MENUS
标签设置为 YES
,则生成的 HTML 文档将包含一个主索引,其中包含通过 JavaScript 动态创建的垂直导航菜单。如果禁用,则导航索引将由静态嵌入到每个 HTML 页面中的多个级别的选项卡组成。禁用此选项以支持没有 JavaScript 的浏览器,例如 Qt 帮助浏览器。
默认值是:YES
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_DYNAMIC_SECTIONS
如果将 HTML_DYNAMIC_SECTIONS
标签设置为 YES
,则生成的 HTML 文档将包含可以在页面加载后隐藏和显示的节。
默认值是:NO
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_CODE_FOLDING
如果将 HTML_CODE_FOLDING
标签设置为 YES
,则可以在生成的 HTML 源代码中动态折叠和展开类和函数。
默认值是:YES
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_COPY_CLIPBOARD
如果将 HTML_COPY_CLIPBOARD
标签设置为 YES
,则 Doxygen 将在代码和文本片段的右上角显示一个图标,允许用户将其内容复制到剪贴板。请注意,这仅在浏览器支持并且网页通过 安全上下文 提供时才有效,即使用 https: 或 file: 协议。
默认值是:YES
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_PROJECT_COOKIE
Doxygen 会将一些设置持久存储在浏览器中(例如,通过 cookie)。默认情况下,这些设置适用于 Doxygen 在所有项目中生成的所有 HTML 页面。HTML_PROJECT_COOKIE
标签可用于将设置存储在项目特定的键下,以便用户首选项将单独存储。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_INDEX_NUM_ENTRIES
使用 HTML_INDEX_NUM_ENTRIES
可以控制各种树状结构索引最初显示的条目首选数量;用户稍后可以动态展开和折叠条目。Doxygen 将树展开到这样的级别,以使最多指定数量的条目可见(除非完全折叠的树已经超过此数量)。因此,将条目数设置为 1 将默认生成一个完全折叠的树。0 是表示无限数量条目的特殊值,默认情况下将生成一个完全展开的树。
最小值:0
,最大值:9999
,默认值:100
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
GENERATE_DOCSET
如果将 GENERATE_DOCSET
标签设置为 YES
,则会生成额外的索引文件,这些文件可用作 Apple 的 Xcode 3 集成开发环境的输入,该环境随 OSX 10.5 (Leopard) 引入。要创建文档集,Doxygen 将在 HTML 输出目录中生成一个 Makefile。运行 make
将在该目录中生成文档集,运行 make install
将文档集安装在 ~/Library/Developer/Shared/Documentation/DocSets
中,以便 Xcode 在启动时找到它。有关更多信息,请参阅 https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html。
默认值是:NO
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
DOCSET_FEEDNAME
此标签确定文档集提要的名称。文档提要提供了一个保护伞,可以在其中对来自单个提供商(例如公司或产品套件)的多个文档集进行分组。
默认值为:Doxygen generated docs
。
此标签要求将 GENERATE_DOCSET 标签设置为 YES
。
DOCSET_FEEDURL
此标签确定文档集提要的 URL。文档提要提供了一个保护伞,可以在其中对来自单个提供商(例如公司或产品套件)的多个文档集进行分组。
此标签要求将 GENERATE_DOCSET 标签设置为 YES
。
DOCSET_BUNDLE_ID
此标签指定一个字符串,该字符串应唯一标识文档集包。这应该是一个反向域名样式字符串,例如 com.mycompany.MyDocSet
。Doxygen 将 .docset
附加到名称。
默认值为:org.doxygen.Project
。
此标签要求将 GENERATE_DOCSET 标签设置为 YES
。
DOCSET_PUBLISHER_ID
DOCSET_PUBLISHER_ID
标签指定一个字符串,该字符串应唯一标识文档发布者。这应该是一个反向域名样式字符串,例如 com.mycompany.MyDocSet.documentation
。
默认值为:org.doxygen.Publisher
。
此标签要求将 GENERATE_DOCSET 标签设置为 YES
。
DOCSET_PUBLISHER_NAME
DOCSET_PUBLISHER_NAME
标签标识文档发布者。
默认值为:Publisher
。
此标签要求将 GENERATE_DOCSET 标签设置为 YES
。
GENERATE_HTMLHELP
如果 GENERATE_HTMLHELP
标签设置为 YES
,Doxygen 将生成三个额外的 HTML 索引文件:index.hhp
、index.hhc
和 index.hhk
。index.hhp
是一个项目文件,可以被 Windows 上的 Microsoft HTML Help Workshop 读取。在 2021 年初,微软将包含下载链接的原始页面下线了(HTML Help Workshop 已经多年处于维护模式)。您可以从网络存档下载 HTML Help Workshop 的安装可执行文件。
HTML Help Workshop 包含一个编译器,可以将 Doxygen 生成的所有 HTML 输出转换为一个单独的编译后的 HTML 文件(.chm
)。编译后的 HTML 文件现在用作 Windows 98 的帮助格式,并且将来会在所有 Windows 平台上取代旧的 Windows 帮助格式(.hlp
)。压缩的 HTML 文件还包含索引、目录,并且您可以在文档中搜索单词。HTML Workshop 还包含一个压缩 HTML 文件的查看器。
默认值是:NO
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
CHM_FILE
CHM_FILE
标签可用于指定生成的 .chm
文件的文件名。如果结果不应写入 HTML 输出目录,则可以在文件名前面添加路径。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
HHC_LOCATION
HHC_LOCATION
标签可用于指定 HTML Help 编译器(hhc.exe
)的位置(包括文件名的绝对路径)。如果非空,Doxygen 将尝试在生成的 index.hhp
上运行 HTML Help 编译器。
该文件必须使用完整路径指定。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
GENERATE_CHI
GENERATE_CHI
标志控制是否生成单独的 .chi
索引文件 (YES
),或者是否将其包含在主 .chm
文件中 (NO
)。
默认值是:NO
。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
CHM_INDEX_ENCODING
CHM_INDEX_ENCODING
用于编码 HtmlHelp 索引(hhk
)、内容(hhc
)和项目文件内容。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
BINARY_TOC
BINARY_TOC
标志控制是否在 .chm
文件中生成二进制目录 (YES
) 还是普通目录 (NO
)。此外,它还会启用“上一个”和“下一个”按钮。
默认值是:NO
。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
TOC_EXPAND
可以将 TOC_EXPAND
标志设置为 YES
,以便将组员的额外项添加到 HTML 帮助文档的目录和树视图中。
默认值是:NO
。
此标签要求标签 GENERATE_HTMLHELP 设置为 YES
。
SITEMAP_URL
SITEMAP_URL
标签用于指定用户在部署文档期间将生成的文档放置在服务器上的完整 URL。生成的站点地图名为 sitemap.xml
,并放置在 HTML_OUTPUT 指定的目录中。如果没有指定 SITEMAP_URL
,则不会生成站点地图。有关站点地图协议的信息,请参阅 https://www.sitemaps.org。
此标签要求标签 GENERATE_HTML 设置为 YES
。
GENERATE_QHP
如果 GENERATE_QHP
标签设置为 YES
,并且 QHP_NAMESPACE 和 QHP_VIRTUAL_FOLDER 都已设置,则将生成一个额外的索引文件,该文件可用作 Qt 的 qhelpgenerator 的输入,以生成生成的 HTML 文档的 Qt 压缩帮助(.qch
)。
默认值是:NO
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
QCH_FILE
如果指定了 QHG_LOCATION 标签,则可以使用 QCH_FILE
标签来指定生成的 .qch
文件的文件名。指定的路径相对于 HTML 输出文件夹。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHP_NAMESPACE
QHP_NAMESPACE
标签指定生成 Qt 帮助项目输出时要使用的命名空间。有关更多信息,请参阅 Qt 帮助项目 / 命名空间。
默认值为:org.doxygen.Project
。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHP_VIRTUAL_FOLDER
QHP_VIRTUAL_FOLDER
标签指定生成 Qt 帮助项目输出时要使用的命名空间。有关更多信息,请参阅 Qt 帮助项目 / 虚拟文件夹。
默认值为:doc
。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHP_CUST_FILTER_NAME
如果设置了 QHP_CUST_FILTER_NAME
标签,则它指定要添加的自定义筛选器的名称。有关更多信息,请参阅 Qt 帮助项目 / 自定义筛选器。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHP_CUST_FILTER_ATTRS
QHP_CUST_FILTER_ATTRS
标签指定要添加的自定义筛选器的属性列表。有关更多信息,请参阅 Qt 帮助项目 / 自定义筛选器。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHP_SECT_FILTER_ATTRS
QHP_SECT_FILTER_ATTRS
标签指定此项目的筛选器部分匹配的属性列表。Qt 帮助项目 / 筛选器属性。
此标签要求标签 GENERATE_QHP 设置为 YES
。
QHG_LOCATION
QHG_LOCATION
标签可用于指定 Qt 的 qhelpgenerator 的位置(包括文件名的绝对路径)。如果非空,Doxygen 将尝试在生成的 .qhp
文件上运行 qhelpgenerator。
此标签要求标签 GENERATE_QHP 设置为 YES
。
GENERATE_ECLIPSEHELP
如果 GENERATE_ECLIPSEHELP
标签设置为 YES
,则将生成额外的索引文件,它们与 HTML 文件一起构成一个 Eclipse
帮助插件。
要安装此插件并使其在 Eclipse
中的帮助内容菜单下可用,需要将包含 HTML 和 XML 文件的目录的内容复制到 Eclipse 的 plugins 目录中。plugins 目录中的目录名称应与 ECLIPSE_DOC_ID 值相同。
复制后,需要重新启动 Eclipse
,帮助才会出现。
默认值是:NO
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
ECLIPSE_DOC_ID
Eclipse
帮助插件的唯一标识符。安装插件时,包含 HTML 和 XML 文件的目录名称也应具有此名称。每个文档集都应具有其自己的标识符。
默认值为:org.doxygen.Project
。
此标签要求标签 GENERATE_ECLIPSEHELP 设置为 YES
。
DISABLE_INDEX
如果您想完全控制生成的 HTML 页面的布局,则可能需要禁用索引并将其替换为您自己的索引。DISABLE_INDEX
标签可用于打开/关闭每个 HTML 页面顶部的压缩索引(选项卡)。值为 NO
会启用索引,而值 YES
会禁用索引。由于索引中的选项卡包含与导航树相同的信息,因此如果您还将 GENERATE_TREEVIEW 设置为 YES
,则可以将此选项设置为 YES
。
默认值是:YES
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
GENERATE_TREEVIEW
GENERATE_TREEVIEW
标签用于指定是否应生成类似树的索引结构来显示分层信息。如果标签值设置为 YES
,则将生成一个侧面板,其中包含类似树的索引结构(就像为 HTML Help 生成的结构一样)。为此,需要支持 JavaScript、DHTML、CSS 和框架的浏览器(即任何现代浏览器)。Windows 用户可能最好使用 HTML 帮助功能。
通过自定义样式表(请参阅 HTML_EXTRA_STYLESHEET),可以进一步微调索引的外观(请参阅 微调输出)。例如,Doxygen 生成的默认样式表有一个示例,该示例显示如何在树的根目录放置图像而不是 PROJECT_NAME。
由于树基本上具有与选项卡索引相同的信息,因此在启用此选项时,您可以考虑将 DISABLE_INDEX 设置为 YES
。
默认值是:YES
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
FULL_SIDEBAR
当 GENERATE_TREEVIEW 和 DISABLE_INDEX 都设置为 YES
时,FULL_SIDEBAR
选项确定侧边栏是否仅限于树视图区域(值 NO
),或者是否应扩展到窗口的完整高度(值 YES
)。将其设置为 YES
会提供类似于 https://docs.readthedocs.io 的布局,其中有更多空间用于内容,但项目徽标、标题和描述的空间更少。
如果 GENERATE_TREEVIEW 或 DISABLE_INDEX 设置为 NO
,则此选项无效。
默认值是:NO
。
此标签要求标签 GENERATE_HTML 设置为 YES
。
ENUM_VALUES_PER_LINE
ENUM_VALUES_PER_LINE
标签可用于设置 Doxygen 在生成的 HTML 文档中,每行显示多少个枚举值。
请注意,值为 0 将完全禁止枚举值出现在概览部分中。
最小值:0
,最大值:20
,默认值:4
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
SHOW_ENUM_VALUES
当 SHOW_ENUM_VALUES
标签被设置时,Doxygen 将在枚举助记符旁边显示指定的枚举值。
默认值是:NO
。
TREEVIEW_WIDTH
如果启用了树状视图(请参阅 GENERATE_TREEVIEW),则可以使用此标签设置显示树状视图的框架的初始宽度(以像素为单位)。
最小值:0
,最大值:1500
,默认值:250
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
EXT_LINKS_IN_WINDOW
如果将 EXT_LINKS_IN_WINDOW
选项设置为 YES
,则 Doxygen 将在单独的窗口中打开通过标签文件导入的外部符号的链接。
默认值是:NO
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
OBFUSCATE_EMAILS
如果将 OBFUSCATE_EMAILS
标签设置为 YES
,则 Doxygen 将混淆电子邮件地址。
默认值是:YES
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
HTML_FORMULA_FORMAT
如果将 HTML_FORMULA_FORMAT
选项设置为 svg
,Doxygen 将使用 pdf2svg 工具(请参阅 https://github.com/dawbarton/pdf2svg)或 inkscape(请参阅 https://inkscape.org)来生成公式作为 SVG 图像,而不是 HTML 输出的 PNG 图像。这些图像在缩放分辨率下通常看起来更好。
可能的值为:png
(默认值)和 svg
(看起来更好,但需要 pdf2svg 或 inkscape 工具)。
默认值为:png
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
FORMULA_FONTSIZE
使用此标签更改 HTML 文档中作为图像包含的 公式字体大小。在 Doxygen 成功运行后更改字体大小时,您需要手动删除 HTML 输出目录中的任何
form_*.png
图像,以强制它们重新生成。
最小值:8
,最大值:50
,默认值:10
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
FORMULA_MACROFILE
FORMULA_MACROFILE
可以包含
\newcommand
和 \renewcommand
命令,以创建新的 命令,在公式中用作构建块。有关详细信息,请参阅包含公式部分。
USE_MATHJAX
启用 USE_MATHJAX
选项以使用 MathJax 渲染 公式(请参阅 https://www.mathjax.org),它使用客户端 JavaScript 进行渲染,而不是使用预渲染的位图。如果您没有安装
或者如果您希望公式在 HTML 输出中看起来更漂亮,请使用此选项。启用后,您可能还需要单独安装 MathJax,并使用 MATHJAX_RELPATH 选项配置其路径。
默认值是:NO
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
MATHJAX_VERSION
使用 MATHJAX_VERSION
可以指定要使用的 MathJax 版本。请注意,不同版本的 MathJax 对不同的设置有不同的要求,因此在不同 MathJax 版本之间切换时,也可能需要更改其他 MathJax 设置。
可能的值为:MathJax_2
和 MathJax_3
。
默认值为:MathJax_2
。
此标签要求将 USE_MATHJAX 标签设置为 YES
。
MATHJAX_FORMAT
启用 MathJax 后,您可以设置用于 MathJax 输出的默认输出格式。有关输出格式的更多详细信息,请参阅 MathJax 版本 2 和 MathJax 版本 3。
可能的值为:HTML-CSS
(速度较慢,但兼容性最佳。这是 Mathjax 版本 2 的名称,对于 MathJax 版本 3,它将被转换为 chtml
)、NativeMML
(即 MathML。仅支持 MathJax 2。对于 MathJax 版本 3,将使用 chtml
代替)、chtml
(这是 Mathjax 版本 3 的名称,对于 MathJax 版本 2,它将被转换为 HTML-CSS
)和 SVG
。
默认值为:HTML-CSS
。
此标签要求将 USE_MATHJAX 标签设置为 YES
。
MATHJAX_RELPATH
启用 MathJax 后,您需要使用 MATHJAX_RELPATH
选项指定相对于 HTML 输出目录的位置。目标目录应包含 MathJax.js
脚本。例如,如果 mathjax
目录与 HTML 输出目录位于同一级别,则 MATHJAX_RELPATH
应为 ../mathjax
。默认值指向 MathJax 内容分发网络,因此您可以快速查看结果而无需安装 MathJax。但是,强烈建议在部署之前从 https://www.mathjax.org 安装 MathJax 的本地副本。
默认值为
此标签要求将 USE_MATHJAX 标签设置为 YES
。
MATHJAX_EXTENSIONS
MATHJAX_EXTENSIONS
标签可用于指定在 MathJax 渲染期间应启用的一个或多个 MathJax 扩展名。例如,对于 MathJax 版本 2(请参阅 https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions)
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
例如,对于 MathJax 版本 3(请参阅 http://docs.mathjax.org/en/latest/input/tex/extensions/index.html)
MATHJAX_EXTENSIONS = ams
此标签要求将 USE_MATHJAX 标签设置为 YES
。
MATHJAX_CODEFILE
MATHJAX_CODEFILE
标签可用于指定一个包含 JavaScript 代码片段的文件,这些代码片段将在 MathJax 代码启动时使用。有关更多详细信息,请参阅 MathJax 网站。例如,禁用 MathJax 的“数学设置”菜单中的“数学渲染器”菜单项
MATHJAX_CODEFILE = disableRenderer.js
在文件 disableRenderer.js
中
MathJax.Hub.Config({ menuSettings: { showRenderer: false, } });
此标签要求将 USE_MATHJAX 标签设置为 YES
。
SEARCHENGINE
启用 SEARCHENGINE
标签后,Doxygen 将为 HTML 输出生成一个搜索框。底层搜索引擎使用 JavaScript 和 DHTML,应该可以在任何现代浏览器上运行。请注意,当使用 HTML 帮助 (GENERATE_HTMLHELP)、Qt 帮助 (GENERATE_QHP) 或文档集 (GENERATE_DOCSET) 时,已经有一个搜索功能,因此通常应该禁用此功能。对于大型项目,基于 JavaScript 的搜索引擎可能会很慢,那么启用 SERVER_BASED_SEARCH 可能会提供更好的解决方案。
可以使用键盘进行搜索;要跳转到搜索框,请使用 <访问键> + S
(<访问键>
取决于操作系统和浏览器,但通常是 <CTRL>
、<ALT>
/<option>
,或两者都有)。在搜索框内,使用 <向下光标键>
跳转到搜索结果窗口,可以使用 <光标键>
导航结果。按 <Enter>
选择一个项目,或按 <escape>
取消搜索。当光标位于搜索框内时,可以通过按 <Shift>+<向下光标键>
选择筛选器选项。同样,此处使用 <光标键>
选择筛选器,并使用 <Enter>
或 <escape>
激活或取消筛选器选项。
默认值是:YES
。
此标签要求将 GENERATE_HTML 标签设置为 YES
。
SERVER_BASED_SEARCH
启用 SERVER_BASED_SEARCH
标签后,搜索引擎将使用 Web 服务器而不是使用 JavaScript 的 Web 客户端来实现。
根据 EXTERNAL_SEARCH 设置,有两种 Web 服务器搜索方式。禁用时,Doxygen 将生成一个用于搜索的 PHP 脚本和一个脚本使用的索引文件。启用 EXTERNAL_SEARCH 时,索引和搜索需要由外部工具提供。有关详细信息,请参阅外部索引和搜索部分。
默认值是:NO
。
此标签要求将 SEARCHENGINE 标签设置为 YES
。
EXTERNAL_SEARCH
当启用 EXTERNAL_SEARCH
标签时,Doxygen 将不再生成用于搜索的 PHP 脚本。相反,搜索结果会被写入一个 XML 文件,该文件需要由外部索引器处理。Doxygen 将调用 SEARCHENGINE_URL 选项指定的外部搜索引擎来获取搜索结果。
Doxygen 附带一个示例索引器 (doxyindexer
) 和搜索引擎 (doxysearch.cgi
),它们基于开源搜索引擎库 Xapian。
有关详细信息,请参阅 外部索引和搜索 部分。
默认值是:NO
。
此标签要求将 SEARCHENGINE 标签设置为 YES
。
SEARCHENGINE_URL
当启用 EXTERNAL_SEARCH 时,SEARCHENGINE_URL
应该指向由 Web 服务器托管的搜索引擎,该搜索引擎将返回搜索结果。
Doxygen 附带一个示例索引器 (doxyindexer
) 和搜索引擎 (doxysearch.cgi
),它们基于开源搜索引擎库 Xapian。有关详细信息,请参阅 外部索引和搜索 部分。
此标签要求将 SEARCHENGINE 标签设置为 YES
。
SEARCHDATA_FILE
当同时启用 SERVER_BASED_SEARCH 和 EXTERNAL_SEARCH 时,未索引的搜索数据会写入一个文件,以供外部工具索引。可以使用 SEARCHDATA_FILE
标签指定此文件的名称。
默认文件为:searchdata.xml
。
此标签要求将 SEARCHENGINE 标签设置为 YES
。
EXTERNAL_SEARCH_ID
当同时启用 SERVER_BASED_SEARCH 和 EXTERNAL_SEARCH 时,可以使用 EXTERNAL_SEARCH_ID
标签作为项目的标识符。这与 EXTRA_SEARCH_MAPPINGS 结合使用非常有用,可以搜索多个项目并将结果重定向到正确的项目。
此标签要求将 SEARCHENGINE 标签设置为 YES
。
EXTRA_SEARCH_MAPPINGS
EXTRA_SEARCH_MAPPINGS
标签可用于启用搜索除此配置文件定义的 Doxygen 项目之外的其他 Doxygen 项目,但这些项目都添加到同一个外部搜索索引中。每个项目都需要通过 EXTERNAL_SEARCH_ID 设置唯一的 ID。然后,搜索映射会将 ID 映射到可以找到文档的相对位置。
格式为
EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
此标签要求将 SEARCHENGINE 标签设置为 YES
。
GENERATE_LATEX
如果将 GENERATE_LATEX
标签设置为 YES
,则 Doxygen 将生成 输出。
默认值是:YES
。
LATEX_OUTPUT
LATEX_OUTPUT
标签用于指定 文档的存放位置。如果输入相对路径,则会在前面加上 OUTPUT_DIRECTORY 的值。
默认目录为:latex
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_CMD_NAME
LATEX_CMD_NAME
标签可用于指定要调用的 命令名称。
请注意,当不启用 USE_PDFLATEX 时,默认值为 latex
;当启用 USE_PDFLATEX 时,默认值为 pdflatex
;而在后一种情况下,如果选择 latex
,则会被 pdflatex
覆盖。对于特定的输出语言,默认值可能设置不同,这取决于输出语言的实现。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
MAKEINDEX_CMD_NAME
MAKEINDEX_CMD_NAME
标签可用于指定为 生成索引的命令名称。
Makefile
/ make.bat
中。.tex
) 中的部分。默认文件为:makeindex
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_MAKEINDEX_CMD
LATEX_MAKEINDEX_CMD
标签可用于指定为 生成索引的命令名称。如果第一个字符不是反斜杠 (
\
),则会在 代码中自动添加。
.tex
) 中。Makefile
/ make.bat
中的部分。默认值为:makeindex
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
COMPACT_LATEX
如果将 COMPACT_LATEX
标签设置为 YES
,则 Doxygen 会生成更紧凑的 文档。这对于小型项目可能很有用,并且通常有助于节省一些树木。
默认值是:NO
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
PAPER_TYPE
可能的值为:a4
(210 x 297 mm)、letter
(8.5 x 11 英寸)、legal
(8.5 x 14 英寸) 和 executive
(7.25 x 10.5 英寸)。
默认值为:a4
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
EXTRA_PACKAGES
EXTRA_PACKAGES
标签可用于指定一个或多个 包名称,这些包名称应包含在
输出中。可以通过包的名称来指定包,也可以使用与
\usepackage
命令一起使用的正确语法来指定包。
例如,要获取 times
字体,可以指定
EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
要将选项 intlimits
与 amsmath
包一起使用,可以指定
EXTRA_PACKAGES=[intlimits]{amsmath}
如果留空,则不会包含任何额外的包。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_HEADER
LATEX_HEADER
标签可用于为生成的 文档指定用户定义的
标头。标头应包含到第一章之前的所有内容。如果留空,Doxygen 将生成一个标准标头。
强烈建议使用以下命令开始使用默认标头
doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
然后修改文件 new_header.tex
。
另请参阅章节 Doxygen 用法,了解如何生成 Doxygen 通常使用的默认标题。
注意:仅当您知道自己在做什么时,才使用用户定义的标头!
$title
$datetime
$date
$time
$year
$showdate(<format>)
<format>
指定的格式替换为当前日期和时间。 <format>
遵循为 \showdate 命令指定的规则,但 <format>
中不允许出现 )
。$doxygenversion
$projectname
$projectnumber
$projectbrief
$projectlogo
$latexdocumentpre
$latexdocumentpost
一起使用。$latexdocumentpost
$latexdocumentpre
一起使用。$generatedby
$projectname
生成于 $datetime
”的输出语言相关版本时。$latexcitereference
CITATIONS_PRESENT
结合使用。$latexbibstyle
plain
。此设置通常与块名称 CITATIONS_PRESENT
结合使用。$latexbibfiles
bib
文件列表(必要时会自动添加缺失的 .bib
)。此设置通常与块名称 CITATIONS_PRESENT
结合使用。$papertype
$langISO
$languagesupport
$latexfontenc
LATEX_FONTENC
结合使用。$latexfont
$latexemojidirectory
$makeindex
\makeindex
。$extralatexpackages
$extralatexstylesheet
.sty
时,该扩展名会从包名称中去除)。$latexspecialformulachars
$formulamacrofile
FORMULA_MACROFILE
结合使用。为了处理页眉和页脚布局中因配置设置而产生的差异,页眉和页脚还可以包含特殊的块,这些块将根据配置复制到输出或跳过。这些块具有以下形式:
%%BEGIN BLOCKNAME Some context copied when condition BLOCKNAME holds %%END BLOCKNAME %%BEGIN !BLOCKNAME Some context copied when condition BLOCKNAME does not hold %%END !BLOCKNAME
以下块名称基于配置文件中使用的设置进行设置:
COMPACT_LATEX
PDF_HYPERLINKS
USE_PDFLATEX
LATEX_BATCHMODE
TIMESTAMP
以下块名称基于所使用的配置文件中标签是否具有值进行设置:
LATEX_FONTENC
$latexfontenc
结合使用。FORMULA_MACROFILE
$formulamacrofile
结合使用。以下块名称基于文档中是否使用了某个特性进行设置:
CITATIONS_PRESENT
$latexcitereference
、$latexbibstyle
和 $latexbibfiles
结合使用。此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_FOOTER
LATEX_FOOTER
标签可用于为生成的 文档指定用户定义的
页脚。页脚应包含最后一章之后的所有内容。如果留空,Doxygen 将生成标准页脚。
有关如何生成默认页脚以及在页脚内可以使用哪些特殊命令的更多信息,请参见 LATEX_HEADER。
另请参阅 Doxygen 使用部分,了解如何生成 Doxygen 通常使用的默认页脚。
注意:仅在您知道自己在做什么的情况下才使用用户定义的页脚!
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_EXTRA_STYLESHEET
LATEX_EXTRA_STYLESHEET
标签可用于指定 Doxygen 创建的标准样式表之后包含的附加用户定义的 YES
。LATEX_EXTRA_FILES
LATEX_EXTRA_FILES
标签可用于指定一个或多个额外的图像或其他源文件,这些文件应复制到 LATEX_OUTPUT 输出目录。请注意,这些文件将按原样复制;没有可用的命令或标记。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
PDF_HYPERLINKS
如果将 PDF_HYPERLINKS
标签设置为 YES
,则生成的 会准备好转换为 PDF(使用
ps2pdf
或 pdflatex
)。PDF 文件将包含链接(就像 HTML 输出一样)而不是页码引用。这使得输出适合使用 PDF 查看器进行在线浏览。
默认值是:YES
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
USE_PDFLATEX
如果将 USE_PDFLATEX
标签设置为 YES
,Doxygen 将使用 LATEX_CMD_NAME 指定的引擎直接从 文件生成 PDF 文件。将此选项设置为
YES
以获得更高质量的 PDF 文档。
有关选择引擎的信息,另请参阅 LATEX_CMD_NAME 部分。
默认值是:YES
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_BATCHMODE
LATEX_BATCHMODE
标签表示 在发生错误时的行为。
可能的值为:NO
与 ERROR_STOP 相同,YES
与 BATCH 相同,BATCH
在批处理模式下,终端上不打印任何内容,错误会被滚动显示,就好像在每次错误时点击了 <return> 一样;TeX 尝试输入或从键盘输入(在未打开的输入流上使用 \read)的缺失文件会导致作业中止,NON_STOP
在非停止模式下,诊断消息会出现在终端上,但就像在批处理模式下一样,无法进行用户交互,SCROLL
在滚动模式下,TeX 只会在输入丢失文件或需要键盘输入时停止,而 ERROR_STOP
在错误停止模式下,TeX 会在每次错误时停止,并要求用户干预。
默认值是:NO
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_HIDE_INDICES
如果将 LATEX_HIDE_INDICES
标签设置为 YES
,则 Doxygen 不会在输出中包含索引章节(例如文件索引、复合索引等)。
默认值是:NO
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_BIB_STYLE
LATEX_BIB_STYLE
标签可用于指定用于书目的样式,例如 plainnat
或 ieeetr
。有关更多信息,请参见 https://en.wikipedia.org/wiki/BibTeX 和 \cite。
默认值为:plainnat
。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
LATEX_EMOJI_DIRECTORY
LATEX_EMOJI_DIRECTORY
标签用于指定从中读取表情符号图像的(相对或绝对)路径。如果输入相对路径,则该路径相对于 LATEX_OUTPUT 目录。如果留空,则将使用 LATEX_OUTPUT 目录。
此标签要求将 GENERATE_LATEX 标签设置为 YES
。
GENERATE_RTF
如果将 GENERATE_RTF
标签设置为 YES
,则 Doxygen 将生成 RTF 输出。RTF 输出针对 Word 97 进行了优化,并且在其他 RTF 阅读器/编辑器中可能看起来不太美观。
默认值是:NO
。
RTF_OUTPUT
RTF_OUTPUT
标签用于指定 RTF 文档的存放位置。如果输入相对路径,则会在其前面放置 OUTPUT_DIRECTORY 的值。
默认目录为:rtf
。
此标签要求将 GENERATE_RTF 标签设置为 YES
。
COMPACT_RTF
如果将 COMPACT_RTF
标签设置为 YES
,则 Doxygen 会生成更紧凑的 RTF 文档。这对于小型项目可能很有用,并且可能有助于总体上节省一些树木。
默认值是:NO
。
此标签要求将 GENERATE_RTF 标签设置为 YES
。
RTF_HYPERLINKS
如果将 RTF_HYPERLINKS
标签设置为 YES
,则生成的 RTF 将包含超链接字段。RTF 文件将包含链接(就像 HTML 输出一样)而不是页码引用。这使得输出适合使用 Word 或其他支持这些字段的 Word 兼容阅读器进行在线浏览。
注意:写字板 (write) 和其他一些软件不支持链接。
默认值是:NO
。
此标签要求将 GENERATE_RTF 标签设置为 YES
。
RTF_STYLESHEET_FILE
从文件加载样式表定义。语法类似于 Doxygen 的配置文件,即一系列赋值。您只需要提供替换,缺失的定义会设置为其默认值。
有关如何生成 Doxygen 通常使用的默认样式表的信息,请参阅 Doxygen 用法部分。
此标签要求将 GENERATE_RTF 标签设置为 YES
。
RTF_EXTENSIONS_FILE
设置 RTF 文档生成中使用的可选变量。语法类似于 Doxygen 的配置文件。可以使用 doxygen -e rtf extensionFile
生成模板扩展文件。
此标签要求将 GENERATE_RTF 标签设置为 YES
。
RTF_EXTRA_FILES
RTF_EXTRA_FILES
标签可用于指定一个或多个额外的图像或其他源文件,这些文件应被复制到 RTF_OUTPUT 输出目录。请注意,这些文件将按原样复制;没有任何命令或标记可用。
此标签要求标签 GENERATE_RTF 设置为 YES
。
GENERATE_MAN
如果 GENERATE_MAN
标签设置为 YES
,Doxygen 将为类和文件生成 man 手册页。
默认值是:NO
。
MAN_OUTPUT
MAN_OUTPUT
标签用于指定 man 手册页的放置位置。如果输入相对路径,则 OUTPUT_DIRECTORY 的值将被添加到其前面。在 MAN_OUTPUT
指定的目录内将创建一个 man3
目录。
默认目录为:man
。
此标签要求标签 GENERATE_MAN 设置为 YES
。
MAN_EXTENSION
MAN_EXTENSION
标签确定添加到生成的 man 手册页的扩展名。如果手册部分不是以数字开头,则会预先添加数字 3。 MAN_EXTENSION
标签开头的点 (.) 是可选的。
默认值为:.3
。
此标签要求标签 GENERATE_MAN 设置为 YES
。
MAN_SUBDIR
MAN_SUBDIR
标签确定在 MAN_OUTPUT
中创建的用于放置 man 手册页的目录的名称。它默认为 man,后跟 MAN_EXTENSION
,并删除初始的 . 。
此标签要求标签 GENERATE_MAN 设置为 YES
。
MAN_LINKS
如果 MAN_LINKS
标签设置为 YES
并且 Doxygen 生成 man 输出,那么它将为真实 man 手册页中记录的每个实体生成一个额外的 man 文件。这些额外的文件仅引用真实的 man 手册页,但如果没有它们,man
命令将无法找到正确的页面。
默认值是:NO
。
此标签要求标签 GENERATE_MAN 设置为 YES
。
GENERATE_XML
如果 GENERATE_XML
标签设置为 YES
,Doxygen 将生成一个 XML 文件,该文件捕获代码的结构,包括所有文档。
默认值是:NO
。
XML_OUTPUT
XML_OUTPUT
标签用于指定 XML 页面的放置位置。如果输入相对路径,则 OUTPUT_DIRECTORY 的值将被添加到其前面。
默认目录为:xml
。
此标签要求标签 GENERATE_XML 设置为 YES
。
XML_PROGRAMLISTING
如果 XML_PROGRAMLISTING
标签设置为 YES
,Doxygen 将把程序列表(包括语法高亮和交叉引用信息)转储到 XML 输出。请注意,启用此功能将显著增加 XML 输出的大小。
默认值是:YES
。
此标签要求标签 GENERATE_XML 设置为 YES
。
XML_NS_MEMB_FILE_SCOPE
如果 XML_NS_MEMB_FILE_SCOPE
标签设置为 YES
,Doxygen 还将在文件范围内包含命名空间成员,与 HTML 输出匹配。
默认值是:NO
。
此标签要求标签 GENERATE_XML 设置为 YES
。
GENERATE_DOCBOOK
如果 GENERATE_DOCBOOK
标签设置为 YES
,Doxygen 将生成可用于生成 PDF 的 Docbook 文件。
默认值是:NO
。
DOCBOOK_OUTPUT
DOCBOOK_OUTPUT
标签用于指定 Docbook 页面的放置位置。如果输入相对路径,则 OUTPUT_DIRECTORY 的值将被添加到其前面。
默认目录为:docbook
。
此标签要求标签 GENERATE_DOCBOOK 设置为 YES
。
GENERATE_AUTOGEN_DEF
如果 GENERATE_AUTOGEN_DEF
标签设置为 YES
,Doxygen 将生成一个 AutoGen Definitions 文件(参见 https://autogen.sourceforge.net/),该文件捕获代码的结构,包括所有文档。请注意,此功能目前仍处于实验阶段且不完整。
默认值是:NO
。
GENERATE_SQLITE3
如果 GENERATE_SQLITE3
标签设置为 YES
,Doxygen 将生成一个 Sqlite3
数据库,其中 Doxygen 找到的符号存储在表中。
默认值是:NO
。
SQLITE3_OUTPUT
SQLITE3_OUTPUT
标签用于指定 Sqlite3
数据库的放置位置。如果输入相对路径,则 OUTPUT_DIRECTORY 的值将被添加到其前面。
默认目录为:sqlite3
。
此标签要求标签 GENERATE_SQLITE3 设置为 YES
。
SQLITE3_RECREATE_DB
如果 SQLITE3_RECREATE_DB
标签设置为 YES
,则每次运行 Doxygen 时都会重新创建现有的 doxygen_sqlite3.db 数据库文件。如果设置为 NO
,如果已找到数据库文件,Doxygen 将发出警告且不修改它。
默认值是:YES
。
此标签要求标签 GENERATE_SQLITE3 设置为 YES
。
GENERATE_PERLMOD
如果 GENERATE_PERLMOD
标签设置为 YES
,Doxygen 将生成一个 Perl 模块文件,该文件捕获代码的结构,包括所有文档。
请注意,此功能目前仍处于实验阶段且不完整。
默认值是:NO
。
PERLMOD_LATEX
如果 PERLMOD_LATEX
标签设置为 YES
,Doxygen 将生成必要的 Makefile
规则、Perl
脚本和 代码,以便能够从 Perl 模块输出生成 PDF 和 DVI 输出。
默认值是:NO
。
此标签要求标签 GENERATE_PERLMOD 设置为 YES
。
PERLMOD_PRETTY
如果 PERLMOD_PRETTY
标签设置为 YES
,Perl 模块输出将被格式化得很好,以便人类读者可以解析它。 如果您想了解发生了什么,这很有用。另一方面,如果此标签设置为 NO
,则 Perl 模块输出的大小会小得多,并且 Perl 将以相同的方式解析它。
默认值是:YES
。
此标签要求标签 GENERATE_PERLMOD 设置为 YES
。
PERLMOD_MAKEVAR_PREFIX
生成的 doxyrules.make
文件中的 make 变量名称以 PERLMOD_MAKEVAR_PREFIX
中包含的字符串为前缀。 这很有用,因此同一个 Makefile
包含的不同 doxyrules.make
文件不会相互覆盖变量。
此标签要求标签 GENERATE_PERLMOD 设置为 YES
。
ENABLE_PREPROCESSING
如果 ENABLE_PREPROCESSING
标签设置为 YES
,Doxygen 将评估在源文件和包含文件中找到的所有 C 预处理器指令。
默认值是:YES
。
MACRO_EXPANSION
如果 MACRO_EXPANSION
标签设置为 YES
,Doxygen 将展开源代码中的所有宏名称。 如果设置为 NO
,则仅执行条件编译。可以通过将 EXPAND_ONLY_PREDEF 设置为 YES
来以受控方式进行宏展开。
默认值是:NO
。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
EXPAND_ONLY_PREDEF
如果 EXPAND_ONLY_PREDEF
和 MACRO_EXPANSION 标签都设置为 YES
,则宏展开仅限于使用 PREDEFINED 和 EXPAND_AS_DEFINED 标签指定的宏。
默认值是:NO
。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
SEARCH_INCLUDES
如果 SEARCH_INCLUDES
标签设置为 YES
,则如果找到 #include
,将搜索 INCLUDE_PATH 中的包含文件。
默认值是:YES
。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
INCLUDE_PATH
INCLUDE_PATH
标签可用于指定一个或多个包含文件的目录,这些文件不是输入文件,但应由预处理器处理。
请注意,INCLUDE_PATH
不是递归的,因此 RECURSIVE 的设置在此处不起作用。
此标签要求标签 SEARCH_INCLUDES 设置为 YES
。
INCLUDE_FILE_PATTERNS
您可以使用 INCLUDE_FILE_PATTERNS
标签指定一个或多个通配符模式(如 *.h
和 *.hpp
)来过滤目录中的头文件。如果留空,将使用 FILE_PATTERNS 指定的模式。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
PREDEFINED
PREDEFINED
标签可用于指定在预处理器启动之前定义的一个或多个宏名称(类似于例如 gcc
的 -D
选项)。 标签的参数是 name
或 name=definition
形式的宏列表(没有空格)。如果省略定义和 "="
,则假定为 "=1"
。要防止宏定义通过 #undef
取消定义或递归展开,请使用 :=
运算符而不是 =
运算符。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
EXPAND_AS_DEFINED
如果 MACRO_EXPANSION 和 EXPAND_ONLY_PREDEF 标签设置为 YES
,则可以使用此标签指定应展开的宏名称列表。将使用在源文件中找到的宏定义。如果您想使用不同的宏定义来覆盖在源代码中找到的定义,请使用 PREDEFINED 标签。
此标签要求标签 ENABLE_PREPROCESSING 设置为 YES
。
SKIP_FUNCTION_MACROS
如果 SKIP_FUNCTION_MACROS
标签设置为 YES
,那么 Doxygen 的预处理器将删除对单独一行、具有全部大写名称且不以分号结尾的类函数宏的所有引用。此类函数宏通常用于样板代码,如果未删除,则会混淆解析器。
默认值是:YES
。
此标签要求将标签 ENABLE_PREPROCESSING 设置为 YES
。
TAGFILES
对于每个标签文件,应添加外部文档的位置。不包含此位置的标签文件的格式如下
TAGFILES = file1 file2 ...
添加标签文件位置的方法如下
TAGFILES = file1=loc1 "file2 = loc2" ...
其中 loc1
和 loc2
可以是相对路径或绝对路径,也可以是 URL。有关标签文件使用的更多信息,请参阅链接到外部文档部分。
GENERATE_TAGFILE
当在 GENERATE_TAGFILE
之后指定文件名时,Doxygen 将创建一个基于它读取的输入文件的标签文件。有关标签文件用法的更多信息,请参阅链接到外部文档部分。
ALLEXTERNALS
如果 ALLEXTERNALS
标签设置为 YES
,则所有外部类和命名空间将列在类和命名空间索引中。如果设置为 NO
,则只会列出继承的外部类。
默认值是:NO
。
EXTERNAL_GROUPS
如果 EXTERNAL_GROUPS
标签设置为 YES
,则所有外部组将列在主题索引中。如果设置为 NO
,则只会列出当前项目的组。
默认值是:YES
。
EXTERNAL_PAGES
如果 EXTERNAL_PAGES
标签设置为 YES
,则所有外部页面将列在相关页面索引中。如果设置为 NO
,则只会列出当前项目的页面。
默认值是:YES
。
HIDE_UNDOC_RELATIONS
如果设置为 YES
,则如果目标未文档化或不是类,则继承和协作图将隐藏继承和使用关系。
默认值是:YES
。
HAVE_DOT
如果将 HAVE_DOT
标签设置为 YES
,则 Doxygen 将假定 dot
工具可以从 path
中获得。此工具是 Graphviz 的一部分,它是来自 AT&T 和 Lucent Bell Labs 的图形可视化工具包。如果此选项设置为 NO
,则本节中的其他选项无效
默认值是:NO
。
DOT_NUM_THREADS
DOT_NUM_THREADS
指定 Doxygen 允许并行运行的 dot
调用次数。当设置为 0
时,Doxygen 将根据系统中可用的处理器数量来确定此值。您可以将其显式设置为大于 0 的值,以便控制 CPU 负载和处理速度之间的平衡。
最小值:0
,最大值:32
,默认值:0
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOT_COMMON_ATTR
DOT_COMMON_ATTR
是子图的节点、边和标签的通用属性。当您希望 Doxygen 生成的 dot 文件中使用外观不同的字体时,可以指定 fontname、fontcolor 和 fontsize 属性。有关详细信息,请参阅节点、边和图属性规范 您需要确保 dot 能够找到字体,这可以通过将其放置在标准位置,或设置 DOTFONTPATH
环境变量或通过设置 DOT_FONTPATH 到包含字体的目录来完成。默认 graphviz 字体大小为 14。
默认值为:fontname=Helvetica,fontsize=10
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOT_EDGE_ATTR
DOT_EDGE_ATTR
与 DOT_COMMON_ATTR 连接。为了获得优雅的样式,您可以添加 'arrowhead=open, arrowtail=open, arrowsize=0.5'。有关箭头形状的完整文档。
默认值为:labelfontname=Helvetica,labelfontsize=10
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOT_NODE_ATTR
DOT_NODE_ATTR
与 DOT_COMMON_ATTR 连接。为了查看没有节点周围的框,请设置 'shape=plain' 或 'shape=plaintext' 形状规范
默认值为:shape=box,height=0.2,width=0.4
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOT_FONTPATH
您可以设置 dot
可以在 DOT_COMMON_ATTR 和其他 dot 属性中使用 fontname 指定的字体路径。
此标签要求将标签 HAVE_DOT 设置为 YES
。
CLASS_GRAPH
如果 CLASS_GRAPH
标签设置为 YES
或 GRAPH
或 BUILTIN
,则 Doxygen 将为每个文档化的类生成一个图表,显示直接和间接继承关系。如果 CLASS_GRAPH
标签设置为 YES
或 GRAPH
并且也启用了 HAVE_DOT,则将使用 dot
来绘制该图。如果 CLASS_GRAPH
标签设置为 YES
并且禁用了 HAVE_DOT,或者如果 CLASS_GRAPH
标签设置为 BUILTIN
,则将使用内置生成器。如果 CLASS_GRAPH
标签设置为 TEXT
,则直接和间接继承关系将显示为文本/链接。可以通过命令 \inheritancegraph 来显式启用继承图或为特定类的继承图选择不同的表示形式。可以通过命令 \hideinheritancegraph 来禁用继承图。
可能的值为:NO
、YES
、TEXT
、GRAPH
和 BUILTIN
。
默认值是:YES
。
COLLABORATION_GRAPH
如果 COLLABORATION_GRAPH
标签设置为 YES
,则 Doxygen 将为每个文档化的类生成一个图表,显示该类与其他文档化的类的直接和间接实现依赖关系(继承、包含和类引用变量)。当 COLLABORATION_GRAPH
设置为 NO
时,可以通过命令 \collaborationgraph 来显式启用协作图。可以通过命令 \hidecollaborationgraph 来禁用协作图。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
GROUP_GRAPHS
如果 GROUP_GRAPHS
标签设置为 YES
,则 Doxygen 将为组生成一个图表,显示直接的组依赖关系。当 GROUP_GRAPHS
设置为 NO
时,可以通过命令 \groupgraph 来显式启用组依赖关系图。可以通过命令 \hidegroupgraph 来禁用目录图。
另请参阅手册中的 分组 章节。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
UML_LOOK
如果 UML_LOOK
标签设置为 YES
,则 Doxygen 将以类似于 OMG 的统一建模语言的风格生成继承和协作图。
默认值是:NO
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
UML_LIMIT_NUM_FIELDS
如果启用了 UML_LOOK 标签,则字段和方法将显示在类节点内部。如果字段或方法很多,并且节点也很多,则图形可能变得太大而无法使用。UML_LIMIT_NUM_FIELDS
阈值限制每种类型的项目数,以使大小更易于管理。设置为 0 表示没有限制。请注意,在强制实施限制之前,阈值可能会超出 50%。因此,当您将阈值设置为 10 时,最多可能会出现 15 个字段,但如果数量超过 15 个,则显示的字段总数将限制为 10 个。
最小值:0
,最大值:100
,默认值:10
。
此标签要求将标签 UML_LOOK 设置为 YES
。
DOT_UML_DETAILS
如果 DOT_UML_DETAILS
标签设置为 NO
,则 Doxygen 将在 UML 图中显示不带类型和参数的属性和方法。如果 DOT_UML_DETAILS
标签设置为 YES
,则 Doxygen 将在 UML 图中为属性和方法添加类型和参数。如果 DOT_UML_DETAILS
标签设置为 NONE
,则 Doxygen 将不会在 UML 图中生成包含类成员信息的字段。类图的外观将类似于默认类图,但使用 UML 表示法表示关系。
可能的值为:NO
、YES
和 NONE
。
默认值是:NO
。
此标签要求将标签 UML_LOOK 设置为 YES
。
DOT_WRAP_THRESHOLD
DOT_WRAP_THRESHOLD
标签可用于设置单行显示的最大字符数。如果实际行长度明显超过此阈值,则该行将被换行到多行。应用了一些启发式方法来避免难看的换行符。
最小值:0
,最大值:1000
,默认值:17
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
TEMPLATE_RELATIONS
如果 TEMPLATE_RELATIONS
标签设置为 YES
,则继承和协作图将显示模板及其实例之间的关系。
默认值是:NO
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
INCLUDE_GRAPH
如果 INCLUDE_GRAPH
、ENABLE_PREPROCESSING 和 SEARCH_INCLUDES 标签都设置为 YES
,则 Doxygen 将为每个文档化的文件生成一个图表,显示该文件与其他文档化文件的直接和间接包含依赖关系。当 INCLUDE_GRAPH
设置为 NO
时,可以通过 \includegraph 命令显式启用包含图。可以通过 \hideincludegraph 命令禁用包含图。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
INCLUDED_BY_GRAPH
如果 INCLUDED_BY_GRAPH
、ENABLE_PREPROCESSING 和 SEARCH_INCLUDES 标签都设置为 YES
,则 Doxygen 将为每个文档化的文件生成一个图表,显示该文件与其他文档化文件的直接和间接包含依赖关系。当 INCLUDED_BY_GRAPH
设置为 NO
时,可以通过 \includedbygraph 命令显式启用被包含图。可以通过 \hideincludedbygraph 命令禁用被包含图。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
CALL_GRAPH
如果 CALL_GRAPH
标签设置为 YES
,则 Doxygen 将为每个全局函数或类方法生成调用依赖图。
请注意,启用此选项将显着增加运行时间。因此,在大多数情况下,最好仅使用 \callgraph 命令为选定的函数启用调用图。可以使用 \hidecallgraph 命令禁用调用图。
默认值是:NO
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
CALLER_GRAPH
如果 CALLER_GRAPH
标签设置为 YES
,则 Doxygen 将为每个全局函数或类方法生成调用者依赖图。
请注意,启用此选项将显着增加运行时间。因此,在大多数情况下,最好仅使用 \callergraph 命令为选定的函数启用调用者图。可以使用 \hidecallergraph 命令禁用调用者图。
默认值是:NO
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
GRAPHICAL_HIERARCHY
如果 GRAPHICAL_HIERARCHY
标签设置为 YES
,则 Doxygen 将显示所有类的图形层次结构,而不是文本层次结构。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DIRECTORY_GRAPH
如果 DIRECTORY_GRAPH
标签设置为 YES
,则 Doxygen 将以图形方式显示目录对其他目录的依赖关系。依赖关系由目录中文件之间的 #include
关系确定。当 DIRECTORY_GRAPH
设置为 NO
时,可以通过 \directorygraph 命令显式启用目录图。可以通过 \hidedirectorygraph 命令禁用目录图。
默认值是:YES
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DIR_GRAPH_MAX_DEPTH
DIR_GRAPH_MAX_DEPTH
标签可用于限制 dot
在目录依赖关系图中生成的子目录的最大级别数。
最小值:1
,最大值:25
,默认值:1
。
此标签要求将标签 DIRECTORY_GRAPH 设置为 YES
。
DOT_IMAGE_FORMAT
DOT_IMAGE_FORMAT
标签可用于设置 dot
生成的图像的图像格式。有关图像格式的解释,请参阅 dot
工具文档(Graphviz)中的输出格式部分。
svg
,则需要将 HTML_FILE_EXTENSION 设置为 xhtml
,以便在 IE 9+ 中显示 SVG 文件(其他浏览器没有此要求)。可能的值为:png
、jpg
、gif
、svg
、png:gd
、png:gd:gd
、png:cairo
、png:cairo:gd
、png:cairo:cairo
、png:cairo:gdiplus
、png:gdiplus
和 png:gdiplus:gdiplus
。
默认值为:png
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
INTERACTIVE_SVG
如果 DOT_IMAGE_FORMAT 设置为 svg
,则可以将此选项设置为 YES
,以启用生成允许缩放和平移的交互式 SVG 图像。
请注意,这需要除 Internet Explorer 之外的现代浏览器。经过测试并且可以正常工作的有 Firefox、Chrome、Safari 和 Opera。
xhtml
,以便显示 SVG 文件。较旧版本的 IE 不支持 SVG。默认值是:NO
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOT_PATH
DOT_PATH
标签可用于指定 dot
工具所在的路径。如果留空,则假定可以在 path
中找到 dot
工具。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DOTFILE_DIRS
DOTFILE_DIRS
标签可用于指定一个或多个包含包含在文档中的 dot 文件的目录(请参阅 \dotfile 命令)。
此标签要求将标签 HAVE_DOT 设置为 YES
。
DIA_PATH
您可以在 Doxygen 文档中包含使用 dia 制作的图表。然后,Doxygen 将运行 dia 来生成图表并将其插入到文档中。DIA_PATH
标签允许您指定 dia 二进制文件所在的目录。如果留空,则假定可以在默认搜索路径中找到 dia。
DIAFILE_DIRS
DIAFILE_DIRS
标签可用于指定一个或多个包含包含在文档中的 dia 文件的目录(请参阅 \diafile 命令)。
PLANTUML_JAR_PATH
当使用 PlantUML 时,应使用 PLANTUML_JAR_PATH
标签来指定 java 可以找到 plantuml.jar
文件的路径,或指定要使用的 jar
文件的文件名。如果留空,则假定在预处理步骤中未使用或未调用 PlantUML。在这种情况下,Doxygen 在遇到 \startuml 命令时将生成警告,并且不会为该图生成输出。
PLANTUML_CFG_FILE
PLANTUML_INCLUDE_PATH
PLANTUMLFILE_DIRS
PLANTUMLFILE_DIRS
标签可用于指定一个或多个包含包含在文档中的 PlantUml 文件的目录(请参阅 \plantumlfile 命令)。
DOT_GRAPH_MAX_NODES
DOT_GRAPH_MAX_NODES
标签可用于设置图中将显示的最大节点数。如果图中节点的数量大于此值,则 Doxygen 将截断该图,并通过将节点表示为红色框来可视化该图。请注意,如果图中根节点的直接子节点的数量已经大于 DOT_GRAPH_MAX_NODES
,则根本不会显示该图。另请注意,可以使用 MAX_DOT_GRAPH_DEPTH 进一步限制图的大小。
最小值:0
,最大值:10000
,默认值:50
。
此标签要求将标签 HAVE_DOT 设置为 YES
。
MAX_DOT_GRAPH_DEPTH
MAX_DOT_GRAPH_DEPTH
标签可用于设置 dot
生成的图形的最大深度。深度值为 3 表示仅显示从根节点出发,通过最多 3 条边的路径可到达的节点。距离根节点更远的节点将被省略。请注意,将此选项设置为 1 或 2 可以大大减少大型代码库所需的计算时间。另请注意,可以通过 DOT_GRAPH_MAX_NODES 进一步限制图形的大小。使用深度 0 表示没有深度限制。
最小值:0
,最大值:1000
,默认值:0
。
此标签要求标签 HAVE_DOT 设置为 YES
。
DOT_MULTI_TARGETS
将 DOT_MULTI_TARGETS
标签设置为 YES
允许 dot 在一次运行中生成多个输出文件(即命令行上的多个 -o 和 -T 选项)。这可以使 dot
运行得更快,但由于只有较新版本的 dot
(>1.8.10)支持此功能,因此默认情况下禁用此功能。
默认值是:NO
。
此标签要求标签 HAVE_DOT 设置为 YES
。
GENERATE_LEGEND
如果 GENERATE_LEGEND
标签设置为 YES
,Doxygen 将生成一个图例页面,解释 dot 生成的图形中各种框和箭头的含义。
默认值是:YES
。
此标签要求标签 HAVE_DOT 设置为 YES
。
DOT_CLEANUP
如果 DOT_CLEANUP
标签设置为 YES
,Doxygen 将删除用于生成各种图形的中间文件。
注意:此设置不仅用于 dot 文件,也用于 msc 临时文件。
默认值是:YES
。
MSCGEN_TOOL
您可以使用 \msc 命令在 Doxygen 注释中定义消息序列图。如果 MSCGEN_TOOL
标签留空(默认),则 Doxygen 将使用内置版本的 mscgen 工具来生成图表。或者,MSCGEN_TOOL
标签也可以指定外部工具的名称。例如,将值指定为 prog
,Doxygen 将调用该工具,格式为 prog -T <outfile_format> -o <outputfile> <inputfile>
。外部工具应支持输出文件格式 "png"、"eps"、"svg" 和 "ismap"。
MSCFILE_DIRS
MSCFILE_DIRS
标签可用于指定一个或多个包含 msc 文件的目录,这些文件包含在文档中(请参见 \mscfile 命令)。
假设您有一个简单的项目,由两个文件组成:源文件 example.cc
和头文件 example.h
。那么一个最小的配置文件就非常简单:
INPUT = example.cc example.h
假设该示例使用了 Qt 类,并且 perl
位于 /usr/bin
中,一个更实际的配置文件将是:
PROJECT_NAME = Example INPUT = example.cc example.h WARNINGS = YES TAGFILES = qt.tag SEARCHENGINE = NO
为了生成 QdbtTabular 包的文档,我使用了以下配置文件:
PROJECT_NAME = QdbtTabular OUTPUT_DIRECTORY = html WARNINGS = YES INPUT = examples/examples.doc src FILE_PATTERNS = *.cc *.h INCLUDE_PATH = examples TAGFILES = qt.tag SEARCHENGINE = YES
要从源代码重新生成 Qt-1.44 的文档,您可以使用以下配置文件:
PROJECT_NAME = Qt OUTPUT_DIRECTORY = qt_docs HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES FULL_PATH_NAMES = YES STRIP_FROM_PATH = $(QTDIR)/ PREDEFINED = USE_TEMPLATECLASS Q_EXPORT= \ QArrayT:=QArray \ QListT:=QList \ QDictT:=QDict \ QQueueT:=QQueue \ QVectorT:=QVector \ QPtrDictT:=QPtrDict \ QIntDictT:=QIntDict \ QStackT:=QStack \ QDictIteratorT:=QDictIterator \ QListIteratorT:=QListIterator \ QCacheT:=QCache \ QCacheIteratorT:=QCacheIterator \ QIntCacheT:=QIntCache \ QIntCacheIteratorT:=QIntCacheIterator \ QIntDictIteratorT:=QIntDictIterator \ QPtrDictIteratorT:=QPtrDictIterator INPUT = $(QTDIR)/doc \ $(QTDIR)/src/widgets \ $(QTDIR)/src/kernel \ $(QTDIR)/src/dialogs \ $(QTDIR)/src/tools FILE_PATTERNS = *.cpp *.h q*.doc INCLUDE_PATH = $(QTDIR)/include RECURSIVE = YES
对于 Qt-2.1 源代码,我建议使用以下设置:
PROJECT_NAME = Qt PROJECT_NUMBER = 2.1 HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES SOURCE_BROWSER = YES INPUT = $(QTDIR)/src FILE_PATTERNS = *.cpp *.h q*.doc RECURSIVE = YES EXCLUDE_PATTERNS = *codec.cpp moc_* */compat/* */3rdparty/* ALPHABETICAL_INDEX = YES IGNORE_PREFIX = Q ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES INCLUDE_PATH = $(QTDIR)/include PREDEFINED = Q_PROPERTY(x)= \ Q_OVERRIDE(x)= \ Q_EXPORT= \ Q_ENUMS(x)= \ "QT_STATIC_CONST=static const " \ _WS_X11_ \ INCLUDE_MENUITEM_DEF EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \ Q_VARIANT_AS
这里,Doxygen 的预处理器用于替换一些通常由 C 预处理器替换的宏名称,但不会进行完整的宏展开。