中文配置 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

supperthomas opened this issue Jan 10, 2025 · 0 comments

Owner

supperthomas commented Jan 10, 2025

Doxyfile 配置文件

项目相关配置选项

DOXYFILE_ENCODING

默认值: UTF-8
描述: 指定配置文件中所有字符的编码。Doxygen 使用 libiconv 进行字符编码转换。

PROJECT_NAME

默认值: "RT-Thread RTOS"
描述: 项目的名称，用于生成文档的标题和页面中的其他位置。

PROJECT_NUMBER

默认值: 1.2.0
描述: 项目的版本号或修订号，便于归档生成的文档。

PROJECT_BRIEF

默认值: "An open source embedded real-time operating system"
描述: 项目的简要描述，显示在每个页面的顶部，帮助用户快速了解项目的用途。

PROJECT_LOGO

默认值: ./images/rtthread_logo.png
描述: 指定项目的 Logo，Logo 的最大高度不应超过 55 像素，最大宽度不应超过 200 像素。

PROJECT_ICON

默认值: 空
描述: 指定项目的图标，显示在 HTML 文档的标签页中。

OUTPUT_DIRECTORY

默认值: .
描述: 指定生成的文档的输出目录。如果使用相对路径，则相对于 Doxygen 启动时的目录。

CREATE_SUBDIRS

默认值: NO
描述: 如果设置为 YES，Doxygen 将在每个输出格式的目录下创建最多 4096 个子目录，并将生成的文件分布在这些子目录中。

CREATE_SUBDIRS_LEVEL

默认值: 8
描述: 控制创建子目录的层级数。每增加一级，目录数量翻倍。

ALLOW_UNICODE_NAMES

默认值: NO
描述: 如果设置为 YES，Doxygen 将允许生成的文件名中包含非 ASCII 字符。

OUTPUT_LANGUAGE

默认值: English
描述: 指定生成文档的语言。

BRIEF_MEMBER_DESC

默认值: NO
描述: 如果设置为 YES，Doxygen 将在文件和类文档中列出成员后包含简要描述。

REPEAT_BRIEF

默认值: YES
描述: 如果设置为 YES，Doxygen 将在详细描述前重复简要描述。

ABBREVIATE_BRIEF

默认值: "The $name class" "The $name widget" "The $name file" is provides specifies contains represents a an the
描述: 定义简要描述的缩写规则。

ALWAYS_DETAILED_SEC

默认值: YES
描述: 如果设置为 YES，即使只有简要描述，Doxygen 也会生成详细描述部分。

INLINE_INHERITED_MEMB

默认值: NO
描述: 如果设置为 YES，Doxygen 将在类的文档中显示所有继承的成员，就像它们是普通成员一样。

FULL_PATH_NAMES

默认值: YES
描述: 如果设置为 YES，Doxygen 将在文件列表和头文件中显示文件的完整路径。

STRIP_FROM_PATH

默认值: 空
描述: 指定要从路径中剥离的部分，以便在文件列表中显示相对路径。

STRIP_FROM_INC_PATH

默认值: 空
描述: 指定要从包含路径中剥离的部分。

SHORT_NAMES

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成较短的文件名（但可读性较差）。

JAVADOC_AUTOBRIEF

默认值: NO
描述: 如果设置为 YES，Doxygen 将解释 Javadoc 风格的注释的第一行作为简要描述。

JAVADOC_BANNER

