C 语言编程 — Doxygen + Graphviz 静态项目分析

目录

安装

$ yum install -y graphviz
$ yum install -y doxygen*

配置解析

• 生成配置文件

$ doxygen -s -g doxyconfig

示例：

# Doxyfile 1.8.5#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "l2fwd"
PROJECT_NUMBER         =
PROJECT_BRIEF          =
PROJECT_LOGO           =
OUTPUT_DIRECTORY       = ./docs
CREATE_SUBDIRS         = YES
OUTPUT_LANGUAGE        = Chinese
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       =
ALWAYS_DETAILED_SEC    = YES
INLINE_INHERITED_MEMB  = YES
FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        =
STRIP_FROM_INC_PATH    =
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = NO
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 4
ALIASES                =
TCL_SUBST              =
OPTIMIZE_OUTPUT_FOR_C  = YES
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
EXTENSION_MAPPING      =
MARKDOWN_SUPPORT       = YES
AUTOLINK_SUPPORT       = YES
BUILTIN_STL_SUPPORT    = NO
CPP_CLI_SUPPORT        = NO
SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
INLINE_GROUPED_CLASSES = YES
INLINE_SIMPLE_STRUCTS  = YES
TYPEDEF_HIDES_STRUCT   = NO
LOOKUP_CACHE_SIZE      = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = YES
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = YES
SHOW_INCLUDE_FILES     = YES
FORCE_LOCAL_INCLUDES   = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
STRICT_PROTO_MATCHING  = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
FILE_VERSION_FILTER    =
LAYOUT_FILE            =
CITE_BIB_FILES         =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
WARN_FORMAT            = "$file:$line: $text"
WARN_LOGFILE           =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = ./ /opt/dpdk-18.08/x86_64-native-linuxapp-gcc/include /opt/dpdk-18.08/x86_64-native-linuxapp-gcc/lib
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          =
RECURSIVE              = YES
EXCLUDE                =
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       =
EXCLUDE_SYMBOLS        =
EXAMPLE_PATH           =
EXAMPLE_PATTERNS       =
EXAMPLE_RECURSIVE      = YES
IMAGE_PATH             =
INPUT_FILTER           =
FILTER_PATTERNS        =
FILTER_SOURCE_FILES    = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = NO
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS        = YES
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 5
IGNORE_PREFIX          =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = .
HTML_FILE_EXTENSION    = .html
HTML_HEADER            =
HTML_FOOTER            =
HTML_STYLESHEET        =
HTML_EXTRA_STYLESHEET  =
HTML_EXTRA_FILES       =
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_TIMESTAMP         = NO
HTML_DYNAMIC_SECTIONS  = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET        = NO
DOCSET_FEEDNAME        = "Doxygen generated docs"
DOCSET_BUNDLE_ID       = org.doxygen.Project
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME  = Publisher
GENERATE_HTMLHELP      = NO
CHM_FILE               =
HHC_LOCATION           =
GENERATE_CHI           = NO
CHM_INDEX_ENCODING     =
BINARY_TOC             = NO
TOC_EXPAND             = NO
GENERATE_QHP           = NO
QCH_FILE               =
QHP_NAMESPACE          = org.doxygen.Project
QHP_VIRTUAL_FOLDER     = doc
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.Project
DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = ALL
ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250
EXT_LINKS_IN_WINDOW    = NO
FORMULA_FONTSIZE       = 10
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = NO
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =
SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO
EXTERNAL_SEARCH        = NO
SEARCHENGINE_URL       =
SEARCHDATA_FILE        = searchdata.xml
EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX         = NO
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4
EXTRA_PACKAGES         =
LATEX_HEADER           =
LATEX_FOOTER           =
LATEX_EXTRA_FILES      =
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = NO
LATEX_BIB_STYLE        = plain
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML           = NO
XML_OUTPUT             = xml
XML_SCHEMA             =
XML_DTD                =
XML_PROGRAMLISTING     = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK       = NO
DOCBOOK_OUTPUT         = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = NO
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  = *.c *.h
PREDEFINED             =
EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES               =
GENERATE_TAGFILE       =
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = YES
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = YES
MSCGEN_PATH            =
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
DOT_NUM_THREADS        = 2
DOT_FONTNAME           = Helvetica
DOT_FONTSIZE           = 10
DOT_FONTPATH           =
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
UML_LOOK               = YES
UML_LIMIT_NUM_FIELDS   = 10
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
GRAPHICAL_HIERARCHY    = YES
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = png
INTERACTIVE_SVG        = YES
DOT_PATH               =
DOTFILE_DIRS           = ./docs/dots
MSCFILE_DIRS           = ./docs/mscs
DOT_GRAPH_MAX_NODES    = 50
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = NO

