标签：Doxygen set HTML wizard value tag YES GENERATE

写在前面

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

HTML

• GENERATE_HTML

If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output

The default value is: YES.

如果该标记设置为yes,则生成HTML输出

• HTML_OUTPUT

The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

The default directory is: html.

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

该标记用于指定HTML文档的放置位置。如果输入了相对路径，输出目录的值将放在它前面。

• HTML_FILE_EXTENSION

The HTML_FILE_EXTENSION tag can be used to specify the file extension for each generated HTML page (for example: .htm, .php, .asp).

The default value is: .html.

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

该标记可用于指定每个生成的html页面的文件扩展名（例如：.htm、.php、.asp）。

• HTML_HEADER

The HTML_HEADER tag can be used to specify a user-defined HTML header file for each generated HTML page. If the tag is left blank doxygen will generate a standard header.
To get valid HTML the header file that includes any scripts and style sheets that doxygen needs, which is dependent on the configuration options used (e.g. the setting GENERATE_TREEVIEW ). It is highly recommended to start with a default header using
doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
and then modify the file new_header.html. See also section “Doxygen usage” for information on how to generate the default header that doxygen normally uses.
Note: The header is subject to change so you typically have to regenerate the default header when upgrading to a newer version of doxygen.
For a description of the possible markers and block names see the documentation.

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

HTML_HEADER标记可用于为每个生成的HTML页面指定用户定义的HTML header文件。如果标记留空，那么doxygen将生成一个标准头段。
要获取有效的HTML，头文件包括Doxygen需要的任何脚本和样式表，这取决于所使用的配置选项（例如设置GENERATE_TREEVIEW）。强烈建议从默认头开始使用
doxygen-w html new_header.html new_footer.html new_stylesheet.css您的配置文件
然后修改文件new_header.html。有关如何生成Doxygen通常使用的默认头的信息，请参见“Doxygen用法”一节。
注意：头可能会更改，因此在升级到较新版本的doxygen时，通常必须重新生成默认头。
有关可能的标记和块名的描述，请参阅文档。

• HTML_FOOTER

The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each generated HTML page. If the tag is left blank doxygen will generate a standard footer. See HTML_HEADER for more information on how to generate a default footer and what special commands can be used inside the footer. See also section “Doxygen usage” for information on how to generate the default footer that doxygen normally uses.

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

HTML_FOOTER标记可用于为每个生成的HTML页面指定用户定义的HTML页脚。如果标记留空，那么doxygen将生成一个标准的页脚。有关如何生成默认页脚以及可以在页脚内使用哪些特殊命令的详细信息，请参阅 HTML_HEADER。有关如何生成Doxygen通常使用的默认页脚的信息，请参见“Doxygen用法”一节。

• HTML_STYLESHEET

The HTML_STYLESHEET tag can be used to specify a user-defined cascading style sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If left blank doxygen will generate a default style sheet. See also section “Doxygen usage” for information on how to generate the style sheet that doxygen normally uses.
Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as it is more robust and this tag (HTML_STYLESHEET) will in the future become obsolete.

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

HTML_STYLESHEET标记可用于指定每个HTML页使用的用户定义的级联样式表。它可以用来微调HTML输出的外观。如果保留空白，则doxygen将生成默认样式表。有关如何生成Doxygen通常使用的样式表的信息，请参见“Doxygen用法”一节。
注意：建议使用HTML_EXTRA_STYLESHEET 而不是这个标签，因为它更健壮，而且这个标签将来会过时。

• HTML_EXTRA_STYLESHEET

The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined cascading style sheets that are included after the standard style sheets created by doxygen. Using this option one can overrule certain style aspects. This is preferred over using HTML_STYLESHEET since it does not replace the standard style sheet and is therefore more robust against future updates. Doxygen will copy the style sheet files to the output directory.
Note: The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list).
For an example see the documentation.

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

HTML_EXTRA_STYLESHEET标记可用于指定附加的用户定义的级联样式表，这些样式表包含在doxygen创建的标准样式表之后。使用此选项可以否决某些样式方面。这比使用HTML_STYLESHEET更受欢迎，因为它不会取代标准样式表，因此对将来的更新更为可靠。doxygen将样式表文件复制到输出目录。
注意：额外样式表文件的顺序很重要（例如，列表中的最后一个样式表会否决列表中前一个样式表的设置）。
有关示例，请参阅文档。

