其他分享
首页 > 其他分享> > Doxygen wizard - Expert -Build

Doxygen wizard - Expert -Build

作者：互联网

写在前面

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

Build

If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will be included in the documentation.

The default value is: NO.

如果该标记设置为yes，一个类的所有私有成员会包含在文档中。

If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal scope will be included in the documentation.

The default value is: NO.

如果该标记设置为yes，一个包或者内部范围的所有成员会包含在文档中。

If the EXTRACT_STATIC tag is set to YES, all static members of a file will be included in the documentation.

The default value is: NO.

如果该标记设置为yes，一个文件的所有静态成员会包含在文档中。

If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined locally in source files will be included in the documentation. If set to NO, only classes defined in header files are included. Does not have any effect for Java sources.

The default value is: YES.

如果该标记设置为yes,源文件中局部定义的类和结构会包含在文档中。如果设置为no,只有在头文件中定义的类会被包含，对Java源文件没有影响。

This flag is only useful for Objective-C code. If set to YES, local methods, which are defined in the implementation section but not in the interface are included in the documentation. If set to NO, only methods in the interface are included.

The default value is: NO.

该标记只适用于OC代码。如果设置为yes,在事件部分还不是在接口中定义的局部方法不会被包含在文档中。如果设置为no,只有在接口中的方法会被包含。

If this flag is set to YES, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called ‘anonymous_namespace{file}’, where file will be replaced with the base name of the file that contains the anonymous namespace. By default anonymous namespace are hidden.

The default value is: NO.

如果标记设置为yes，则将提取匿名命名空间的成员，并在文档中显示为 'anonymous_namespace{file}'的命名空间，其中文件将被替换为包含匿名命令空间的文件的基本名称。默认下匿名命名空间是隐藏的。

If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all undocumented members inside documented classes or files. If set to NO these members will be included in the various overviews, but no documentation section is generated. This option has no effect if EXTRACT_ALL is enabled.

如果设置为yes,doxygen将隐藏文档类或文件中的所有未记录成员。如果设置为no,这些成员将包括在各种概述中，但是不会生成文档部分。如果启动 EXTRACT_ALL，则此选项无效。

The default value is: NO.

If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all undocumented classes that are normally visible in the class hierarchy. If set to NO, these classes will be included in the various overviews. This option has no effect if EXTRACT_ALL is enabled.

如果设置为yes,则doxygen将隐藏通常在类层次结构中可见的所有未记录类。如果设置为no,这些类将包括在各种概述中。如果启动 EXTRACT_ALL，则此选项无效。

The default value is: NO.

If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend (class|struct|union) declarations. If set to NO, these declarations will be included in the documentation.

如果设置为yes,doxygen将隐藏所有的friend声明。如果设置为no,这些声明将包含在文档中。

The default value is: NO.

If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any documentation blocks found inside the body of a function. If set to NO, these blocks will be appended to the function’s detailed documentation block.

如果设置为yes,则doxygen将隐藏在函数体中的任何文档块。如果设置为no,这些块将附加到函数的详细文档块中。

The default value is: NO.

The INTERNAL_DOCS tag determines if documentation that is typed after a \internal command is included. If the tag is set to NO then the documentation will be excluded. Set it to YES to include the internal documentation.

该标记决定包含\internal 命令后键入的文档。如果设置为no,则文档将被排除。设置为yes则包含内部文档。

The default value is: NO.

If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file names in lower-case letters. If set to YES, upper-case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names. Windows and Mac users are advised to set this option to NO.

The default value is: system dependent.

如果标记设置为yes,doxygen将只生成小写字母的文件名。如果设置为yes,则也允许使用大写字母。如果类或文件的名称仅在大小写上不同，并且文件系统支持大小写的文件名，则此选项非常有用。建议windows和mac用户将此选项设置为no.

If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will append additional text to a page’s title, such as Class Reference. If set to YES the compound reference will be hidden.

The default value is: NO.

如果该标记设置为no,则doxygen将在页面标题中附加额外的文本，例如Class Reference。如果设置为yes,则复合引用将隐藏。