Project related configuration options

配置项	作用
DOXYFILE_ENCODING	UTF-8，配置文件的编码格式。
PROJECT_NAME	项目名称。
PROJECT_NUMBER	项目的的版本号。
PROJECT_BRIEF	项目的简短描述。
PROJECT_LOGO	项目的 logo。
OUTPUT_DIRECTORY	./docs，输出文档的目录。
CREATE_SUBDIRS	YES，是否创建子目录。
OUTPUT_LANGUAGE	Chinese，输出文档的语言。
BRIEF_MEMBER_DESC	YES，是否在类的简介中包含成员描述。
REPEAT_BRIEF	YES，是否在详细描述中重复简介。
ABBREVIATE_BRIEF	对简介进行缩写。
ALWAYS_DETAILED_SEC	YES，是否始终在分组中生成详细页面。
INLINE_INHERITED_MEMB	YES，是否内联继承成员文档。
FULL_PATH_NAMES	YES，是否在文件列表中使用完整的路径名。
STRIP_FROM_PATH	从路径中剥离目录。
STRIP_FROM_INC_PATH	从包含文件的路径中剥离目录。
SHORT_NAMES	NO，是否使用短文件名。
JAVADOC_AUTOBRIEF	NO，是否使用 JavaDoc 风格的简介。
QT_AUTOBRIEF	NO，是否使用 Qt 风格的简介。
MULTILINE_CPP_IS_BRIEF	NO，是否允许在 C++ 注释中使用多行简介。
INHERIT_DOCS	YES，是否从父类继承文档。
SEPARATE_MEMBER_PAGES	NO，是否为每个类的成员生成单独的页面。
TAB_SIZE	4，指定选项卡的宽度。
ALIASES	定义别名。
TCL_SUBST	在 Tcl 脚本中使用的替换。
OPTIMIZE_OUTPUT_FOR_C	YES，是否对 C 语言进行优化。
OPTIMIZE_OUTPUT_JAVA	NO，是否对 Java 进行优化。
OPTIMIZE_FOR_FORTRAN	NO，是否对 Fortran 进行优化。
OPTIMIZE_OUTPUT_VHDL	NO，是否对 VHDL 进行优化。
EXTENSION_MAPPING	扩展名映射。
MARKDOWN_SUPPORT	YES，是否支持 Markdown。
AUTOLINK_SUPPORT	YES，是否自动链接 URL 和电子邮件。
BUILTIN_STL_SUPPORT	NO，是否支持 C++ STL 库。
CPP_CLI_SUPPORT	NO，是否支持 C++/CLI
SIP_SUPPORT	NO，是否支持 PyQt 代码。
IDL_PROPERTY_SUPPORT	YES，是否支持 IDL 属性。
DISTRIBUTE_GROUP_DOC	NO，是否分发分组文档。
SUBGROUPING	YES，是否分组子目录。
INLINE_GROUPED_CLASSES	YES，是否内联组中的类。
INLINE_SIMPLE_STRUCTS	YES，是否内联简单结构体。
TYPEDEF_HIDES_STRUCT	NO，是否隐藏 typedef 中的结构体。
LOOKUP_CACHE_SIZE	0，查找缓存大小。

Build related configuration options