• HTML_EXTRA_FILES

The HTML_EXTRA_FILES tag can be used to specify one or more extra images or other source files which should be copied to the HTML output directory. Note that these files will be copied to the base HTML output directory. Use the $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these files. In the HTML_STYLESHEET file, use the file name only. Also note that the files will be copied as-is; there are no commands or markers available.

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

HTML_EXTRA_FILES 标记可用于指定一个或多个额外图像或其他应复制到html输出目录的源文件。请注意，这些文件将被复制到基本的HTML输出目录。使用 HTML_HEADER和/或HTML_FOOTER文件中的$relpath^标记加载这些文件。在HTML样式表文件中，只使用文件名。还要注意，文件将按原样复制；没有可用的命令或标记。

• HTML_COLORSTYLE_HUE

The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen will adjust the colors in the style sheet and background images according to this color. Hue is specified as an angle on a colorwheel, see https://en.wikipedia.org/wiki/Hue for more information. For instance the value 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 purple, and 360 is red again.

Minimum value: 0, maximum value: 359, default value: 220.

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

HTML_COLORSTYLE_HUE标记控制html输出的颜色。Doxygen将根据此颜色调整样式表和背景图像中的颜色。色调被指定为色轮上的角度，有关详细信息，请参阅https://en.wikipedia.org/wiki/hue。例如，值0代表红色，60代表黄色，120代表绿色，180代表青色，240代表蓝色，300代表紫色，360代表红色。
最小值：0，最大值：359，默认值：220。

• HTML_COLORSTYLE_SAT

The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors in the HTML output. For a value of 0 the output will use grayscales only. A value of 255 will produce the most vivid colors.

Minimum value: 0, maximum value: 255, default value: 100.

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

HTML_COLORSTYLE_SAT标记控制html输出中颜色的纯度（或饱和度）。对于值0，输出将仅使用灰度。值255将产生最生动的颜色。
最小值：0，最大值：255，默认值：100。

• HTML_COLORSTYLE_GAMMA

The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the luminance component of the colors in the HTML output. Values below 100 gradually make the output lighter, whereas values above 100 make the output darker. The value divided by 100 is the actual gamma applied, so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not change the gamma.

Minimum value: 40, maximum value: 240, default value: 80.

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

HTML_COLORSTYLE_GAMMA标记控制应用于html输出中颜色亮度组件的gamma校正。低于100的值逐渐使输出变亮，而高于100的值则使输出变暗。除以100的值是当前应用的gamma，因此80表示0.8的gamma，220表示2.2的gamma，100不更改gamma。
最小值：40，最大值：240，默认值：80。

• HTML_TIMESTAMP

If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML page will contain the date and time when the page was generated. Setting this to YES can help to show when doxygen was last run and thus if the documentation is up to date.

The default value is: NO.

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

如果HTML_TIMESTAMP标记设置为yes，则每个生成的html页面的页脚将包含生成页面的日期和时间。将此设置为“是”有助于显示上次运行Doxygen的时间，从而显示文档是否是最新的。

• HTML_DYNAMIC_MENUS

If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML documentation will contain a main index with vertical navigation menus that are dynamically created via Javascript. If disabled, the navigation index will consists of multiple levels of tabs that are statically embedded in every HTML page. Disable this option to support browsers that do not have Javascript, like the Qt help browser.

The default value is: YES.

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

如果HTML_DYNAMIC_MENUS标记设置为yes，则生成的html文档将包含一个主索引，其中包含通过javascript动态创建的垂直导航菜单。如果禁用，导航索引将由静态嵌入到每个HTML页面中的多个级别的选项卡组成。禁用此选项以支持没有javascript的浏览器，如qt帮助浏览器。

• HTML_DYNAMIC_SECTIONS

If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML documentation will contain sections that can be hidden and shown after the page has loaded.

The default value is: NO.

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

如果标记设置为“是”，则生成的HTML文档将包含可在加载页面后隐藏和显示的部分。

• HTML_INDEX_NUM_ENTRIES

With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries shown in the various tree structured indices initially; the user can expand and collapse entries dynamically later on. Doxygen will expand the tree to such a level that at most the specified number of entries are visible (unless a fully collapsed tree already exceeds this amount). So setting the number of entries 1 will produce a full collapsed tree by default. 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default.

Minimum value: 0, maximum value: 9999, default value: 100.

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