If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of the files that are included by a file in the documentation of that file.

如果该标记设置为yes，doxygen会将文件包含的文件列表放入该文件的文档中。

The default value is: YES.

If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each grouped member an include statement to the documentation, telling the reader which file to include in order to use the member.

The default value is: NO.

如果该标记设置为yes，doxygen将为每个分组成员在文档中添加include语句，告诉读者include哪个文件才能使用该成员。

If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include files with double quotes in the documentation rather than with sharp brackets.

The default value is: NO.

如果该标记设置为yes,doxygen将在文档列出包含双引号的文件而不是包含尖括号。

If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the documentation for inline members.

The default value is: YES.

如果该标记设置为yes，则会在inline成员的文档中插入[inline]标记。

If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the (detailed) documentation of file and class members alphabetically by member name. If set to NO, the members will appear in declaration order.

The default value is: YES.

如果该标记设置为yes，则doxygen将按成员名称的字母顺序对文件和类成员的（详细）文档进行排序，如果设置为否，成员将按声明顺序出现。

If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief descriptions of file, namespace and class members alphabetically by member name. If set to NO, the members will appear in declaration order. Note that this will also influence the order of the classes in the class list.

如果设置为yes，doxygen将按成员名称的字母顺序对文件、命名空间和类成员的简要描述进行排序。如果设置为no，成员将按声明顺序出现。注意这也会影响列表中类的顺序。

The default value is: NO.

If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO the constructors will appear in the respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS .
Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief member documentation.
Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting detailed member documentation.

The default value is: NO.

如果标记设置为yes,doxygen将对类成员的（简要和详细）文档进行排序，以便首先列出构造函数和析构函数。如果设置为no,构造函数将出现在 SORT_BRIEF_DOCS 和 SORT_MEMBER_DOCS定义的相应顺序中。注意：如果SORT_BRIEF_DOCS设置为no,则忽略此选项对简要成员文档的排序；如果SORT_MEMBER_DOCS 设置为no,则忽略此选项对详细成员文档的排序。

If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy of group names into alphabetical order. If set to NO the group names will appear in their defined order.

The default value is: NO.

如果设置为yes，doxygen将按字母顺序对组名的层次结构进行排序。如果设置为否，组名将按定义的顺序显示。

If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by fully-qualified names, including namespaces. If set to NO, the class list will be sorted only by class name, not including the namespace part.
Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Note: This option applies only to the class list, not to the alphabetical list.

The default value is: NO.

如果标记设置为yes，则类列表将按完全限定的名称（包括命名空间）排序，如果设置为no,类列表将只按类名排序，不包括命名空间的部分。注意HIDE_SCOPE_NAMES标记为no时此选项不是太有用。注意此选项仅适用于类列表，不适用于字母列表。

If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still accept a match between prototype and implementation in such cases.

The default value is: NO.

如果该选项穷，并且doxygen没有对函数的所有参数进行正确的类型解析，那么它将拒绝原型与成员函数实现之间的匹配即使只有一个候选函数或者很明显通过字符串匹配选择哪个候选函数。禁用时,在这种情况下doxygen仍然接收原型和实现之间的匹配。

The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo list. This list is created by putting \todo commands in the documentation.

The default value is: YES.

此标记设置是否生成todo列表，列表在文档中通过\todo命令创建。

The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test list. This list is created by putting \test commands in the documentation.

The default value is: YES.

此标记设置是否生成测试列表，列表在文档中通过\test命令创建。

The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug list. This list is created by putting \bug commands in the documentation.

The default value is: YES.

此标记设置是否生成bug列表，列表在文档中通过\bug命令创建。

The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation.

The default value is: YES.

此标记设置是否生成弃用列表，列表在文档中通过 \deprecated命令创建。

The ENABLED_SECTIONS tag can be used to enable conditional documentation sections, marked by \if <section_label> … \endif and \cond <section_label> … \endcond blocks.

此选项设置条件文档部分，通过\if <section_label> … \endif 和\cond <section_label> … \endcond 块标记。

