Doxygen wizard - Expert - AutoGen PerlMod Preprocessor External

写在前面

Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。
本篇包含Doxygen wizard - Expert： AutoGen + PerlMod + Preprocessor + External部分。

AutoGen

• GENERATE_AUTOGEN_DEF

If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment.

The default value is: NO.

如果GENERATE_AUTOGEN_DEF标记设置为yes，则doxygen将生成一个AutoGen定义（请参阅http://autogen.sourceforge.net/）文件，该文件捕获代码的结构，包括所有文档。请注意，此功能目前仍处于实验阶段且不完整。

PerlMod

• GENERATE_PERLMOD

If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module file that captures the structure of the code including all documentation.
Note that this feature is still experimental and incomplete at the moment.

The default value is: NO.

如果该标记设置为yes，doxygen将产生一个Perl模块文件，其中包括所有文件。
请注意，此功能目前仍处于实验阶段且不完整。

• PERLMOD_LATEX

If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl module output.

The default value is: NO.

This tag requires that the tag GENERATE_PERLMOD is set to YES.

如果该标记设置为yes，doxygen将产生必要的规则，Perl脚本和LaTeX代码可以从Perl模块输出中产生PDF和DVI 输出。

• PERLMOD_PRETTY

If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely formatted so it can be parsed by a human reader. This is useful if you want to understand what is going on. On the other hand, if this tag is set to NO, the size of the Perl module output will be much smaller and Perl will parse it just the same.

The default value is: YES.

This tag requires that the tag GENERATE_PERLMOD is set to YES.

如果该标记设置为yes，Perl模块输出将被很好的格式化以便能够被人解析。如果你想了解正在发生的事情，这很有用。另一方面，如果将此标记设置为no，则Perl模块输出的大小将小得多，Perl将对其进行相同的解析。

• PERLMOD_MAKEVAR_PREFIX

The names of the make variables in the generated doxyrules.make file are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful so different doxyrules.make files included by the same Makefile don’t overwrite each other’s variables.

This tag requires that the tag GENERATE_PERLMOD is set to YES.

生成的doxyrules.make文件中make变量的名称以PERLMOD_MAKEVAR_PREFIX中包含的字符串作为前缀。这很有用，因为同一个makefile中包含的不同doxyrules.make文件不会覆盖彼此的变量。

Preprocessor

• ENABLE_PREPROCESSING

If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all C-preprocessor directives found in the sources and include files.

The default value is: YES.

如果启用 ENABLE_PREPROCESSING标记设置为yes，则doxygen将评估源中找到的所有c-preprocessor指令并包含文件。

• MACRO_EXPANSION

If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names in the source code. If set to NO, only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting EXPAND_ONLY_PREDEF to YES.

The default value is: NO.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

如果 MACRO_EXPANSION标记设置为yes，则doxygen将展开源代码中的所有宏名。如果设置为否，则只执行条件编译。宏展开可以通过将EXPAND_ONLY_PREDEF设置为Yes以可控方式进行。

• EXPAND_ONLY_PREDEF

If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DEFINED tags.

The default value is: NO.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

如果EXPAND_ONLY_PREDEF和MACRO_EXPANSION标记都设置为Yes，则宏扩展仅限于使用PREDEFINED标记和 EXPAND_AS_DEFINED标记指定的宏。

• SEARCH_INCLUDES

If the SEARCH_INCLUDES tag is set to YES, the include files in the INCLUDE_PATH will be searched if a #include is found.

The default value is: YES.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

如果SEARCH_INCLUDES标记设置为“是”，则如果找到包含，将搜索SEARCH_INCLUDES中的包含文件。

• INCLUDE_PATH

The INCLUDE_PATH tag can be used to specify one or more directories that contain include files that are not input files but should be processed by the preprocessor.

This tag requires that the tag SEARCH_INCLUDES is set to YES.

INCLUDE_PATH标记可用于指定一个或多个目录，其中包含的文件不是输入文件，但应由预处理器处理。

• INCLUDE_FILE_PATTERNS

You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard patterns (like *.h and *.hpp) to filter out the header-files in the directories. If left blank, the patterns specified with FILE_PATTERNS will be used.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

可以使用INCLUDE_FILE_PATTERNS标记指定一个或多个通配符模式（如.h和.hpp）来筛选目录中的头文件。如果留空，将使用FILE_PATTERNS 指定的模式。

