Doxygen wizard - Expert - Messages Input

写在前面

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

Messages

• QUIET

The QUIET tag can be used to turn on/off the messages that are generated to standard output by doxygen. If QUIET is set to YES this implies that the messages are off.

The default value is: NO.

该标记可用于打开/关闭由doxygen生成到标准输出的消息。如果设置设置为yes,则表示消息已关闭。

• WARNINGS

The WARNINGS tag can be used to turn on/off the warning messages that are generated to standard error (stderr) by doxygen. If WARNINGS is set to YES this implies that the warnings are on.
Tip: Turn warnings on while writing the documentation.

The default value is: YES.

该标记可以用于打开/关闭由doxygen生成到标准错误（stderr）的警告消息。如果设置为yes，则表示警告已打开。

注意：编写文档时打开警告。

• WARN_IF_UNDOCUMENTED

If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag will automatically be disabled.

The default value is: YES.

如果标记设置为yes，那么doxygen将为未记录的成员生成警告。如果EXTRACT_ALL设置为yes，则该标记自动禁用。

• WARN_IF_DOC_ERROR

If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for potential errors in the documentation, such as not documenting some parameters in a documented function, or documenting parameters that don’t exist or using markup commands wrongly.

The default value is: YES.

如果标记设置为yes,doxygen将针对文档中的潜在错误生成警告，例如不在文档功能中记录某些参数，或者记录不存在的参数或者错误地使用标记命令。

• WARN_NO_PARAMDOC

This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to NO, doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of documentation. If EXTRACT_ALL is set to YES then this flag will automatically be disabled.

The default value is: NO.

该选项可以被启用以获取记录函数的警告，但是没有记录它们的参数或返回值的文档。如果设置为否，则doxygen只会警告错误或不完整的参数文档，而不会警告缺少文档。如果EXTRACT_ALL设置为yes，则该标记自动禁用。

• WARN_AS_ERROR

If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when a warning is encountered.

The default value is: NO.

如果该标记设置为yes,则当遇到警告时，doxygen将立即停止。

• WARN_FORMAT

The WARN_FORMAT tag determines the format of the warning messages that doxygen can produce. The string should contain the file, line, and text tags, which will be replaced by the file and line number from which the warning originated and the warning text. Optionally the format may contain version, which will be replaced by the version of the file (if it could be obtained via FILE_VERSION_FILTER )

The default value is: file:line: $text.

该标记决定了doxygen生成的警告消息的格式。字符串应包含￥file,line,和text标记，这些标记将由发出警告的文件和行号以及警告文本替换。可选的格式可能包括$version，它将被文件的版本替换（如果可以通过FILE_VERSION_FILTER 获取）

• WARN_LOGFILE

The WARN_LOGFILE tag can be used to specify a file to which warning and error messages should be written. If left blank the output is written to standard error (stderr).

该标记可用于指定应向其写入警告和错误消息的文件。如果留空，输出将写入标准错误（stderr）。

Input

• INPUT

The INPUT tag is used to specify the files and/or directories that contain documented source files. You may enter file names like myfile.cpp or directories like /usr/src/myproject. Separate the files or directories with spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Note: If this tag is empty the current directory is searched.

该标记用于指定包含文档化源文件的文件和/或目录。您可以输入文件名，如myfile.cpp或目录，如/usr/src/myproject。用空格分隔文件或目录。另请参见 FILE_PATTERNS 和 EXTENSION_MAPPING
注意：如果此标记为空，则搜索当前目录。

• INPUT_ENCODING

This tag can be used to specify the character encoding of the source files that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See the libiconv documentation for the list of possible encodings.

The default value is: UTF-8.

此标记可用于指定Doxygen解析的源文件的字符编码。在内部，doxygen使用UTF-8编码。doxygen使用libiconv（或内置于libc中的iconv）进行代码转换。有关可能的编码列表，请参阅libiconv文档。

• FILE_PATTERNS

If the value of the INPUT tag contains directories, you can use the FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and *.h) to filter out the source-files in the directories.
Note that for custom extensions or not directly supported extensions you also need to set EXTENSION_MAPPING for the extension otherwise the files are not read by doxygen.
If left blank the following patterns are tested:
*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.

如果INPUT标记的值包含目录，则可以使用FILE_PATTERNS标记指定一个或多个通配符模式（如.cpp和.h）来筛选目录中的源文件。

请注意，对于自定义扩展名或不直接支持的扩展名，您还需要为扩展名设置扩展名映射，否则doxygen不会读取文件。

如果留空，则测试以下模式：

*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, .qsF和ice。

• RECURSIVE

The RECURSIVE tag can be used to specify whether or not subdirectories should be searched for input files as well.

The default value is: NO.

该标记用于指定是否也应搜索输入文件的子目录。

• EXCLUDE

The EXCLUDE tag can be used to specify files and/or directories that should be excluded from the INPUT source files. This way you can easily exclude a subdirectory from a directory tree whose root is specified with the INPUT tag.
Note that relative paths are relative to the directory from which doxygen is run.

该标记可用于指定应从INPUT 源文件中排除的文件和/或目录。这样，您可以很容易地从目录树中排除子目录，该目录树的根目录是用 INPUT 标记指定的。
请注意，相对路径是相对于运行doxygen的目录。

• EXCLUDE_SYMLINKS

The EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories that are symbolic links (a Unix file system feature) are excluded from the input.

The default value is: NO.

该标记可用于选择是否从输入中排除作为符号链接（Unix文件系统功能）的文件或目录。

• EXCLUDE_PATTERNS

If the value of the INPUT tag contains directories, you can use the EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude certain files from those directories.
Note that the wildcards are matched against the file with absolute path, so to exclude all test directories for example use the pattern /test/