使用HTML_INDEX_NUM_ENTRIES，您可以最初控制各种树结构索引中显示的首选条目数；用户可以稍后动态展开和折叠条目。doxygen将把树扩展到这样一个级别，最多可以看到指定数量的条目（除非完全折叠的树已经超过这个数量）。因此，默认情况下，设置条目1的数目将生成一个完全折叠的树。0是一个特殊值，代表无限数量的条目，默认情况下将导致完全展开的树。
最小值：0，最大值：9999，默认值：100。

• GENERATE_DOCSET

If the GENERATE_DOCSET tag is set to YES, additional index files will be generated that can be used as input for Apple’s Xcode 3 integrated development environment, introduced with OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a Makefile in the HTML output directory. Running make will produce the docset in that directory and running make install will install the docset in ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at startup. See https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html for more information.

The default value is: NO.

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

如果GENERATE_DOCSET标记设置为yes，将生成额外的索引文件，这些文件可作为苹果Xcode 3集成开发环境的输入，与OSX 10.5（Leopard）一起引入。要创建文档集，doxygen将在html输出目录中生成一个makefile。运行make将在该目录中生成docset，运行make install将在~/library/developer/shared/documentation/docset中安装docset，以便xcode在启动时找到它。有关详细信息，请参阅https://developer.apple.com/library/archive/featuredarticles/doxygenxcode/index.html。

• DOCSET_FEEDNAME

This tag determines the name of the docset feed. A documentation feed provides an umbrella under which multiple documentation sets from a single provider (such as a company or product suite) can be grouped.

The default value is: Doxygen generated docs.

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

此标记确定Docset源的名称。文档提要提供了一个保护伞，在该保护伞下，可以对来自单个提供者（如公司或产品套件）的多个文档集进行分组。

• DOCSET_BUNDLE_ID

This tag specifies a string that should uniquely identify the documentation set bundle. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen will append .docset to the name.

The default value is: org.doxygen.Project.

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

此标记指定一个字符串，该字符串应唯一标识文档集束。这应该是反向域名样式的字符串，例如com.mycompany.mydocset。doxygen将在名称后面附加.docset。

• DOCSET_PUBLISHER_ID

The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet.documentation.

The default value is: org.doxygen.Publisher.

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

DOCSET_PUBLISHER_ID标记指定一个字符串，该字符串应唯一标识文档发布者。这应该是反向域名样式的字符串，例如com.mycompany.mydocset.documentation。

• DOCSET_PUBLISHER_NAME

The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.

The default value is: Publisher.

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

DOCSET_PUBLISHER_NAME标记标识文档发布者。
默认值为：publisher。

• GENERATE_HTMLHELP

If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three additional HTML index files: index.hhp, index.hhc, and index.hhk. The index.hhp is a project file that can be read by Microsoft’s HTML Help Workshop on Windows.
The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compiled HTML file (.chm). Compiled HTML files are now used as the Windows 98 help format, and will replace the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files.

The default value is: NO.

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

如果将GENERATE_HTMLHELP标记设置为yes，那么doxygen将生成三个额外的HTML索引文件：index.hhp、index.hhc和index.hhk。hhp是一个项目文件，可以被微软的Windows HTML帮助工具读取。
HTML帮助工具包含一个编译器，它可以将doxygen生成的所有HTML输出转换为一个已编译的HTML文件（.chm）。编译的HTML文件现在用作Windows 98帮助格式，将来将替换所有Windows平台上的旧Windows帮助格式（.hlp）。压缩的HTML文件还包含一个索引、一个目录，您可以在文档中搜索单词。HTML工具还包含一个压缩HTML文件的查看器。

• CHM_FILE

The CHM_FILE tag can be used to specify the file name of the resulting .chm file. You can add a path in front of the file if the result should not be written to the html output directory.

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

CHM_FILE标记可用于指定生成的.chm文件的文件名。如果不应将结果写入HTML输出目录，则可以在文件前面添加路径。

• HHC_LOCATION

The HHC_LOCATION tag can be used to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If non-empty, doxygen will try to run the HTML help compiler on the generated index.hhp.

The file has to be specified with full path.

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

HHC_LOCATION标记可用于指定HTML帮助编译器（hhc.exe）的位置（包括文件名的绝对路径）。如果非空，则doxygen将尝试在生成的index.hhp上运行HTML帮助编译器。

• GENERATE_CHI