配置项	作用
EXTRACT_ALL	YES，是否提取所有的实体。
EXTRACT_PRIVATE	YES，是否提取私有实体。
EXTRACT_PACKAGE	YES，是否提取包/命名空间中的实体。
EXTRACT_STATIC	YES，是否提取静态实体。
EXTRACT_LOCAL_CLASSES	YES，是否提取局部类的文档。
EXTRACT_LOCAL_METHODS	YES，是否提取局部类的文档。
EXTRACT_ANON_NSPACES	YES，是否提取匿名命名空间的文档。
HIDE_UNDOC_MEMBERS	NO，是否隐藏未被文档化的成员。
HIDE_UNDOC_CLASSES	NO，是否隐藏未被文档化的类。
HIDE_FRIEND_COMPOUNDS	NO，是否隐藏未被文档化的友元。
HIDE_IN_BODY_DOCS	NO，是否隐藏函数/类实现中的文档。
INTERNAL_DOCS	YES，是否包括内部文档。
CASE_SENSE_NAMES	YES，是否区分名称大小写。
HIDE_SCOPE_NAMES	YES，是否隐藏作用域限定符。
SHOW_INCLUDE_FILES	YES，是否在文档中显示包含文件。
FORCE_LOCAL_INCLUDES	YES，是否强制使用相对路径的本地包含文件。
INLINE_INFO	YES，是否提供内联函数的文档。
SORT_MEMBER_DOCS	YES，是否按照成员的出现顺序对文档进行排序。
SORT_BRIEF_DOCS	NO，是否按照类、函数、成员的简要文档排序。
SORT_MEMBERS_CTORS_1ST	NO，是否先将构造函数和析构函数排在成员列表的前面。
SORT_GROUP_NAMES	NO，是否按照组名排序。
SORT_BY_SCOPE_NAME	NO，是否按照作用域名称排序。
STRICT_PROTO_MATCHING	NO，是否对函数参数进行严格的匹配。
GENERATE_TODOLIST	YES，是否生成待办事项列表。
GENERATE_TESTLIST	YES，是否生成测试列表。
GENERATE_BUGLIST	YES，是否生成缺陷列表。
GENERATE_DEPRECATEDLIST	YES，是否生成已弃用列表。
ENABLED_SECTIONS
MAX_INITIALIZER_LINES	30，初始化器的最大行数。
SHOW_USED_FILES	YES，是否在文档中显示已使用的文件。
SHOW_FILES	YES，是否在文档中显示所有文件。
SHOW_NAMESPACES	YES，是否在文档中显示命名空间。
FILE_VERSION_FILTER	是否启用文件版本过滤器。
LAYOUT_FILE	自定义布局文件的名称。
CITE_BIB_FILES

Configuration options related to warning and progress messages

配置项	作用
QUIET	NO，是否关闭所有警告和错误消息。
WARNINGS	YES，是否启用警告消息。
WARN_IF_UNDOCUMENTED	YES，是否在文档中生成未文档化的警告。
WARN_IF_DOC_ERROR	YES，是否在文档中生成文档错误的警告。
WARN_NO_PARAMDOC	NO，是否在函数参数没有文档的情况下生成警告。
WARN_FORMAT	“$file:$line: $text”，警告消息的格式。
WARN_LOGFILE

Configuration options related to the input files

配置项	作用
INPUT	./，一个用空格分隔的模式列表，要处理的输入文件或目录的列表。
INPUT_ENCODING	UTF-8，输入文件的字符编码。
FILE_PATTERNS	一个用空格分隔的模式列表，文件名的样式。
RECURSIVE	YES，对于指定的文件夹，是否应递归地搜索其子目录。
EXCLUDE	一个用空格分隔的模式列表，指定哪些文件或目录不应包含在输入中。
EXCLUDE_SYMLINKS	NO，如果为 YES，则忽略符号链接。否则，将处理它们指向的文件。
EXCLUDE_PATTERNS	一个用空格分隔的模式列表，用于指定哪些文件或目录不应包含在 INPUT 中。默认为空。
EXCLUDE_SYMBOLS	一个用空格分隔的模式列表，用于指定哪些符号（如函数或变量）不应在生成的文档中出现。默认为空。
EXAMPLE_PATH	示例文件的路径。默认为空。
EXAMPLE_PATTERNS	一个用空格分隔的模式列表，指定应该包含哪些示例文件。默认为空。
EXAMPLE_RECURSIVE	对于指定的文件夹，是否应递归地搜索其子目录。默认为 YES。
IMAGE_PATH	包含图片的目录的路径。默认为空。
INPUT_FILTER	一个用于文件过滤的正则表达式。如果文件名与该正则表达式不匹配，则该文件将被忽略。默认为空。
FILTER_PATTERNS	一个用空格分隔的模式列表，用于指定应该过滤哪些文件。默认为空。
FILTER_SOURCE_FILES	如果为 YES，则源文件也会被过滤。否则，只有头文件会被过滤。默认为 NO。
FILTER_SOURCE_PATTERNS	：一个用空格分隔的模式列表，指定应该过滤哪些源文件。默认为空。
USE_MDFILE_AS_MAINPAGE	如果为 YES，则将第一个 Markdown 文件视为主页。否则，使用 index.h 或 index.cpp 作为主页。默认为 NO。

Configuration options related to source browsing

