Doxyfile

###############################################################################
# doxygen，用源代码的注释信息直接生成API说明文档
# 资料详见./00_doc/00-项目管理/13-用于API文档自动生成的doxygen注释规范.md
#
# 使用方法：先安装doxygen，再在本配置文件同级目录下执行doxygen命令
###############################################################################

# 字符集编码
DOXYFILE_ENCODING      = UTF-8

# 生成文档的标题首页名称
PROJECT_NAME           = "Embedded Programming Skills"

# 文档版本号
PROJECT_NUMBER         = "0.0.1"

# 文档描述
PROJECT_BRIEF          =

# LOGO
PROJECT_LOGO           =

# 生成文档的路径
OUTPUT_DIRECTORY       = ./0_doc/01-doxygen_API/

# 创建子文件夹
CREATE_SUBDIRS         = NO

# 允许用非ASCII码为文件命名
ALLOW_UNICODE_NAMES    = NO

# 输出文档的语言
OUTPUT_LANGUAGE        = Chinese

# 文本方向
# information to generate all generated output in the proper direction.
# Possible values are: None, LTR, RTL and Context.
# The default value is: None.
OUTPUT_TEXT_DIRECTION  = None

# 包含brief描述信息
BRIEF_MEMBER_DESC      = YES

# 包含brief描述信息
REPEAT_BRIEF           = YES

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

ALWAYS_DETAILED_SEC    = NO

INLINE_INHERITED_MEMB  = NO

FULL_PATH_NAMES        = YES

STRIP_FROM_PATH        =

STRIP_FROM_INC_PATH    =

SHORT_NAMES            = NO

JAVADOC_AUTOBRIEF      = NO

JAVADOC_BANNER         = NO

QT_AUTOBRIEF           = NO

MULTILINE_CPP_IS_BRIEF = NO

INHERIT_DOCS           = YES

SEPARATE_MEMBER_PAGES  = NO

# 每个tab占几个字节的宽度
TAB_SIZE               = 4

ALIASES                =

# 是否生成C语言格式的文档（否则生成C++格式的）
OPTIMIZE_OUTPUT_FOR_C  = YES
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
OPTIMIZE_OUTPUT_SLICE  = NO

EXTENSION_MAPPING      =

MARKDOWN_SUPPORT       = YES

TOC_INCLUDE_HEADINGS   = 5

AUTOLINK_SUPPORT       = YES

BUILTIN_STL_SUPPORT    = NO

CPP_CLI_SUPPORT        = NO

SIP_SUPPORT            = NO

IDL_PROPERTY_SUPPORT   = YES

DISTRIBUTE_GROUP_DOC   = NO

GROUP_NESTED_COMPOUNDS = NO

SUBGROUPING            = YES

INLINE_GROUPED_CLASSES = NO

INLINE_SIMPLE_STRUCTS  = NO

# 对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT   = YES

LOOKUP_CACHE_SIZE      = 0

# 这个标记告诉 doxygen，即使各个类或函数没有文档，也要提取信息。必须把这个标记设置为 Yes。
EXTRACT_ALL            = YES

# 把这个标记设置为 Yes。否则，文档不包含类的私有数据成员
EXTRACT_PRIVATE        = YES

EXTRACT_PRIV_VIRTUAL   = NO

EXTRACT_PACKAGE        = NO

# 把这个标记设置为 Yes。否则，文档不包含文件的静态成员（函数和变量）。
EXTRACT_STATIC         = YES

EXTRACT_LOCAL_CLASSES  = YES

EXTRACT_LOCAL_METHODS  = NO

EXTRACT_ANON_NSPACES   = NO

HIDE_UNDOC_MEMBERS     = NO

HIDE_UNDOC_CLASSES     = NO

HIDE_FRIEND_COMPOUNDS  = NO

HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = NO

CASE_SENSE_NAMES       = YES

# 由于 C 语言没有所谓的域/名字空间这样的概念，所以此处设置为 YES
HIDE_SCOPE_NAMES       = YES

HIDE_COMPOUND_REFERENCE= NO

SHOW_INCLUDE_FILES     = YES

SHOW_GROUPED_MEMB_INC  = NO

FORCE_LOCAL_INCLUDES   = NO

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         =

# 生成文档时只输出错误信息
QUIET                  = NO

WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = YES

WARN_IF_DOC_ERROR      = YES

WARN_NO_PARAMDOC       = NO

WARN_AS_ERROR          = NO

WARN_FORMAT            = "$file:$line: $text"

WARN_LOGFILE           =

# 在这里，doxygen 会从这两个目录读取 C/C++ 源代码。如果项目只有一个源代码根目录，其中有多个子目录，那么只需指定根目录并把 <RECURSIVE> 标记设置为 Yes。
INPUT                  = ./

INPUT_ENCODING         = UTF-8

# 默认搜索的文件名
FILE_PATTERNS          = *.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 \
                         *.doc \
                         *.txt \
                         *.py \
                         *.pyw \
                         *.f90 \
                         *.f95 \
                         *.f03 \
                         *.f08 \
                         *.f18 \
                         *.f \
                         *.for \
                         *.vhd \
                         *.vhdl \
                         *.ucf \
                         *.qsf \
                         *.ice

# 遍历子目录，寻找原文件
RECURSIVE              = YES

EXCLUDE                =

EXCLUDE_SYMLINKS       = NO

EXCLUDE_PATTERNS       =

EXCLUDE_SYMBOLS        =

