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        &
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值