配置项	作用
SOURCE_BROWSER	NO，如果为 YES，则在生成的 HTML 中包括源代码。默认为 NO。
INLINE_SOURCES	NO，如果为 YES，则在 HTML 中包含内联源代码。默认为 NO。
STRIP_CODE_COMMENTS	NO，如果为 YES，则从源文件中删除注释。默认为 YES。
REFERENCED_BY_RELATION	如果为 YES，则将 “引用者” 列添加到类的成员列表中。默认为 YES。
REFERENCES_RELATION	如果为 YES，则将“ 参考” 列添加到类的成员列表中。默认为 YES。
REFERENCES_LINK_SOURCE	如果为 YES，则在生成的文档中为每个参考项添加链接。默认为 YES。
SOURCE_TOOLTIPS	YES，指示是否应该为 HTML 源代码生成工具提示。
USE_HTAGS	NO，指示是否应在 HTML 输出中使用 H 标记，而不是 CSS 样式。
VERBATIM_HEADERS	YES，如果设置为 YES，则 Doxygen 将以原样包含文本头文件，否则将按照特定的方式处理。

Configuration options related to the alphabetical class index

配置项	作用
ALPHABETICAL_INDEX	YES
COLS_IN_ALPHA_INDEX	5
IGNORE_PREFIX

Configuration options related to the HTML output

配置项	作用
GENERATE_HTML	YES
HTML_OUTPUT	.
HTML_FILE_EXTENSION	.html
HTML_HEADER
HTML_FOOTER
HTML_STYLESHEET
HTML_EXTRA_STYLESHEET
HTML_EXTRA_FILES
HTML_COLORSTYLE_HUE	220
HTML_COLORSTYLE_SAT	100
HTML_COLORSTYLE_GAMMA	80
HTML_TIMESTAMP	NO
HTML_DYNAMIC_SECTIONS	NO
HTML_INDEX_NUM_ENTRIES	100
GENERATE_DOCSET	NO
DOCSET_FEEDNAME	“Doxygen generated docs”
DOCSET_BUNDLE_ID	org.doxygen.Project
DOCSET_PUBLISHER_ID	org.doxygen.Publisher
DOCSET_PUBLISHER_NAME	Publisher
GENERATE_HTMLHELP	NO
CHM_FILE
HHC_LOCATION
GENERATE_CHI	NO
CHM_INDEX_ENCODING
BINARY_TOC	NO
TOC_EXPAND	NO
GENERATE_QHP	NO
QCH_FILE
QHP_NAMESPACE	org.doxygen.Project
QHP_VIRTUAL_FOLDER	doc
QHP_CUST_FILTER_NAME
QHP_CUST_FILTER_ATTRS
QHP_SECT_FILTER_ATTRS
QHG_LOCATION
GENERATE_ECLIPSEHELP	NO
ECLIPSE_DOC_ID	org.doxygen.Project
DISABLE_INDEX	NO
GENERATE_TREEVIEW	ALL
ENUM_VALUES_PER_LINE	4
TREEVIEW_WIDTH	250
EXT_LINKS_IN_WINDOW	NO
FORMULA_FONTSIZE	10
FORMULA_TRANSPARENT	YES
USE_MATHJAX	NO
MATHJAX_FORMAT	HTML-CSS
MATHJAX_RELPATH	http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS
MATHJAX_CODEFILE
SEARCHENGINE	YES
SERVER_BASED_SEARCH	NO
EXTERNAL_SEARCH	NO
SEARCHENGINE_URL
SEARCHDATA_FILE	searchdata.xml
EXTERNAL_SEARCH_ID
EXTRA_SEARCH_MAPPINGS

Configuration options related to the LaTeX output

配置项	作用
GENERATE_LATEX	NO
LATEX_OUTPUT	latex
LATEX_CMD_NAME	latex
MAKEINDEX_CMD_NAME	makeindex
COMPACT_LATEX	NO
PAPER_TYPE	a4
EXTRA_PACKAGES
LATEX_HEADER
LATEX_FOOTER
LATEX_EXTRA_FILES
PDF_HYPERLINKS	YES
USE_PDFLATEX	YES
LATEX_BATCHMODE	NO
LATEX_HIDE_INDICES	NO
LATEX_SOURCE_CODE	NO
LATEX_BIB_STYLE	plain

Configuration options related to the RTF output

配置项	作用
GENERATE_RTF	NO
RTF_OUTPUT	rtf
COMPACT_RTF	NO
RTF_HYPERLINKS	NO
RTF_STYLESHEET_FILE
RTF_EXTENSIONS_FILE

Configuration options related to the man page output

配置项	作用
GENERATE_MAN	NO
MAN_OUTPUT	man
MAN_EXTENSION	.3
MAN_LINKS	NO

Configuration options related to the XML output

配置项	作用
GENERATE_XML	NO
XML_OUTPUT	xml
XML_SCHEMA
XML_DTD
XML_PROGRAMLISTING	YES

Configuration options related to the DOCBOOK output

