首页 > 其他分享> > Doxygen wizard - Expert - Source Browser Index

Doxygen wizard - Expert - Source Browser Index

2019-09-05 21:06:59 作者：互联网

写在前面

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

Source Browser

SOURCE_BROWSER

If the SOURCE_BROWSER tag is set to YES then a list of source files will be generated. Documented entities will be cross-referenced with these sources.
Note: To get rid of all source code in the generated output, make sure that also VERBATIM_HEADERS is set to NO.

The default value is: NO.

如果该标记设置为yes，则将生成源文件列表。文件实体将与这些来源交叉引用。
注意：要清除生成的输出中的所有源代码，请确保也将VERBATIM_HEADERS 设置为否。

INLINE_SOURCES

Setting the INLINE_SOURCES tag to YES will include the body of functions, classes and enums directly into the documentation.

The default value is: NO.

将INLINE_SOURCES标记设置为yes将直接在文档中包含函数体、类和枚举。

STRIP_CODE_COMMENTS

Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C, C++ and Fortran comments will always remain visible.

The default value is: YES.

将STRIP_CODE_COMMENTS标记设置为yes将指示doxygen从生成的源代码片段中隐藏任何特殊的注释块。正常C、C++和FORTRAN注释将始终保持可见。

REFERENCED_BY_RELATION

If the REFERENCED_BY_RELATION tag is set to YES then for each documented entity all documented functions referencing it will be listed.

The default value is: NO.

如果该标记设置为yes，那么对于每个文档化实体，将列出引用它的所有文档化函数。

REFERENCES_RELATION

If the REFERENCES_RELATION tag is set to YES then for each documented function all documented entities called/used by that function will be listed.

The default value is: NO.

如果REFERENCES_RELATION标记设置为yes，那么对于每个文档化的函数，将列出该函数调用/使用的所有文档化实体。

REFERENCES_LINK_SOURCE

If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set to YES then the hyperlinks from functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will link to the documentation.

The default value is: YES.

如果REFERENCES_LINK_SOURCE 标记设置为yes，而SOURCE_BROWSER标记设置为yes，则REFERENCES_RELATION和REFERENCED_BY_RELATION中函数的超链接将链接到源代码。否则，它们将链接到文档。

SOURCE_TOOLTIPS

If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the source code will show a tooltip with additional information such as prototype, brief description and links to the definition and documentation. Since this will make the HTML file larger and loading of large files a bit slower, you can opt to disable this feature.

The default value is: YES.

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

如果启用了SOURCE_TOOLTIPS （默认），则将源代码中的超链接悬停将显示一个工具提示，其中包含其他信息，如原型、简要说明以及到定义和文档的链接。因为这会使HTML文件变大，并且加载大文件的速度会变慢，所以您可以选择禁用此功能。

USE_HTAGS

If the USE_HTAGS tag is set to YES then the references to source code will point to the HTML generated by the htags(1) tool instead of doxygen built-in source browser. The htags tool is part of GNU’s global source tagging system (see https://www.gnu.org/software/global/global.html). You will need version 4.8.6 or higher.
To use it do the following:

Install the latest version of global
Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
Make sure the INPUT points to the root of the source tree
Run doxygen as normal
Doxygen will invoke htags (and that will in turn invoke gtags), so these tools must be available from the command line (i.e. in the search path).
The result: instead of the source browser generated by doxygen, the links to source code will now point to the output of htags.

The default value is: NO.

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

如果该标记设置为yes，那么对源代码的引用将指向由htags（1）工具生成的HTML，而不是doxygen内置的源代码浏览器。htags工具是GNU全球源代码标记系统的一部分（参见https://www.gnu.org/software/global/global.html）。您需要4.8.6或更高版本。
要使用它，请执行以下操作：
-安装最新版本的Global
-并在配置文件中启用SOURCE_BROWSER和USE_HTAGS
-确保输入指向源树的根目录
-正常运行doxygen
doxygen将调用htags（这反过来也将调用gtags），因此这些工具必须可以从命令行（即在搜索路径中）获得。
结果：与doxygen生成的源浏览器不同，指向源代码的链接现在将指向htags的输出。

VERBATIM_HEADERS

If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this.
See also: Section \class .

The default value is: YES.

如果该标记设置为yes，那么doxygen将为指定了include的每个类生成头文件的逐字副本。设置为no以禁用此功能。
另请参见：节\class。

CLANG_ASSISTED_PARSING

If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the clang parser for more accurate parsing at the cost of reduced performance. This can be particularly helpful with template rich C++ code for which doxygen’s built-in parser lacks the necessary type information.
Note: The availability of this option depends on whether or not doxygen was generated with the -Duse_libclang=ON option for CMake.

The default value is: NO.

如果该标记设置为yes，那么doxygen将使用clang解析器以降低性能进行更精确的解析。这对于使用模板丰富的C++代码特别有用，因为DOXEGY内置的解析器缺少必要的类型信息。
注意：此选项的可用性取决于是否使用cmake的-Duse-libclang=on选项生成了doxygen。

CLANG_OPTIONS

If clang assisted parsing is enabled you can provide the compiler with command line options that you would normally use when invoking the compiler. Note that the include paths will already be set by doxygen for the files and directories specified with INPUT and INCLUDE_PATH .

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

如果启用了clang辅助解析，则可以向编译器提供在调用编译器时通常使用的命令行选项。注意，包含路径已经由doxygen为 INPUT 和INCLUDE_PATH指定的文件和目录设置。

CLANG_DATABASE_PATH

If clang assisted parsing is enabled you can provide the clang parser with the path to the compilation database used when the files were built. This is equivalent to specifying the “-p” option to a clang tool, such as clang-check. These options will then be passed to the parser.
Note: The availability of this option depends on whether or not doxygen was generated with the -Duse_libclang=ON option for CMake.

如果启用了clang辅助解析，则可以向clang分析器提供生成文件时使用的编译数据库的路径。这相当于为clang工具指定“-p”选项，例如clang-check。然后将这些选项传递给解析器。
注意：此选项的可用性取决于是否使用cmake的-Duse-libclang=on选项生成了doxygen。

Index

ALPHABETICAL_INDEX

If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or interfaces.

The default value is: YES.

如果该标记设置为yes，将生成所有混合的字母索引。如果项目包含许多类、结构、联合或接口，则启用此选项。

COLS_IN_ALPHA_INDEX

The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in which the alphabetical index list will be split.

Minimum value: 1, maximum value: 20, default value: 5.

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

该标记可用于指定要拆分字母索引列表的列数。
最小值：1，最大值：20，默认值：5。

IGNORE_PREFIX

In case all classes in a project start with a common prefix, all classes will be put under the same header in the alphabetical index. The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) that should be ignored while generating the index headers.

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

如果项目中的所有类都以一个公共前缀开头，那么所有类都将放在字母索引的同一个标题下。IGNORE_PREFIX 标记可用于指定在生成索引头时应忽略的前缀（或前缀列表）。

标签：Index,Doxygen,set,Expert,doxygen,value,will,tag,YES
来源： https://blog.csdn.net/luoshabugui/article/details/100565712