The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the initial value of a variable or macro / define can have for it to appear in the documentation. If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the value of individual variables and macros / defines can be controlled using \showinitializer or \hideinitializer command in the documentation regardless of this setting.

Minimum value: 0, maximum value: 10000, default value: 30.

此标记决定变量或者宏/定义的初始值的最大行数，以便在文档中显示。如果初始值设定项包含的行多余此处指定的行，则它将被隐藏。使用值0完全隐藏初始值。可以通过在文档中使用showinitializer 或 \hideinitializer命令来控制单个变量和宏/定义的外观而不考虑此设置。

Set the SHOW_USED_FILES tag to NO to disable the list of files generated at the bottom of the documentation of classes and structs. If set to YES, the list will mention the files that were used to generate the documentation.

The default value is: YES.

将SHOW_USED_FILES标记设置为no可禁用在类和结构文档底部生成的文件列表。如果设置为“是”，列表将提到用于生成文档的文件。

Set the SHOW_FILES tag to NO to disable the generation of the Files page. This will remove the Files entry from the Quick Index and from the Folder Tree View (if specified).

The default value is: YES.

Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces page. This will remove the Namespaces entry from the Quick Index and from the Folder Tree View (if specified).

The default value is: YES.

将SHOW_NAMESPACES标记设置为no以禁用生成命名空间页。这将从快速索引和文件夹树视图（如果指定）中删除命名空间条目。

The FILE_VERSION_FILTER tag can be used to specify a program or script that doxygen should invoke to get the current version for each file (typically from the version control system). Doxygen will invoke the program by executing (via popen()) the command command input-file, where command is the value of the FILE_VERSION_FILTER tag, and input-file is the name of an input file provided by doxygen. Whatever the program writes to standard output is used as the file version.
For an example see the documentation.

FILE_VERSION_FILTER标记可用于指定一个程序或脚本，doxygen应调用该程序或脚本以获取每个文件的当前版本（通常来自版本控制系统）。doxygen将通过执行（via popen（））命令命令输入文件来调用程序，其中，命令是FILE_VERSION_FILTER标记的值，输入文件是doxygen提供的输入文件的名称。程序写入标准输出的任何内容都将用作文件版本。
有关示例，请参阅文档。

The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by doxygen. The layout file controls the global structure of the generated output files in an output format independent way. To create the layout file that represents doxygen’s defaults, run doxygen with the -l option. You can optionally specify a file name after the option, if omitted DoxygenLayout.xml will be used as the name of the layout file.
Note that if you run doxygen from a directory containing a file called DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE tag is left empty.

LAYOUT_FILE标记可用于指定将由Doxygen解析的布局文件。布局文件以独立于输出格式的方式控制生成的输出文件的全局结构。要创建表示doxygen默认值的布局文件，请使用-l选项运行doxygen。您可以选择在选项后指定文件名，如果省略，则将使用doxygenlayout.xml作为布局文件的名称。
请注意，如果从包含名为doxygen layout.xml的文件的目录中运行doxygen，那么即使LAYOUT_FILE标记为空，doxygen也会自动分析它。

The CITE_BIB_FILES tag can be used to specify one or more bib files containing the reference definitions. This must be a list of .bib files. The .bib extension is automatically appended if omitted. This requires the bibtex tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style of the bibliography can be controlled using LATEX_BIB_STYLE . To use this feature you need bibtex and perl available in the search path. See also \cite for info how to create references.

CITE_BIB_FILES标记可用于指定包含引用定义的一个或多个bib文件。这必须是.bib文件的列表。如果省略，.bib扩展名将自动附加。这需要安装BibTex工具。更多信息请参见https://en.wikipedia.org/wiki/bibtex。对于LaTeX ，可以使用LATEX_BIB_STYLE的样式。要使用此功能，需要在搜索路径中提供bibtex和perl。有关如何创建引用的信息，请参见 \cite。

标签：Doxygen,set,NO,wizard,value,will,doxygen,Build,YES
来源： https://blog.csdn.net/luoshabugui/article/details/100565622