配置项	作用
GENERATE_DOCBOOK	NO
DOCBOOK_OUTPUT	docbook

Configuration options for the AutoGen Definitions output

配置项	作用
GENERATE_AUTOGEN_DEF	NO

Configuration options related to the Perl module output

配置项	作用
GENERATE_PERLMOD	NO
PERLMOD_LATEX	NO
PERLMOD_PRETTY	YES
PERLMOD_MAKEVAR_PREFIX

Configuration options related to the preprocessor

配置项	作用
ENABLE_PREPROCESSING	YES
MACRO_EXPANSION	NO
EXPAND_ONLY_PREDEF	NO
SEARCH_INCLUDES	YES
INCLUDE_PATH
INCLUDE_FILE_PATTERNS	*.c *.h
PREDEFINED
EXPAND_AS_DEFINED
SKIP_FUNCTION_MACROS	YES

Configuration options related to external references

配置项	作用
TAGFILES
GENERATE_TAGFILE
ALLEXTERNALS	NO
EXTERNAL_GROUPS	YES
EXTERNAL_PAGES	YES
PERL_PATH	/usr/bin/perl

Configuration options related to the dot tool

配置项	作用
CLASS_DIAGRAMS	YES，是否生成类图。
MSCGEN_PATH	MSCGEN 的路径，MSCGEN 是一种序列图绘制工具。
HIDE_UNDOC_RELATIONS	YES，是否隐藏未被文档记录的关系。
HAVE_DOT	YES，是否安装了 Graphviz 工具包中的 dot 工具。
DOT_NUM_THREADS	0，dot 工具使用的线程数。
DOT_FONTNAME	Helvetica，dot 工具使用的字体名称。
DOT_FONTSIZE	10，dot 工具使用的字体大小。
DOT_FONTPATH	dot 工具字体的搜索路径。
CLASS_GRAPH	YES，是否生成类图。
COLLABORATION_GRAPH	YES，是否生成协作图。
GROUP_GRAPHS	YES，是否生成组图。
UML_LOOK	YES，是否使用 UML 风格。
UML_LIMIT_NUM_FIELDS	10，生成的类中字段数量的限制。
TEMPLATE_RELATIONS	YES，是否生成模板关系。
INCLUDE_GRAPH	YES，是否生成包含图。
INCLUDED_BY_GRAPH	YES，是否生成被包含图。
CALL_GRAPH	YES，是否生成调用图。
CALLER_GRAPH	YES，是否生成被调用图。
GRAPHICAL_HIERARCHY	YES，是否生成层次结构图。
DIRECTORY_GRAPH	YES，是否生成目录图。
DOT_IMAGE_FORMAT	png，生成的图像格式。
INTERACTIVE_SVG	YES，是否生成可交互的 SVG。
DOT_PATH	dot 工具的路径。
DOTFILE_DIRS	dot 文件的搜索路径。
MSCFILE_DIRS	MSC 文件的搜索路径。
DOT_GRAPH_MAX_NODES	50，生成的图中节点的最大数量。
MAX_DOT_GRAPH_DEPTH	0，生成的图中节点的最大深度。
DOT_TRANSPARENT	NO，生成的图像是否透明。
DOT_MULTI_TARGETS	NO，生成多个目标图像。
GENERATE_LEGEND	YES，是否生成图例。
DOT_CLEANUP	NO，是否清除 *.dot 中间文件。

使用

$ doxygen doxyconfig

附件

ChatGPT 写的 MD 格式转换器。

$ config_parser.sh
#!/bin/bash# 是否需要在下一行添加表头和行末信息
need_table_header=0
need_extra_info=0# 读取文件
while read line
do# 如果行以 "#--" 开头，则忽略该行并继续处理下一行if [[ $line == "#--"* ]]; thencontinuefi# 如果行以 "# " 开头，则将其替换为 "## " 并打印，同时在行末添加表头和行末信息if [[ $line == "# "* ]]; thenline="##${line:1}"echo "$line"need_table_header=1need_extra_info=1continuefi# 分割字符串key="${line%=*}"value="${line#*=}"# 如果需要添加表头，则在此行前面添加表头和行末信息if [ $need_table_header -eq 1 ]; thenecho "| 配置项 | 作用 |"echo "|:--|:--|"need_table_header=0fi# 输出键值对echo "| $key | $value |"# 如果需要添加行末信息，则在此行后面添加行末信息和下一行的表头if [[ $line == "## "* ]]; thenecho "| 配置项 | 作用 |"echo "|:--|:--|"need_extra_info=1elseneed_extra_info=0fi
done < doxyconfig