The GENERATE_CHI flag controls if a separate .chi index file is generated (YES) or that it should be included in the master .chm file (NO).

The default value is: NO.

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

GENERATE_CHI标志控制是生成单独的.chi索引文件（是），还是应该包含在master.chm文件（否）中。

• CHM_INDEX_ENCODING

The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) and project file content.

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

CHM_INDEX_ENCODING用于编码htmlhelp索引（hhk）、内容（hhc）和项目文件内容。

• BINARY_TOC

The BINARY_TOC flag controls whether a binary table of contents is generated (YES) or a normal table of contents (NO) in the .chm file. Furthermore it enables the Previous and Next buttons.

The default value is: NO.

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

BINARY_TOC标志控制在.chm文件中是生成二进制目录（yes）还是生成普通目录（no）。此外，它还启用上一个和下一个按钮。

• TOC_EXPAND

The TOC_EXPAND flag can be set to YES to add extra items for group members to the table of contents of the HTML help documentation and to the tree view.

The default value is: NO.

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

可以将TOC_EXPAND标志设置为yes，以便将组成员的额外项添加到HTML帮助文档的目录和树视图中。

• GENERATE_QHP

If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that can be used as input for Qt’s qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated HTML documentation.

The default value is: NO.

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

如果GENERATE_QHP标记设置为yes，并且QHP_NAMESPACE 和QHP_VIRTUAL_FOLDER均已设置，则将生成一个额外的索引文件，该文件可作为qt的qhelpgenerator的输入，以生成生成HTML文档的qt压缩帮助（.qch）。

• QCH_FILE

If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify the file name of the resulting .qch file. The path specified is relative to the HTML output folder.

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

如果指定了 QHG_LOCATION 标记，则可以使用QCH_FILE标记指定生成的.qch文件的文件名。指定的路径相对于HTML输出文件夹。

• QHP_NAMESPACE

The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Namespace.

The default value is: org.doxygen.Project.

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

QHP_NAMESPACE标记指定在生成qt帮助项目输出时要使用的名称空间。有关详细信息，请参阅qt帮助项目/命名空间。
默认值为：org.doxygen.project。

• QHP_VIRTUAL_FOLDER

The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Virtual Folders.

The default value is: doc.

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

QHP_VIRTUAL_FOLDER标记指定在生成qt帮助项目输出时要使用的名称空间。有关详细信息，请参阅qt帮助项目/虚拟文件夹。
默认值为：doc。

• QHP_CUST_FILTER_NAME

If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see Qt Help Project / Custom Filters.

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

如果设置了QHP_CUST_FILTER_NAME标记，则指定要添加的自定义筛选器的名称。有关详细信息，请参阅qt帮助项目/自定义筛选器。

• QHP_CUST_FILTER_ATTRS

The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the custom filter to add. For more information please see Qt Help Project / Custom Filters.

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

QHP_CUST_FILTER_ATTRS标记指定要添加的自定义过滤器的属性列表。有关详细信息，请参阅qt帮助项目/自定义筛选器。

• QHP_SECT_FILTER_ATTRS

The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project’s filter section matches. Qt Help Project / Filter Attributes.

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

QHP_SECT_FILTER_ATTRS标记指定此项目的筛选器部分匹配的属性列表。qt帮助项目/筛选器属性。

• QHG_LOCATION

The QHG_LOCATION tag can be used to specify the location of Qt’s qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated .qhp file.

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

QHG_LOCATION标签可用于指定qhelpgenerator的位置。如果非空，则doxygen将尝试对生成的.qhp文件运行qhelpgenerator。

• GENERATE_ECLIPSEHELP

If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be generated, together with the HTML files, they form an Eclipse help plugin. To install this plugin and make it available under the help contents menu in Eclipse, the contents of the directory containing the HTML and XML files needs to be copied into the plugins directory of eclipse. The name of the directory within the plugins directory should be the same as the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.

The default value is: NO.

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

如果GENERATE_ECLIPSEHELP标记设置为“是”，则将生成其他索引文件，以及HTML文件，它们构成Eclipse帮助插件。要安装此插件并使其在Eclipse的帮助内容菜单下可用，需要将包含HTML和XML文件的目录的内容复制到Eclipse的插件目录中。插件目录中的目录名应该与ECLIPSE_DOC_ID值相同。复制后，Eclipse需要重新启动才能显示帮助。

• ECLIPSE_DOC_ID

