doxygen 教程 linux,使用Doxygen生成全中文的chm、pdf帮助文档的方法

下载和安装 Doxygen

到 Doxygen 官网 下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。

软件名称:帮助文档生成器( doxygen ) 1.8.13 官方最新英文安装版(附帮助文档)软件大小:21.7KB更新时间:2017-09-23立即下载

下载和安装 chm 编译器

我们使用微软古老的 HTML Help Workshop 1.3,这个软件N久没更新了。

下载地址: 微软官网

下载后根据提示安装。

项目一般设置

首先在“Wizard”标签的Project项进行如下设置:

doxygen 教程 linux,使用Doxygen生成全中文的chm、pdf帮助文档的方法_第1张图片

项目名称:将在最新的文档首页中显示

源码列表:选择要生成文档的源代码或目录,可以有多个文件或目录形成一个列表。建议使用相对路径,相对于当前目录(也即当前配置文件所在的目录)

递归扫描:如果需要对整个源码目录下的所有子目录及文件生成文档,请勾选本项

输出目录:设置最终生成的帮助文档的存储路径,建议使用相对路径

下一步,

Mode项,根据需要设置文档生成模式。

你可能感兴趣的:(doxygen,教程,linux)