# 示例程序路径
EXAMPLE_PATH           = 1_src/example/
# 示例程序的头文档 (.h 文件) 与实现文档 (.c 文件) 都作为程序文档化对象,为空
EXAMPLE_PATTERNS       = *

# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件
EXAMPLE_RECURSIVE      = YES

IMAGE_PATH             =

INPUT_FILTER           =

FILTER_PATTERNS        =

FILTER_SOURCE_FILES    = NO

FILTER_SOURCE_PATTERNS =

USE_MDFILE_AS_MAINPAGE =

# 在最后生成的文档中，把所有的源代码src包含在其中
SOURCE_BROWSER         = NO

INLINE_SOURCES         = NO

STRIP_CODE_COMMENTS    = YES

# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES

SOURCE_TOOLTIPS        = YES

USE_HTAGS              = NO

VERBATIM_HEADERS       = YES

ALPHABETICAL_INDEX     = YES

COLS_IN_ALPHA_INDEX    = 5

IGNORE_PREFIX          =

GENERATE_HTML          = YES

HTML_OUTPUT            = html

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_MENUS     = YES

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

# 这会在HTML文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系
GENERATE_TREEVIEW      = ALL

ENUM_VALUES_PER_LINE   = 4

TREEVIEW_WIDTH         = 250

EXT_LINKS_IN_WINDOW    = NO

HTML_FORMULA_FORMAT    = png

FORMULA_FONTSIZE       = 10

FORMULA_TRANSPARENT    = YES

FORMULA_MACROFILE      =

USE_MATHJAX            = NO

MATHJAX_FORMAT         = HTML-CSS

MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/

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  =

GENERATE_LATEX         = YES

LATEX_OUTPUT           = latex

LATEX_CMD_NAME         =

MAKEINDEX_CMD_NAME     = makeindex

LATEX_MAKEINDEX_CMD    = makeindex

COMPACT_LATEX          = NO

PAPER_TYPE             = a4

EXTRA_PACKAGES         =

LATEX_HEADER           =

LATEX_FOOTER           =

LATEX_EXTRA_STYLESHEET =

LATEX_EXTRA_FILES      =

PDF_HYPERLINKS         = YES

USE_PDFLATEX           = YES

LATEX_BATCHMODE        = NO

LATEX_HIDE_INDICES     = NO

LATEX_SOURCE_CODE      = NO

LATEX_BIB_STYLE        = plain

LATEX_TIMESTAMP        = NO

LATEX_EMOJI_DIRECTORY  =

GENERATE_RTF           = NO

RTF_OUTPUT             = rtf

COMPACT_RTF            = NO

RTF_HYPERLINKS         = NO

RTF_STYLESHEET_FILE    =

RTF_EXTENSIONS_FILE    =

RTF_SOURCE_CODE        = NO

GENERATE_MAN           = NO

MAN_OUTPUT             = man

MAN_EXTENSION          = .3

MAN_SUBDIR             =

MAN_LINKS              = NO

GENERATE_XML           = NO

XML_OUTPUT             = xml

XML_PROGRAMLISTING     = YES

XML_NS_MEMB_FILE_SCOPE = NO

GENERATE_DOCBOOK       = NO

DOCBOOK_OUTPUT         = docbook

DOCBOOK_PROGRAMLISTING = NO

GENERATE_AUTOGEN_DEF   = NO

GENERATE_PERLMOD       = NO

PERLMOD_LATEX          = NO

PERLMOD_PRETTY         = YES

PERLMOD_MAKEVAR_PREFIX =

ENABLE_PREPROCESSING   = YES

MACRO_EXPANSION        = NO

EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = YES

INCLUDE_PATH           =

INCLUDE_FILE_PATTERNS  =

PREDEFINED             =

EXPAND_AS_DEFINED      =

SKIP_FUNCTION_MACROS   = YES

TAGFILES               =

GENERATE_TAGFILE       =

ALLEXTERNALS           = NO

EXTERNAL_GROUPS        = YES

EXTERNAL_PAGES         = YES

CLASS_DIAGRAMS         = YES

DIA_PATH               =

HIDE_UNDOC_RELATIONS   = YES

# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
HAVE_DOT               = YES

DOT_NUM_THREADS        = 0

DOT_FONTNAME           = Helvetica

DOT_FONTSIZE           = 10

DOT_FONTPATH           =

CLASS_GRAPH            = YES

COLLABORATION_GRAPH    = YES

GROUP_GRAPHS           = YES

# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
UML_LOOK               = YES

UML_LIMIT_NUM_FIELDS   = 10

TEMPLATE_RELATIONS     = NO

INCLUDE_GRAPH          = YES

INCLUDED_BY_GRAPH      = YES

# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
CALL_GRAPH             = YES
CALLER_GRAPH           = YES

GRAPHICAL_HIERARCHY    = YES

DIRECTORY_GRAPH        = YES

DOT_IMAGE_FORMAT       = png

INTERACTIVE_SVG        = NO

DOT_PATH               =

DOTFILE_DIRS           =

MSCFILE_DIRS           =

DIAFILE_DIRS           =

PLANTUML_JAR_PATH      =

PLANTUML_CFG_FILE      =

PLANTUML_INCLUDE_PATH  =

DOT_GRAPH_MAX_NODES    = 50

MAX_DOT_GRAPH_DEPTH    = 0

DOT_TRANSPARENT        = NO

DOT_MULTI_TARGETS      = NO

GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES