doxygen在实际项目中的应用

在上一篇文章中主要讲解了doxygen的注释规则，在本篇中将主要侧重doxygen在实际项目中的应用部署。

一、doxygen环境的安装

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

二、创建Doxygen的配置文件

doxygen的配置文件在cmake阶段通过相应的转换，生成Doxygenfile

当不知道如何创建doxygen的配置文件时，可以通过doxygen -g生成一个默认的配置文件，然后修改其中的某些配置项，然后修改后缀为.in即可
在这里插入图片描述
以下是一个简单的配置文件例子Doxyfile.in：

# 项目名称，将作为于所生成的程序文档首页标题
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

三、构建生成文档的cmake

新建文件build_doc.cmake

macro(build_doc)

# 检查doxygen是否安装
find_package(Doxygen)
if (DOXYGEN_FOUND)
    # set 配置文件的路径
    set(DOXYGEN_IN ${CMAKE_CURRENT_LIST_DIR}/docs/Doxyfile.in)
    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

    # 转换配置文件
    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()

四、实际项目中的应用

在自己项目的CMakeLists.txt编写

# 引入cmake文件
include(cmake/build_doc.cmake)
build_doc()

五、使用make生成需要的文档

生成的文档位于${CMAKE_CURRENT_BINARY_DIR}/docs/html下面，其中的index.html利用浏览器打开就可以看到相应的api文档

特殊使用：某些情况下需要将所有的编译结果，拷贝到产出中，可以使用类似下面的代码来实现 :

file(GLOB_RECURSE OUTER_HTMLS ${CMAKE_BINARY_DIR}/docs/html/*)
foreach(html ${OUTER_HTMLS})
	install(FILES ${html} DESTINATION 要安装路径)
endforeach()

doxygen注释生成api文档(二)