A unique identifier for the Eclipse help plugin. When installing the plugin the directory name containing the HTML and XML files should also have this name. Each documentation set should have its own identifier.

The default value is: org.doxygen.Project.

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

Eclipse帮助插件的唯一标识符。安装插件时，包含HTML和XML文件的目录名也应具有此名称。每个文档集都应该有自己的标识符。

• DISABLE_INDEX

If you want full control over the layout of the generated HTML pages it might be necessary to disable the index and replace it with your own. The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top of each HTML page. A value of NO enables the index and the value YES disables it. Since the tabs in the index contain the same information as the navigation tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.

The default value is: NO.

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

如果要完全控制生成的HTML页面的布局，可能需要禁用索引并用自己的索引替换它。禁用索引标记可用于打开/关闭每个HTML页面顶部的压缩索引（选项卡）。如果值为no，则启用索引，如果值为yes，则禁用索引。由于索引中的选项卡包含与导航树相同的信息，因此如果还将GENERATE_TREEVIEW设置为Yes，则可以将此选项设置为Yes。

• GENERATE_TREEVIEW

The GENERATE_TREEVIEW tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. If the tag value is set to YES, a side panel will be generated containing a tree-like index structure (just like the one that is generated for HTML Help). For this to work a browser that supports JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). Windows users are probably better off using the HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET ) one can further fine-tune the look of the index. As an example, the default style sheet generated by doxygen has an example that shows how to put an image at the root of the tree instead of the PROJECT_NAME . Since the tree basically has the same information as the tab index, you could consider setting DISABLE_INDEX to YES when enabling this option.

The default value is: NO.

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

GENERATE_TREEVIEW标记用于指定是否应生成类似树的索引结构以显示层次结构信息。如果将标记值设置为“是”，将生成一个包含树型索引结构的侧面板（就像为HTML帮助生成的侧面板）。为此，需要一个支持JavaScript、DHTML、CSS和框架的浏览器（即任何现代浏览器）。Windows用户最好使用HTML帮助功能。通过自定义样式表（请参阅HTML_EXTRA_STYLESHEET），您可以进一步微调索引的外观。例如，由doxygen生成的默认样式表有一个示例，演示如何将图像放在树的根目录，而不是PROJECT_NAME。由于树基本上与选项卡索引具有相同的信息，因此在启用此选项时，可以考虑将 DISABLE_INDEX 设置为yes。

• ENUM_VALUES_PER_LINE

The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that doxygen will group on one line in the generated HTML documentation.
Note that a value of 0 will completely suppress the enum values from appearing in the overview section.

Minimum value: 0, maximum value: 20, default value: 4.

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

ENUM_VALUES_PER_LINE 标记可用于设置Doxygen将在生成的HTML文档的一行上分组的枚举值数。
请注意，值0将完全禁止枚举值出现在概述部分中。
最小值：0，最大值：20，默认值：4。

• TREEVIEW_WIDTH

If the treeview is enabled (see GENERATE_TREEVIEW ) then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown.

Minimum value: 0, maximum value: 1500, default value: 250.

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

如果启用了TreeView（请参见 GENERATE_TREEVIEW），则可以使用此标记设置显示树的帧的初始宽度（以像素为单位）。
最小值：0，最大值：1500，默认值：250。

• EXT_LINKS_IN_WINDOW

If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to external symbols imported via tag files in a separate window.

The default value is: NO.

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

如果EXT_LINKS_IN_WINDOW 选项设置为“Yes”，则Doxygen将在单独的窗口中打开指向通过标记文件导入的外部符号的链接。

• FORMULA_FONTSIZE

Use this tag to change the font size of LaTeX formulas included as images in the HTML documentation. When you change the font size after a successful doxygen run you need to manually remove any form_*.png images from the HTML output directory to force them to be regenerated.

Minimum value: 8, maximum value: 50, default value: 10.

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

使用此标记可更改HTML文档中作为图像包含的LaTeX 公式的字体大小。当成功运行doxygen后更改字体大小时，需要手动从HTML输出目录中删除任何形式的*.png图像，以强制重新生成它们。
最小值：8，最大值：50，默认值：10。

• FORMULA_TRANSPARENT

Use the FORMULA_TRANSPARENT tag to determine whether or not the images generated for formulas are transparent PNGs. Transparent PNGs are not supported properly for IE 6.0, but are supported on all modern browsers.
Note that when changing this option you need to delete any form_*.png files in the HTML output directory before the changes have effect.