默认值: NO
描述: 如果设置为 YES，Doxygen 将解释类似 /*************** 的行作为 Javadoc 风格的注释横幅。

QT_AUTOBRIEF

默认值: NO
描述: 如果设置为 YES，Doxygen 将解释 Qt 风格的注释的第一行作为简要描述。

MULTILINE_CPP_IS_BRIEF

默认值: NO
描述: 如果设置为 YES，Doxygen 将多行 C++ 注释块视为简要描述。

PYTHON_DOCSTRING

默认值: YES
描述: 如果设置为 NO，Doxygen 将解释 Python 文档字符串中的特殊命令。

INHERIT_DOCS

默认值: YES
描述: 如果设置为 YES，未记录的成员将继承其重载的成员的文档。

SEPARATE_MEMBER_PAGES

默认值: NO
描述: 如果设置为 YES，Doxygen 将为每个成员生成单独的页面。

TAB_SIZE

默认值: 4
描述: 指定代码片段中 Tab 的空格数。

ALIASES

默认值: 空
描述: 定义别名，可以在文档中使用这些别名作为命令。

OPTIMIZE_OUTPUT_FOR_C

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成更适合 C 语言的输出。

OPTIMIZE_OUTPUT_JAVA

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更适合 Java 或 Python 语言的输出。

OPTIMIZE_FOR_FORTRAN

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更适合 Fortran 语言的输出。

OPTIMIZE_OUTPUT_VHDL

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更适合 VHDL 语言的输出。

OPTIMIZE_OUTPUT_SLICE

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更适合 Slice 语言的输出。

EXTENSION_MAPPING

默认值: 空
描述: 指定文件扩展名与解析器的映射关系。

MARKDOWN_SUPPORT

默认值: YES
描述: 如果设置为 YES，Doxygen 将预处理所有注释为 Markdown 格式。

TOC_INCLUDE_HEADINGS

默认值: 5
描述: 指定 Markdown 标题的层级，自动包含在目录中。

MARKDOWN_ID_STYLE

默认值: DOXYGEN
描述: 指定 Markdown 标题标识符的生成算法。

AUTOLINK_SUPPORT

默认值: YES
描述: 如果设置为 YES，Doxygen 将自动链接文档中的类和命名空间。

AUTOLINK_IGNORE_WORDS

默认值: 空
描述: 指定自动链接生成时忽略的单词列表。

BUILTIN_STL_SUPPORT

默认值: NO
描述: 如果设置为 YES，Doxygen 将匹配包含 STL 类的函数声明和定义。

CPP_CLI_SUPPORT

默认值: NO
描述: 如果设置为 YES，Doxygen 将启用对 C++/CLI 语言的解析支持。

SIP_SUPPORT

默认值: NO
描述: 如果设置为 YES，Doxygen 将解析 SIP 源文件。

IDL_PROPERTY_SUPPORT

默认值: YES
描述: 如果设置为 YES，Doxygen 将替换 IDL 中的 getter 和 setter 方法为属性。

DISTRIBUTE_GROUP_DOC

默认值: NO
描述: 如果设置为 YES，Doxygen 将重用组中第一个成员的文档。

GROUP_NESTED_COMPOUNDS

默认值: NO
描述: 如果设置为 YES，Doxygen 将嵌套的类和结构体添加到同一组中。

SUBGROUPING

默认值: YES
描述: 如果设置为 YES，Doxygen 将允许将同一类型的类成员分组为子组。

INLINE_GROUPED_CLASSES

默认值: NO
描述: 如果设置为 YES，Doxygen 将在组内显示类、结构体和联合体，而不是在单独的页面上。

INLINE_SIMPLE_STRUCTS

默认值: NO
描述: 如果设置为 YES，Doxygen 将在定义它们的范围内内联显示简单的结构体、类和联合体。

TYPEDEF_HIDES_STRUCT

默认值: NO
描述: 如果设置为 YES，Doxygen 将把结构体、联合体或枚举的 typedef 文档化为具有 typedef 名称的结构体、联合体或枚举。

LOOKUP_CACHE_SIZE

默认值: 0
描述: 指定符号查找缓存的大小。

NUM_PROC_THREADS

默认值: 1
描述: 指定 Doxygen 在处理期间允许使用的线程数。

TIMESTAMP

默认值: NO
描述: 如果设置为 YES，Doxygen 将在每个生成的页面中包含生成日期或时间。

构建相关配置选项

EXTRACT_ALL

默认值: NO
描述: 如果设置为 YES，Doxygen 将假定所有实体都已文档化，即使没有文档。

EXTRACT_PRIVATE

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含类的所有私有成员。

EXTRACT_PRIV_VIRTUAL

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含类的私有虚方法。

EXTRACT_PACKAGE

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含具有包或内部作用域的所有成员。

EXTRACT_STATIC

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含文件的所有静态成员。

EXTRACT_LOCAL_CLASSES

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含在源文件中本地定义的类和结构体。

EXTRACT_LOCAL_METHODS

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含在实现部分定义但未在接口中定义的本地方法。

EXTRACT_ANON_NSPACES

默认值: NO
描述: 如果设置为 YES，Doxygen 将提取匿名命名空间的成员。

RESOLVE_UNNAMED_PARAMS

默认值: YES
描述: 如果设置为 YES，Doxygen 将根据定义确定未命名参数的名称。

HIDE_UNDOC_MEMBERS

默认值: YES
描述: 如果设置为 YES，Doxygen 将隐藏文档化类或文件中的未记录成员。

HIDE_UNDOC_CLASSES

默认值: YES
描述: 如果设置为 YES，Doxygen 将隐藏未记录的类。

HIDE_UNDOC_NAMESPACES

默认值: YES
描述: 如果设置为 YES，Doxygen 将隐藏未记录的命名空间。

HIDE_FRIEND_COMPOUNDS

默认值: NO
描述: 如果设置为 YES，Doxygen 将隐藏所有友元声明。

HIDE_IN_BODY_DOCS

默认值: NO
描述: 如果设置为 YES，Doxygen 将隐藏函数体内的文档块。

INTERNAL_DOCS

默认值: NO
描述: 如果设置为 YES，Doxygen 将包含 \internal 命令后的文档。

CASE_SENSE_NAMES

默认值: NO
描述: 如果设置为 YES，Doxygen 将区分大小写处理文件名。

HIDE_SCOPE_NAMES

默认值: NO
描述: 如果设置为 YES，Doxygen 将隐藏成员的完整类和命名空间作用域。

HIDE_COMPOUND_REFERENCE

默认值: NO
描述: 如果设置为 YES，Doxygen 将隐藏页面标题中的附加文本，如“类参考”。

SHOW_HEADERFILE

默认值: YES
描述: 如果设置为 YES，Doxygen 将显示使用类时需要包含的头文件。

SHOW_INCLUDE_FILES

默认值: YES
描述: 如果设置为 YES，Doxygen 将在文件的文档中列出包含的文件。

SHOW_GROUPED_MEMB_INC

默认值: NO
描述: 如果设置为 YES，Doxygen 将为每个分组成员添加包含语句。

FORCE_LOCAL_INCLUDES

默认值: NO
描述: 如果设置为 YES，Doxygen 将在文档中使用双引号列出包含文件。

INLINE_INFO

默认值: YES
描述: 如果设置为 YES，Doxygen 将在内联成员的文档中插入 [inline] 标签。

SORT_MEMBER_DOCS

默认值: NO
描述: 如果设置为 YES，Doxygen 将按成员名称对文件和类成员的详细文档进行排序。

SORT_BRIEF_DOCS

默认值: NO
描述: 如果设置为 YES，Doxygen 将按成员名称对文件、命名空间和类成员的简要描述进行排序。

SORT_MEMBERS_CTORS_1ST

默认值: YES
描述: 如果设置为 YES，Doxygen 将构造函数和析构函数列在类成员文档的最前面。

SORT_GROUP_NAMES

默认值: NO
描述: 如果设置为 YES，Doxygen 将按字母顺序对组名进行排序。

SORT_BY_SCOPE_NAME

默认值: YES
描述: 如果设置为 YES，Doxygen 将按完全限定名称对类列表进行排序。

STRICT_PROTO_MATCHING

默认值: NO
描述: 如果设置为 YES，Doxygen 将严格匹配函数原型和实现。

GENERATE_TODOLIST

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成待办事项列表。

GENERATE_TESTLIST

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成测试列表。

GENERATE_BUGLIST

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成错误列表。

GENERATE_DEPRECATEDLIST

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成已弃用列表。

ENABLED_SECTIONS

默认值: 空
描述: 启用条件文档部分。

MAX_INITIALIZER_LINES

默认值: 30
描述: 指定变量或宏的初始值在文档中显示的最大行数。

SHOW_USED_FILES

默认值: NO
描述: 如果设置为 YES，Doxygen 将在类和结构体的文档底部列出使用的文件。

SHOW_FILES

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成文件页面。

SHOW_NAMESPACES

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成命名空间页面。

FILE_VERSION_FILTER

默认值: 空
描述: 指定用于获取文件版本的程序或脚本。

LAYOUT_FILE

默认值: 空
描述: 指定布局文件，控制生成输出文件的全局结构。

CITE_BIB_FILES

默认值: 空
描述: 指定包含参考文献定义的 .bib 文件。

EXTERNAL_TOOL_PATH

默认值: 空
描述: 指定外部工具的路径。

警告和进度消息相关配置选项

QUIET

默认值: NO
描述: 如果设置为 YES，Doxygen 将关闭标准输出中的消息。

WARNINGS

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成警告消息。

WARN_IF_UNDOCUMENTED

默认值: YES
描述: 如果设置为 YES，Doxygen 将为未记录的成员生成警告。

WARN_IF_DOC_ERROR

默认值: YES
描述: 如果设置为 YES，Doxygen 将为文档中的潜在错误生成警告。

WARN_IF_INCOMPLETE_DOC

默认值: YES
描述: 如果设置为 YES，Doxygen 将为不完整的函数参数文档生成警告。

WARN_NO_PARAMDOC

默认值: NO
描述: 如果设置为 YES，Doxygen 将为没有参数或返回值文档的函数生成警告。

WARN_IF_UNDOC_ENUM_VAL

默认值: NO
描述: 如果设置为 YES，Doxygen 将为未记录的枚举值生成警告。

WARN_LAYOUT_FILE

默认值: YES
描述: 如果设置为 YES，Doxygen 将为布局文件中的问题生成警告。

WARN_AS_ERROR

默认值: FAIL_ON_WARNINGS
描述: 如果设置为 YES，Doxygen 将在遇到警告时立即停止。

WARN_FORMAT

默认值: "$file:$line: $text"
描述: 指定警告消息的格式。

WARN_LINE_FORMAT

默认值: "at line $line of file $file"
描述: 指定警告消息中行号的格式。

WARN_LOGFILE

默认值: 空
描述: 指定将警告和错误消息写入的文件。

输入文件相关配置选项

INPUT

默认值: ../../src ../../include . ../../components/finsh ../../components/drivers/include/drivers ../../components/dfs/dfs_v2/src ../../components/dfs/dfs_v2/include
描述: 指定包含文档化源文件的文件和目录。

INPUT_ENCODING

默认值: UTF-8
描述: 指定源文件的字符编码。

INPUT_FILE_ENCODING

默认值: 空
描述: 指定每个文件模式的字符编码。

FILE_PATTERNS

默认值: *.c *.cc *.cpp *.h *.inc
描述: 指定输入文件的通配符模式。

RECURSIVE

默认值: NO
描述: 如果设置为 YES，Doxygen 将递归搜索子目录中的输入文件。

EXCLUDE

默认值: .svn
描述: 指定要从输入源文件中排除的文件和目录。

EXCLUDE_SYMLINKS

默认值: NO
描述: 如果设置为 YES，Doxygen 将排除符号链接的文件和目录。

EXCLUDE_PATTERNS

默认值: 空
描述: 指定要从输入目录中排除的文件模式。

EXCLUDE_SYMBOLS

默认值: 空
描述: 指定要从输出中排除的符号名称。

EXAMPLE_PATH

默认值: 空
描述: 指定包含示例代码片段的文件或目录。

EXAMPLE_PATTERNS

默认值: *
描述: 指定示例代码片段的通配符模式。

EXAMPLE_RECURSIVE

默认值: NO
描述: 如果设置为 YES，Doxygen 将递归搜索子目录中的示例文件。

IMAGE_PATH

默认值: ./images
描述: 指定包含图像的文件或目录。

INPUT_FILTER

默认值: 空
描述: 指定用于过滤每个输入文件的程序。

FILTER_PATTERNS

默认值: 空
描述: 指定每个文件模式的过滤器。

FILTER_SOURCE_FILES

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用输入过滤器过滤用于生成源文件的输入文件。

FILTER_SOURCE_PATTERNS

默认值: 空
描述: 指定每个文件模式的源过滤器。

USE_MDFILE_AS_MAINPAGE

默认值: 空
描述: 指定用作主页的 Markdown 文件。

IMPLICIT_DIR_DOCS

默认值: YES
描述: 如果设置为 YES，Doxygen 将使用子目录中的 README.md 文件作为该子目录的文档。

FORTRAN_COMMENT_AFTER

默认值: 72
描述: 指定 Fortran 代码中自动注释开始的位置。

源文件浏览相关配置选项

SOURCE_BROWSER

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成源文件列表。

INLINE_SOURCES

默认值: NO
描述: 如果设置为 YES，Doxygen 将直接将函数体、多行宏、枚举或列表初始化变量包含在文档中。

STRIP_CODE_COMMENTS

默认值: YES
描述: 如果设置为 YES，Doxygen 将隐藏生成的源代码片段中的特殊注释块。

REFERENCED_BY_RELATION

默认值: NO
描述: 如果设置为 YES，Doxygen 将为每个文档化实体列出所有引用它的文档化函数。

REFERENCES_RELATION

默认值: NO
描述: 如果设置为 YES，Doxygen 将为每个文档化函数列出所有它调用/使用的文档化实体。

REFERENCES_LINK_SOURCE

默认值: YES
描述: 如果设置为 YES，Doxygen 将从函数引用链接到源代码。

SOURCE_TOOLTIPS

默认值: YES
描述: 如果设置为 YES，Doxygen 将在源代码中的超链接上显示工具提示。

USE_HTAGS

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用 htags 工具生成源代码的 HTML 文件。

VERBATIM_HEADERS

默认值: NO
描述: 如果设置为 YES，Doxygen 将为每个类生成头文件的逐字副本。

CLANG_ASSISTED_PARSING

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用 clang 解析器进行更准确的解析。

CLANG_ADD_INC_PATHS

默认值: YES
描述: 如果设置为 YES，Doxygen 将将每个输入文件的目录添加到包含路径中。

CLANG_OPTIONS

默认值: 空
描述: 指定传递给 clang 解析器的命令行选项。

CLANG_DATABASE_PATH

默认值: 空
描述: 指定包含 compile_commands.json 文件的目录路径。

字母类索引相关配置选项

ALPHABETICAL_INDEX

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成所有化合物的字母索引。

IGNORE_PREFIX

默认值: 空
描述: 指定生成索引标题时要忽略的前缀。

HTML 输出相关配置选项

GENERATE_HTML

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成 HTML 输出。

HTML_OUTPUT

默认值: html
描述: 指定 HTML 文档的输出目录。

HTML_FILE_EXTENSION

默认值: .html
描述: 指定生成的 HTML 页面的文件扩展名。

HTML_HEADER

默认值: 空
描述: 指定用户定义的 HTML 头文件。

HTML_FOOTER

默认值: 空
描述: 指定用户定义的 HTML 页脚。

HTML_STYLESHEET

默认值: 空
描述: 指定用户定义的 CSS 样式表。

HTML_EXTRA_STYLESHEET

默认值: doxygen-awesome-css-main/doxygen-awesome.css doxygen-awesome-css-main/doxygen-awesome-sidebar-only-darkmode-toggle.css
描述: 指定额外的 CSS 样式表。

HTML_EXTRA_FILES

默认值: doxygen-awesome-css-main/doxygen-awesome-darkmode-toggle.js
描述: 指定要复制到 HTML 输出目录的额外文件。

HTML_COLORSTYLE

默认值: LIGHT
描述: 指定生成的 HTML 输出的颜色主题。

HTML_COLORSTYLE_HUE

默认值: 220
描述: 控制 HTML 输出的颜色色调。

HTML_COLORSTYLE_SAT

默认值: 100
描述: 控制 HTML 输出的颜色饱和度。

HTML_COLORSTYLE_GAMMA

默认值: 80
描述: 控制 HTML 输出的颜色伽马校正。

HTML_DYNAMIC_MENUS

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成动态菜单。

HTML_DYNAMIC_SECTIONS

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成可以隐藏和显示的部分。

HTML_CODE_FOLDING

默认值: YES
描述: 如果设置为 YES，Doxygen 将允许动态折叠和展开类和函数。

HTML_COPY_CLIPBOARD

默认值: YES
描述: 如果设置为 YES，Doxygen 将在代码和文本片段右上角显示复制图标。

HTML_PROJECT_COOKIE

默认值: 空
描述: 指定用于存储项目特定设置的键。

HTML_INDEX_NUM_ENTRIES

默认值: 100
描述: 控制初始显示的树结构索引中的条目数。

GENERATE_DOCSET

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成用于 Apple Xcode 的文档集。

DOCSET_FEEDNAME

默认值: "Doxygen generated docs"
描述: 指定文档集提要的名称。

DOCSET_FEEDURL

默认值: 空
描述: 指定文档集提要的 URL。

DOCSET_BUNDLE_ID

默认值: org.doxygen.Project
描述: 指定文档集捆绑包的唯一标识符。

DOCSET_PUBLISHER_ID

默认值: org.doxygen.Publisher
描述: 指定文档集发布者的唯一标识符。

DOCSET_PUBLISHER_NAME

默认值: Publisher
描述: 指定文档集发布者的名称。

GENERATE_HTMLHELP

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成 HTML 帮助文件。

CHM_FILE

默认值: 空
描述: 指定生成的 .chm 文件的文件名。

HHC_LOCATION

默认值: 空
描述: 指定 HTML 帮助编译器的路径。

GENERATE_CHI

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成单独的 .chi 索引文件。

CHM_INDEX_ENCODING

默认值: 空
描述: 指定 HTML 帮助索引的编码。

BINARY_TOC

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成二进制目录。

TOC_EXPAND

默认值: NO
描述: 如果设置为 YES，Doxygen 将在 HTML 帮助文档的目录中添加额外的项目。

SITEMAP_URL

默认值: 空
描述: 指定生成的文档在服务器上的完整 URL。

GENERATE_QHP

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成 Qt 帮助项目文件。

QCH_FILE

默认值: 空
描述: 指定生成的 .qch 文件的文件名。

QHP_NAMESPACE

默认值: org.doxygen.Project
描述: 指定 Qt 帮助项目的命名空间。

QHP_VIRTUAL_FOLDER

默认值: doc
描述: 指定 Qt 帮助项目的虚拟文件夹。

QHP_CUST_FILTER_NAME

默认值: 空
描述: 指定 Qt 帮助项目的自定义过滤器名称。

QHP_CUST_FILTER_ATTRS

默认值: 空
描述: 指定 Qt 帮助项目的自定义过滤器属性。

QHP_SECT_FILTER_ATTRS

默认值: 空
描述: 指定 Qt 帮助项目的过滤器部分属性。

QHG_LOCATION

默认值: 空
描述: 指定 Qt 的 qhelpgenerator 工具的路径。

GENERATE_ECLIPSEHELP

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成 Eclipse 帮助插件。

ECLIPSE_DOC_ID

默认值: org.rt-thread.api_help
描述: 指定 Eclipse 帮助插件的唯一标识符。

DISABLE_INDEX

默认值: NO
描述: 如果设置为 YES，Doxygen 将禁用 HTML 页面顶部的索引。

GENERATE_TREEVIEW

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成树状索引结构。

FULL_SIDEBAR

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成全高的侧边栏。

ENUM_VALUES_PER_LINE

默认值: 4
描述: 指定枚举值在 HTML 文档中每行显示的数量。

SHOW_ENUM_VALUES

默认值: NO
描述: 如果设置为 YES，Doxygen 将显示枚举值。

TREEVIEW_WIDTH

默认值: 250
描述: 指定树状视图的初始宽度。

EXT_LINKS_IN_WINDOW

默认值: NO
描述: 如果设置为 YES，Doxygen 将在新窗口中打开外部符号的链接。

OBFUSCATE_EMAILS

默认值: YES
描述: 如果设置为 YES，Doxygen 将混淆电子邮件地址。

HTML_FORMULA_FORMAT

默认值: png
描述: 指定公式的图像格式。

FORMULA_FONTSIZE

默认值: 10
描述: 指定 LaTeX 公式的字体大小。

FORMULA_MACROFILE

默认值: 空
描述: 指定包含 LaTeX 命令的宏文件。

USE_MATHJAX

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用 MathJax 渲染 LaTeX 公式。

MATHJAX_VERSION

默认值: MathJax_2
描述: 指定 MathJax 的版本。

MATHJAX_FORMAT

默认值: HTML-CSS
描述: 指定 MathJax 的输出格式。

MATHJAX_RELPATH

默认值: http://www.mathjax.org/mathjax
描述: 指定 MathJax 的相对路径。

MATHJAX_EXTENSIONS

默认值: 空
描述: 指定 MathJax 的扩展名。

MATHJAX_CODEFILE

默认值: 空
描述: 指定包含 MathJax 启动代码的文件。

SEARCHENGINE

默认值: YES
描述: 如果设置为 YES，Doxygen 将生成搜索框。

SERVER_BASED_SEARCH

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用 Web 服务器实现搜索引擎。

EXTERNAL_SEARCH

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用外部索引器进行搜索。

SEARCHENGINE_URL

默认值: 空
描述: 指定外部搜索引擎的 URL。

SEARCHDATA_FILE

默认值: searchdata.xml
描述: 指定未索引搜索数据的文件名。

EXTERNAL_SEARCH_ID

默认值: 空
描述: 指定项目的唯一标识符。

EXTRA_SEARCH_MAPPINGS

默认值: 空
描述: 指定额外的搜索映射。

LaTeX 输出相关配置选项

GENERATE_LATEX

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成 LaTeX 输出。

LATEX_OUTPUT

默认值: latex
描述: 指定 LaTeX 文档的输出目录。

LATEX_CMD_NAME

默认值: latex
描述: 指定 LaTeX 命令的名称。

MAKEINDEX_CMD_NAME

默认值: makeindex
描述: 指定生成索引的命令名称。

LATEX_MAKEINDEX_CMD

默认值: makeindex
描述: 指定生成索引的命令。

COMPACT_LATEX

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更紧凑的 LaTeX 文档。

PAPER_TYPE

默认值: a4
描述: 指定纸张类型。

EXTRA_PACKAGES

默认值: 空
描述: 指定额外的 LaTeX 包。

LATEX_HEADER

默认值: 空
描述: 指定用户定义的 LaTeX 头文件。

LATEX_FOOTER

默认值: 空
描述: 指定用户定义的 LaTeX 页脚。

LATEX_EXTRA_STYLESHEET

默认值: 空
描述: 指定额外的 LaTeX 样式表。

LATEX_EXTRA_FILES

默认值: 空
描述: 指定要复制到 LaTeX 输出目录的额外文件。

PDF_HYPERLINKS

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成包含超链接的 PDF 文件。

USE_PDFLATEX

默认值: NO
描述: 如果设置为 YES，Doxygen 将使用 pdflatex 生成 PDF 文件。

LATEX_BATCHMODE

默认值: NO
描述: 指定 LaTeX 在错误情况下的行为。

LATEX_HIDE_INDICES

默认值: NO
描述: 如果设置为 YES，Doxygen 将隐藏索引章节。

LATEX_BIB_STYLE

默认值: plain
描述: 指定参考文献的样式。

LATEX_EMOJI_DIRECTORY

默认值: 空
描述: 指定表情符号图像的目录。

RTF 输出相关配置选项

GENERATE_RTF

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成 RTF 输出。

RTF_OUTPUT

默认值: rtf
描述: 指定 RTF 文档的输出目录。

COMPACT_RTF

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成更紧凑的 RTF 文档。

RTF_HYPERLINKS

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成包含超链接的 RTF 文件。

RTF_STYLESHEET_FILE

默认值: 空
描述: 指定 RTF 样式表文件。

RTF_EXTENSIONS_FILE

默认值: 空
描述: 指定 RTF 扩展文件。

RTF_EXTRA_FILES

默认值: 空
描述: 指定要复制到 RTF 输出目录的额外文件。

手册页输出相关配置选项

GENERATE_MAN

默认值: NO
描述: 如果设置为 YES，Doxygen 将生成类

The text was updated successfully, but these errors were encountered:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment