||||
步骤1 :下载doxygen
doxygen 1.5.7下载地址:
http://gd.tuwien.ac.at/softeng/doxygen/doxygen-1.5.7-setup.exe
为了使doxygen能够将类图、协作图等 加入到文档中,还要下载安装graphviz for win。
graphviz 2.2.1下载地址:
http://graphviz.org/pub/graphviz/stable/windows/graphviz-2.2.1.exe (安装后,在C:Program FilesATTGraphvizbin目录下要有png.dll文件)
如果要输出chm格式文件,需要安装HTML Help Workshop
HTML Help Workshop 4.7.3下载地址
http://info.prevx.com/download.asp?grab=PREVXCSIRND
全部安装后就可以开始使用了。
步骤2:运行doxygen wizard.exe
运行doxywizard.exe,进行如下设置。
在Project标签下:
工作路径: E:/message
源码路径: E:/message/src 或 src(相对路径,相对于工作路径)
并选中scan recursively
输出路径: E:/message/doc 或 doc
在Mode标签下:
选中"All entities" ,并勾选"Include cross-refferenced source code int the output"
在Output标签下:
选择"HTML",勾选with frames and a navigation tree
去掉Latex前面的勾
在Diagrams标签下:
选中"Use dot tool from the GraphViz package to generate",勾选"call graphs"
步骤3:点开始,即可生成文档
最后对文档生成过程中遇到的一些问题进行说明:
1.中文问题:中文注释在文档中是乱码。
解决:
1.1 在expert中的Projects选项页下,选中CREATE_SUBDIRS, 然后在 OUTPUT_LANGUAGE中选择Chinese;
1.2 在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”;
1.3 若输出文件为chm格式,则左侧列表可能出现乱码这是需要设置:在expert中的HTML选项页下,选中GENERATE_HEMLHELP, 然后在CHM_FILE中输入chm文件名,如zxf.chm;在HHC_LOCATTION输入hhc.exe文件地址,如C:Program FilesHTML Help Workshophhc.exe;选中GENERATE_CHI,并在CHM_INDEX_ENCODING中输入GB2312
2.图形问题:无法绘制类图协作图等图形。
只要安装正确的graphviz (要求在C:Program FilesATTGraphvizbin目录下要有png.dll文件),该项无需特别设置。
解决:首先确保安装了graphviz for win,注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在 expert的DOT_PATH中填入graphviz的安装路径C:Program FilesGraphviz2.20bin。接着在wizard的diagram中选择需要生成的图形类别(Use dot tool from the GraphViz package to generate)就可以了。如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。
3.输出chm的问题:如何输出.chm文件在expert中的HTML页:选中“GENERATE_HTMLHELP”,然后在CHM_FILE中填上想要的chm文件名,如zxf.chm。HHC_LOCATION中输入hhc.exe文件的路径C:Program FilesHTML Help Workshophhc.exe。hhc.exe可以通过安装HTML Help Workshop获得。如选中“GENERATE_CHI”,然后在CHM_INDEX_ENCODING中输入GB2312
Archiver|手机版|科学网 ( 京ICP备07017567号-12 )
GMT+8, 2024-6-4 00:41
Powered by ScienceNet.cn
Copyright © 2007- 中国科学报社