The default value is: YES.

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

使用FORMULA_TRANSPARENT标记确定为公式生成的图像是否为透明PNG。IE 6.0不支持透明PNG，但所有现代浏览器都支持透明PNG。
请注意，更改此选项时，您需要在更改生效之前删除HTML输出目录中的任何表单*.png文件。

• USE_MATHJAX

Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see https://www.mathjax.org) which uses client side Javascript for the rendering instead of using pre-rendered bitmaps. Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTML output. When enabled you may also need to install MathJax separately and configure the path to it using the MATHJAX_RELPATH option.

The default value is: NO.

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

启用USE_MATHJAX选项以使用mathjax（请参阅https://www.mathjax.org）呈现 LaTeX公式，该选项使用客户端javascript进行呈现，而不是使用预渲染的位图。如果没有安装LaTex，或者希望公式在HTML输出中看起来更漂亮，请使用此选项。启用后，您可能还需要单独安装mathjax，并使用MATHJAX_RELPATH 选项配置其路径。

• MATHJAX_FORMAT

When MathJax is enabled you can set the default output format to be used for the MathJax output. See the MathJax site for more details.

Possible values are: HTML-CSS (which is slower, but has the best compatibility), NativeMML (i.e. MathML) and SVG.

The default value is: HTML-CSS.

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

启用mathjax后，可以设置用于mathjax输出的默认输出格式。有关详细信息，请参阅Mathjax网站。
可能的值有：HTML-CSS（速度较慢，但兼容性最好）、NativeMML （即mathml）和SVG。

• MATHJAX_RELPATH

When MathJax is enabled you need to specify the location relative to the HTML output directory using the MATHJAX_RELPATH option. The destination directory should contain the MathJax.js script. For instance, if the mathjax directory is located at the same level as the HTML output directory, then MATHJAX_RELPATH should be …/mathjax. The default value points to the MathJax Content Delivery Network so you can quickly see the result without installing MathJax. However, it is strongly recommended to install a local copy of MathJax from https://www.mathjax.org before deployment.

The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.

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

启用 MathJax后，需要使用MATHJAX_RELPATH选项指定相对于HTML输出目录的位置。目标目录应该包含MathJax.js脚本。例如，如果mathjax目录与html输出目录位于同一级别，那么MATHJAX_RELPATH 应该是…/mathjax。默认值指向Mathjax内容交付网络，这样您就可以在不安装Mathjax的情况下快速看到结果。但是，强烈建议在部署之前从https://www.mathjax.org安装本地Mathjax副本。
默认值为：https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/。

• MATHJAX_EXTENSIONS

The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax extension names that should be enabled during MathJax rendering. For example
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols

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

MATHJAX_EXTENSIONS标记可用于指定一个或多个Mathjax扩展名，这些扩展名应在Mathjax呈现期间启用。例如MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols

• MATHJAX_CODEFILE

The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces of code that will be used on startup of the MathJax code. See the MathJax site for more details.
For an example see the documentation.

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

MATHJAX_CODEFILE标记可用于指定一个带有javascript代码段的文件，这些代码段将在MathJax代码启动时使用。有关详细信息，请参阅Mathjax网站。
有关示例，请参阅文档。

• SEARCHENGINE

When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP ), Qt help (GENERATE_QHP ), or docsets (GENERATE_DOCSET ) there is already a search function so this one should typically be disabled. For large projects the javascript based search engine can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to search using the keyboard; to jump to the search box use + S (what the is depends on the OS and browser, but it is typically , /, or both). Inside the search box use the to jump into the search results window, the results can be navigated using the . Press to select an item or to cancel the search. The filter options can be selected when the cursor is inside the search box by pressing +. Also here use the to select a filter and or to activate or cancel the filter option.

The default value is: YES.

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

当SEARCHENGINE标记被启用时，doxygen将为HTML输出生成一个搜索框。底层的搜索引擎使用JavaScript和DHTML，应该可以在任何现代浏览器上工作。请注意，当使用HTML帮助（GENERATE_HTMLHELP）、qt帮助（GENERATE_QHP）或docset（GENERATE_DOCSET）时，已经有一个搜索函数，因此通常应该禁用该函数。对于大型项目，基于javascript的搜索引擎可能会很慢，然后启用基于服务器的搜索可能会提供更好的解决方案。可以使用键盘进行搜索；要跳转到搜索框，请使用+s（什么是取决于操作系统和浏览器，但它通常是、/或两者兼有）。在搜索框中，使用跳转到搜索结果窗口，可以使用导航结果。按选择项目，或按取消搜索。当光标位于搜索框内时，可以通过按“+”来选择过滤器选项。此外，在这里使用选择过滤器，并使用或激活或取消过滤器选项。