如果INPUT标记的值包含目录，则可以使用EXCLUDE_PATTERNS标记指定一个或多个通配符模式以从这些目录中排除某些文件。
注意，通配符与具有绝对路径的文件匹配，因此要排除所有测试目录，例如使用模式/test/

• EXCLUDE_SYMBOLS

The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output. The symbol name can be a fully qualified name, a word, or if the wildcard * is used, a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
Note that the wildcards are matched against the file with absolute path, so to exclude all test directories use the pattern /test/

该标记可用于指定一个或多个应从输出中排除的符号名（名称空间、类、函数等）。符号名称可以是完全限定的名称、单词，或者如果使用通配符*，则可以是子字符串。示例：ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
注意，通配符与具有绝对路径的文件匹配，因此要排除所有测试目录，请使用模式/test/

• EXAMPLE_PATH

The EXAMPLE_PATH tag can be used to specify one or more files or directories that contain example code fragments that are included (see the \include command).

该标记可用于指定包含示例代码片段的一个或多个文件或目录（请参见\include命令）。

• EXAMPLE_PATTERNS

If the value of the EXAMPLE_PATH tag contains directories, you can use the EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and *.h) to filter out the source-files in the directories. If left blank all files are included.

如果 EXAMPLE_PATH 标记的值包含目录，则可以使用EXAMPLE_PATTERNS标记指定一个或多个通配符模式（如.cpp和.h）来筛选目录中的源文件。如果留空，则包括所有文件。

• EXAMPLE_RECURSIVE

If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be searched for input files to be used with the \include or \dontinclude commands irrespective of the value of the RECURSIVE tag.

The default value is: NO.

如果该标记设置为yes,则无论 RECURSIVE标记的值如何，都将搜索子目录中与\include或\dontinclude命令一起使用的输入文件。

• IMAGE_PATH

The IMAGE_PATH tag can be used to specify one or more files or directories that contain images that are to be included in the documentation (see the \image command).

该标记可用于指定一个或多个文件或目录，其中包含要包含在文档中的图像（请参见\image命令）。

• INPUT_FILTER

The INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filter for each input file. Doxygen will invoke the filter program by executing (via popen()) the command:

where is the value of the INPUT_FILTER tag, and is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. If FILTER_PATTERNS is specified, this tag will be ignored.
Note that the filter must not add or remove lines; it is applied before the code is scanned, but not when the output code is generated. If lines are added or removed, the anchors will not be placed correctly.
Note that for custom extensions or not directly supported extensions you also need to set EXTENSION_MAPPING for the extension otherwise the files are not properly processed by doxygen.

该标记可用于指定一个程序，doxygen应调用该程序来为每个输入文件进行筛选。doxygen将通过执行（via popen（））命令来调用过滤器程序：

其中，是输入过滤器标记的值，是输入文件的名称。然后，doxygen将使用过滤器程序写入标准输出的输出。如果指定了 FILTER_PATTERNS，则将忽略此标记。
请注意，过滤器不能添加或删除行；它是在扫描代码之前应用的，而不是在生成输出代码时应用的。如果添加或删除线，锚定将无法正确放置。
请注意，对于自定义扩展名或不直接支持的扩展名，您还需要为扩展名设置EXTENSION_MAPPING，否则doxygen无法正确处理文件。

• FILTER_PATTERNS

The FILTER_PATTERNS tag can be used to specify filters on a per file pattern basis. Doxygen will compare the file name with each pattern and apply the filter if there is a match. The filters are a list of the form: pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how filters are used. If the FILTER_PATTERNS tag is empty or if none of the patterns match the file name, INPUT_FILTER is applied.
Note that for custom extensions or not directly supported extensions you also need to set EXTENSION_MAPPING for the extension otherwise the files are not properly processed by doxygen.

该标记可用于按文件模式指定筛选器。doxygen会将文件名与每个模式进行比较，并在匹配的情况下应用过滤器。这些过滤器是以下形式的列表：pattern=filter（如*.cpp=my-cpp-filter）。有关如何使用过滤器的详细信息，请参阅INPUT_FILTER。如果FILTER_PATTERNS标记为空，或者没有一个模式与文件名匹配，则应用 INPUT_FILTER。
请注意，对于自定义扩展名或不直接支持的扩展名，您还需要为扩展名设置EXTENSION_MAPPING，否则doxygen无法正确处理文件。

• FILTER_SOURCE_FILES

If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using INPUT_FILTER ) will also be used to filter the input files that are used for producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).

The default value is: NO.

如果FILTER_SOURCE_FILES标记设置为yes，则输入筛选器（如果设置使用INPUT_FILTER）也将用于筛选用于生成要浏览的源文件的输入文件（即当SOURCE_BROWSER设置为yes时）。

• FILTER_SOURCE_PATTERNS

The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file pattern. A pattern will override the setting for FILTER_PATTERN (if any) and it is also possible to disable source filtering for a specific pattern using *.ext= (so without naming a filter).

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

该标记可用于指定每个文件模式的源筛选器。模式将覆盖FILTER_PATTERN（如果有）的设置，也可以使用*.ext=（所以不命名过滤器）禁用特定模式的源过滤。
此标记要求将标记FILTER_SOURCE_FILES设置为yes。

• USE_MDFILE_AS_MAINPAGE

If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that is part of the input, its contents will be placed on the main page (index.html). This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the doxygen output.

该标记指作为输入一部分的标记文件的名称，则其内容将放在主页（index.html）上。如果您在上有一个项目（例如GitHub），并且希望为doxygen输出重用介绍页，那么这将非常有用。

标签：files,doxygen,标记,wizard,Messages,FILTER,Doxygen,INPUT,tag
来源： https://blog.csdn.net/luoshabugui/article/details/100565679