cmake使用doxygen生成document

1. 安裝doxygen

• sudo apt install doxygen
• sudo apt install graphviz（生成dot需要）

2. 創建Doxyfile.in文件

• 注：可使用doxygen -g命令生成默認的Doxyfile，cmake則是通過Doxyfile.in來生成Doxyfile

# 項目名稱，將作爲於所生成的程序文檔首頁標題
PROJECT_NAME        = “xxx”
# 文檔版本號，可對應於項目版本號，譬如 svn、cvs 所生成的項目版本號
PROJECT_NUMBER      = "1.0.0"
PROJECT_BRIEF          = "xxx"
# 程序文檔輸出目錄
OUTPUT_DIRECTORY    =  docs
 
# 程序文檔輸入目錄 
INPUT                = @CMAKE_CURRENT_LIST_DIR@/apps    \
                       @CMAKE_CURRENT_LIST_DIR@/include \
                       @CMAKE_CURRENT_LIST_DIR@/modules \
                       @CMAKE_CURRENT_LIST_DIR@/samples
 
# 程序文檔語言環境
OUTPUT_LANGUAGE      = Chinese
DOXYFILE_ENCODING  = UTF-8
# 只對頭文件中的文檔化信息生成程序文檔 
FILE_PATTERNS        = *.h *.cpp
 
# 遞歸遍歷當前目錄的子目錄，尋找被文檔化的程序源文件 
RECURSIVE            = YES 
# 如果是製作 C 程序文檔，該選項必須設爲 YES，否則默認生成 C++ 文檔格式
OPTIMIZE_OUTPUT_FOR_C  = NO
 
#提取信息，包含類的私有數據成員和靜態成員
EXTRACT_ALL            = yes
EXTRACT_PRIVATE        = yes
EXTRACT_STATIC        = yes
# 對於使用 typedef 定義的結構體、枚舉、聯合等數據類型，只按照 typedef 定義的類型名進行文檔化
TYPEDEF_HIDES_STRUCT  = YES
# 在 C++ 程序文檔中，該值可以設置爲 NO，而在 C 程序文檔中，由於 C 語言沒有所謂的域/名字空間這樣的概念，所以此處設置爲 YES
HIDE_SCOPE_NAMES      = YES
# 讓 doxygen 靜悄悄地爲你生成文檔，只有出現警告或錯誤時，纔在終端輸出提示信息
QUIET  = YES
# 遞歸遍歷示例程序目錄的子目錄，尋找被文檔化的程序源文件
EXAMPLE_RECURSIVE      = YES
# 允許程序文檔中顯示本文檔化的函數相互調用關係
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文檔
GENERATE_LATEX        = NO
# 在程序文檔中允許以圖例形式顯示函數調用關係，前提是你已經安裝了 graphviz 軟件包
HAVE_DOT              = YES
CALL_GRAPH            = YES
CALLER_GRAPH          = YES
#在最後生成的文檔中，把所有的源代碼包含在其中
SOURCE_BROWSER        = YES
#這會在HTML文檔中，添加一個側邊欄，並以樹狀結構顯示包、類、接口等的關係
GENERATE_HTML         = YES
#GENERATE_TREEVIEW      ＝ YES

3. 創建build_doxygen.cmake文件

macro(build_doxygen)

# check if Doxygen is installed
find_package(Doxygen)
if (DOXYGEN_FOUND)
    # set input and output files
    set(DOXYGEN_IN ${CMAKE_CURRENT_LIST_DIR}/docs/Doxyfile.in)
    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

    # request to configure the file
    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)

    # note the option ALL which allows to build the docs together with the application
    add_custom_target( docs ALL
        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
        COMMENT "Generating API documentation with Doxygen"
        VERBATIM )
else (DOXYGEN_FOUND)
    message("Doxygen need to be installed to generate the doxygen documentation")
endif (DOXYGEN_FOUND)
endmacro()

4. CMakeLists.txt編寫

message(STATUS "Build documentation open")
include(cmake/build_doxygen.cmake)
build_doxygen()

5. make生成documents

• 生成的documents位於${CMAKE_CURRENT_BINARY_DIR}/docs/html/下，用瀏覽器打開index.html即可
• 注：後續也可用make docs命令重新生成

6. 參考

• 1
• 2