Doxygen学习记录

一、目的

使用Doxygen生成一个带有图表的CHM文档。
效果如下:
这里写图片描述
这里写图片描述

二、配置

1.安装软件
(一)、安装graphviz(我用的是V2.38版本)
http://www.graphviz.org/Download..php

(二)、安装htmlhelp (我用的是V1.3版本)
https://msdn.microsoft.com/en-us/library/ms669985.aspx

(三)、安装Doxygen(我用的是V1.8.11版本)
http://www.stack.nl/~dimitri/doxygen/download.html

2.开始配置
我使用Doxygen的GUI界面进行配置。
使用的是STM32的固件库。

(一)、打开doxygen安装文件夹下的bin文件夹,再打开doxywizard.exe
这里写图片描述
这里写图片描述

(二)、首先进行Wizard项的Project配置
这里写图片描述

(三)、进行Wizard项的Mode配置
这里写图片描述

(四)、进行Wizard项的Output配置
这里写图片描述

(五)、进行Wizard项的Diagrams配置
这里写图片描述

(六)、进行Expert项的Project配置
这里写图片描述

(七)、进行Expert项的 Build配置
这里写图片描述

(八)、进行Expert项的Input配置
这里写图片描述

(九)、进行Expert项的HTML配置
这里写图片描述

(十)、进行Expert项的Dot配置
这里写图片描述
这里写图片描述

(十一)、进入Run项 点击 Run Doxygen
这里写图片描述

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
使用Doxygen生成全中文的chm文档 生成类图 项目一般设置 首先在“Wizard”标签的Project项进行如下设置: 项目名称:将在最新的文档首页中显示 源码列表:选择要生成文档的源代码或目录 可以有多个文件或目录形成一个列表 建议使用相对路径 相对于当前目录(也即当前配置文件所在的目录) 递归扫描:如果需要对整个源码目录下的所有子目录及文件生成文档 请勾选本项 输出目录:设置最终生成的帮助文档的存储路径 建议使用相对路径 下一步 Mode项 根据需要设置文档生成模式 下一步 Output项 设置输出格式 勾选HTML和“prepare for compressed HTML chm ” 然后切换到“Expert”标签的“HTML”项 设置HTML和CHM相关的选项: GENERATE HTMLHELP:确保已经勾选了 CHM FILE:最终生成的 chm的文件名 如“HkcProjectHelp chm” 默认为“index chm” 可以使用路径 也可以使用相对路径 相对于上面设置的输出目录的html目录(建设使用上一级目录 如“ MyDoc chm”) HHC LOCATION:chm 编译器(hhc exe)的全路径 请指到 HTML Help Workshop 的安装目录的 hhc exe 程序 CHM INDEX ENCODING:chm索引文件编码 下面会讲到 这里填“GBK” 编码设置 编码设置很重要 如果设置不当 生成的文档会出现乱码 因为 Doxygen 汲及的东西多 有好几项编码设置 所以需要认真对待 根据项目的实情情况设置 所有高级设置(包括编码设置)都在“Expert”标签 重要的设置项如下: Project DOXYFILE ENCODING:当前 Doxygen 配置文件本身的字符编码 默认为UTF 8 一般不需要修改 Project OUTPUT LANGUAGE:输出语言 这里是指Doxygen自己生成的导航 提示 帮助等文本的文字采用的语言 我们希望帮助文档是全中文的 所以选择Chinese Input INPUT ENCODING:输入文件的编码 这里是指我们的源代码文件本身的编码 在Windows平台一般是系统编码(GBK) 而Linux平台一般是UTF 8 请用文本编辑器查看源文件的编码 这里如果设置的不一致 源码文件的注释中所有非ASCII字符将在生成的文档中变成乱码 HTMP CHM INDEX ENCODING:这里设置Doxygen生成的CHM索引文件的编码 以前是不能设置的 默认为UTF 8 而微软的编译器不能识别UTF 8编码的索引文件 所以最终造成左边目录导航栏乱码 我们设置它为GBK 这样Doxygen将为我们生成GBK编码的索引文件( hhc hhk hhp) 生成CHM文档 设置好了后 点击“Run”→“Run doxygen”生成最终的 chm文档 如果设置正确 打开后是全中文的了 ">使用Doxygen生成全中文的chm文档 生成类图 项目一般设置 首先在“Wizard”标签的Project项进行如下设置: 项目名称:将在最新的文档首页中显示 源码列表:选择要生成文档的源代码或目录 可以有多个文件或目录形成一个 [更多]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值