快速阅读源码

Doxygen 轻松生成包含类图、调用关系图的 HTML 和 PDF 文档,
Graphviz 可以用来生成类图、调用图

sudo apt-get install doxygen graphviz
brew install doxygen graphviz#HTML 文档：
open docs/html/index.html

一、Doxyfile配置: Doxyfile 文件

doxygen Doxyfile

PROJECT_NAME = "My Project"
# 指定源代码目录
INPUT = .
INPUT_ENCODING = UTF-8
FILE_PATTERNS=*.c,*.cpp,*.cxx,*.h,*.hpp
OUTPUT_DIRECTORY = ./docs
OUTPUT_LANGUAGE = Chinese# 细节
RECURSIVE = YES
HAVE_DOT  = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC  = YES
CALL_GRAPH = YES
OPTIMIZE_OUTPUT_FOR_C = YES
GRAPHICAL_HIERARCHY=YES
SHOW_USED_FILES=YES
SHOW_FILES=YES
INLINE_INFO=YES
SOURCE_BROWER=YES
REFERENCED_BY_RELATION = YES
REFERENCED_RELATION = YES
REFERENCED_LINK_SOURCE = YES
GENERATE_TREEVIEW=ALL
GENERATE_HTML = YES
GENERATE_LATEX = NO

二、使用 CMake 自动生成文档

运行 make doc 即可生成文档

find_package(Doxygen REQUIRED)set(DOXYGEN_INPUT_DIR "${CMAKE_SOURCE_DIR}/src")
set(DOXYGEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/docs")set(DOXYGEN_CONFIG_FILE "${CMAKE_BINARY_DIR}/Doxyfile")add_custom_target(docCOMMAND doxygen ${DOXYGEN_CONFIG_FILE}WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}COMMENT "Generating API documentation with Doxygen"VERBATIM)