• SERVER_BASED_SEARCH

When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a web server instead of a web client using Javascript. There are two flavors of web server based searching depending on the EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for searching and an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing and searching needs to be provided by external tools. See the section “External Indexing and Searching” for details.

The default value is: NO.

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

启用SERVER_BASED_SEARCH标记后，将使用Web服务器而不是使用JavaScript的Web客户端来实现搜索引擎。根据EXTERNAL_SEARCH设置，有两种基于Web服务器的搜索方式。禁用后，doxygen将生成用于搜索的PHP脚本和脚本使用的索引文件。当启用EXTERNAL_SEARCH时，索引和搜索需要由外部工具提供。有关详细信息，请参阅“外部索引和搜索”一节。

• EXTERNAL_SEARCH

When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP script for searching. Instead the search results are written to an XML file which needs to be processed by an external indexer. Doxygen will invoke an external search engine pointed to by the SEARCHENGINE_URL option to obtain the search results.
Doxygen ships with an example indexer (doxyindexer) and search engine (doxysearch.cgi) which are based on the open source search engine library Xapian.
See the section “External Indexing and Searching” for details.

The default value is: NO.

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

启用EXTERNAL_SEARCH标记后，doxygen将不再生成用于搜索的PHP脚本。相反，搜索结果被写入需要由外部索引器处理的XML文件。doxygen将调用SEARCHENGINE_URL选项指向的外部搜索引擎来获取搜索结果。
doxygen附带了一个基于开源搜索引擎库Xapian的示例索引器（doxyindexer）和搜索引擎（doxysearch.cgi）。
有关详细信息，请参阅“外部索引和搜索”一节。

• SEARCHENGINE_URL

The SEARCHENGINE_URL should point to a search engine hosted by a web server which will return the search results when EXTERNAL_SEARCH is enabled.
Doxygen ships with an example indexer (doxyindexer) and search engine (doxysearch.cgi) which are based on the open source search engine library Xapian. See the section “External Indexing and Searching” for details.

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

搜索引擎的URL应该指向由Web服务器托管的搜索引擎，当启用外部搜索时，该搜索引擎将返回搜索结果。
doxygen附带了一个基于开源搜索引擎库xapian的示例索引器（doxyindexer）和搜索引擎（doxysearch.cgi）。有关详细信息，请参阅“外部索引和搜索”一节。

• SEARCHDATA_FILE

When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed search data is written to a file for indexing by an external tool. With the SEARCHDATA_FILE tag the name of this file can be specified.

The default file is: searchdata.xml.

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

当启用SERVER_BASED_SEARCH和EXTERNAL_SEARCH时，未索引的搜索数据将被写入文件，以便由外部工具进行索引。使用SEARCHDATA_FILE 标记可以指定此文件的名称。

• EXTERNAL_SEARCH_ID

When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple projects and redirect the results back to the right project.

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

当SERVER_BASED_SEARCH和 EXTERNAL_SEARCH 都启用时，EXTERNAL_SEARCH_ID标记可以用作项目的标识符。这与 EXTRA_SEARCH_MAPPINGS结合使用非常有用，可以搜索多个项目并将结果重定向回正确的项目。

• EXTRA_SEARCH_MAPPINGS

The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen projects other than the one defined by this configuration file, but that are all added to the same external search index. Each project needs to have a unique id set via EXTERNAL_SEARCH_ID . The search mapping then maps the id of to a relative location where the documentation can be found. The format is:
EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 …

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

EXTRA_SEARCH_MAPPINGS标记可用于允许搜索除此配置文件定义的项目以外的其他doxygen项目，但这些项目都添加到相同的外部搜索索引中。每个项目都需要通过EXTERNAL_SEARCH_ID设置唯一的ID。然后，搜索映射将的ID映射到可以找到文档的相对位置。格式为： EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 …

标签：Doxygen,set,HTML,wizard,value,tag,YES,GENERATE
来源： https://blog.csdn.net/luoshabugui/article/details/100565730

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。