Doxygen学习笔记2--生成.chm文件

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/hzt12345hf/article/details/50738395

参考自:二叉树百科http://www.erchashu.com/wiki/doxygen-chm-chinese-hlep-doc#使用doxygen生成全中文的chm帮助文档

需要软件:

Doxygen window安装版

下载地址:http://www.stack.nl/~dimitri/doxygen/download.html

chm编译器 - HTML Help Workshop 1.3

下载地址:https://www.microsoft.com/en-us/download/details.aspx?id=21138

Doxygen设置:

分为Wizard、Expert、Run三项,Wizard表示向导设置,设置起来较容易,各项内容通俗易懂;Expert表示详细设置,包含所有可以设置的内容,需要借助文档并有一定的经验才能进行设置,但要输出.chm文件必须要用到Expert的一些设置;Run表示最后的输出步骤

1.设置工程目录


2.Wizard设置:

Project项:

Project name:文档首页显示的名字
Project synosis:文档的概要介绍
Source code directory:源代码位置
Scan recursively:是否浏览子目录
Desitination directory:输出文件存放的位置

Mode项:

选择提取哪些实体
Documented entities only:选择哪些被文档化的实体进行输出
All Entities:所有实体都输出
Include cross-referenced source.....:输出包括交叉引用的源代码(这地方)
选择对哪个使用的语言进行优化。


Output输出:

选择输出的格式,由于要输出.chm,所以要勾选 HTML prepare for compressed HTML


扫描二维码关注公众号,回复: 3452032 查看本文章

Diagrams图表:

选择是否生成图表,用哪种方式生成图表,如果使用GraphViz需要安装最新版的GraphViz 。



3.Expert设置

这里不做过多介绍,因为我也很多不明白的,还要慢慢学。
进入“HTML”标签:
勾选 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:这里设置Doxygen生成的CHM索引文件的编码,以前是不能设置的,默认为UTF-8,而微软的编译器不能识别UTF-8编码的索引文件,所以最终造成左边目录导航栏乱码。我们设置它为GBK,这样Doxygen将为我们生成GBK编码的索引文件(.hhc、.hhk、.hhp)
进入"Project"标签:
DOXYFILE_ENCODING:当前 Doxygen 配置文件本身的字符编码,默认为UTF-8,一般不需要修改
· OUTPUT_LANGUAGE:输出语言。这里是指Doxygen自己生成的导航、提示、帮助等文本的文字采用的语言。我们希望帮助文档是全中文的,所以选择Chinese
进入"Input"标签:
INPUT_ENCODING:输入文件的编码。这里是指我们的源代码文件本身的编码。在Windows平台一般是系统编码(GBK),而Linux平台一般是UTF-8。请用文本编辑器查看源文件的编码。这里如果设置的不一致,源码文件的注释中所有非ASCII字符将在生成的文档中变成乱码。这里我设置的是UTF-8。


4.Run输出

点击Run Doxygen即可生成中文.chm文档了

猜你喜欢

转载自blog.csdn.net/hzt12345hf/article/details/50738395
今日推荐