• PREDEFINED

The PREDEFINED tag can be used to specify one or more macro names that are defined before the preprocessor is started (similar to the -D option of e.g. gcc). The argument of the tag is a list of macros of the form: name or name=definition (no spaces). If the definition and the “=” are omitted, “=1” is assumed. To prevent a macro definition from being undefined via #undef or recursively expanded use the := operator instead of the = operator.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED标记可用于指定在启动预处理器之前定义的一个或多个宏名（类似于gcc的-d选项）。标记的参数是以下形式的宏列表：name或name=definition（无空格）。如果省略定义和“=”，则假定“=1”。要防止宏定义通过#undef 或递归扩展而未定义，请使用：=运算符而不是=运算符。

• EXPAND_AS_DEFINED

If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

如果MACRO_EXPANSION和EXPAND_ONLY_PREDEF标记设置为“是”，则可以使用此标记指定应扩展的宏名称列表。将使用源中找到的宏定义。如果要使用另一个宏定义来覆盖源代码中的定义，请使用PREDEFINED标记。

• SKIP_FUNCTION_MACROS

If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen’s preprocessor will remove all references to function-like macros that are alone on a line, have an all uppercase name, and do not end with a semicolon. Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed.

The default value is: YES.

This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

如果SKIP_FUNCTION_MACROS标记设置为yes，那么doxygen的预处理器将删除对函数的所有引用，就像一行中单独存在的宏一样，具有全部大写的名称，并且不以分号结尾。此类函数宏通常用于冗余而又不得不写的代码，如果不删除，将混淆解析器。

External

• TAGFILES

The TAGFILES tag can be used to specify one or more tag files. For each tag file the location of the external documentation should be added. The format of a tag file without this location is as follows:
TAGFILES = file1 file2 …
Adding location for the tag files is done as follows:
TAGFILES = file1=loc1 “file2 = loc2” …
where loc1 and loc2 can be relative or absolute paths or URLs. See the section “Linking to external documentation” for more information about the use of tag files.
Note: Each tag file must have a unique name (where the name does NOT include the path). If a tag file is not located in the directory in which doxygen is run, you must also specify the path to the tagfile here.

TAGFILES标记可用于指定一个或多个标记文件。对于每个标记文件，应添加外部文档的位置。没有此位置的标记文件的格式如下：
TAGFILES = file1 file2 …
为标记文件添加位置的操作如下：
TAGFILES = file1=loc1 “file2 = loc2” …
其中loc1和loc2可以是相对或绝对路径或URL。有关使用标记文件的更多信息，请参阅“链接到外部文档”一节。
注意：每个标记文件必须具有唯一的名称（其中名称不包括路径）。如果标记文件不在运行doxygen的目录中，则还必须在此处指定标记文件的路径。

• GENERATE_TAGFILE

When a file name is specified after GENERATE_TAGFILE, doxygen will create a tag file that is based on the input files it reads. See section “Linking to external documentation” for more information about the usage of tag files.

当在GENERATE_TAGFILE后指定文件名时，doxygen将根据其读取的输入文件创建标记文件。请参阅“链接到外部文档”一节，以获取有关标记文件使用的更多信息。

• ALLEXTERNALS

If the ALLEXTERNALS tag is set to YES, all external class will be listed in the class index. If set to NO, only the inherited external classes will be listed.

The default value is: NO.

如果ALLEXTERNALS标记设置为yes，则所有外部类都将列在类索引中。如果设置为否，则只列出继承的外部类。

• EXTERNAL_GROUPS

If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed in the modules index. If set to NO, only the current project’s groups will be listed.

The default value is: YES.

如果EXTERNAL_GROUPS标记设置为yes，则所有外部组都将列在模块索引中。如果设置为否，则只列出当前项目的组。

• EXTERNAL_PAGES

If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in the related pages index. If set to NO, only the current project’s pages will be listed.

The default value is: YES.

如果EXTERNAL_PAGES 标记设置为“是”，则所有外部页面都将列在相关页面索引中。如果设置为否，则只列出当前项目的页面。

• PERL_PATH

The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of ‘which perl’).

The default file (with absolute path) is: /usr/bin/perl.

Perl_路径应该是Perl脚本解释器的绝对路径和名称（即“哪个Perl”）的结果。
默认文件（带有绝对路径）是：/usr/bin/perl。