doxygen文档生成器
上一篇 /
下一篇 2012-08-07 14:01:31
/ 个人分类：自主学习
1.Doxygen简介：
用来解析源代码和生成文档的工具。
支持在大多数操作系统上运行；
支持C/C++，Java，Python,VHDL,IDL,语言，部分支持PHP和C#;
输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。
2.Doxygen安装
Doxygen-1.8.1.1-setup-wln.exe
Htmlhelp.exe
3.Doxygen使用说明
注：用HTML Help Workshop中的CHM编译器编译HTML输出文档生成CHM文件。
配置运行doxygen的若干步骤：
*step1：设置doxygen将要运行的工作目录。
*step2：使用向导或专家模式配置doxygen。
向导（Wizard）模式：将快速配置大多数重要的设定，其他选项保持默认值。
Project相关选项（工程名和路径选择） Mode相关选项（查找源码方式）
Output相关选项（输出格式选项） Diagrams相关选项（使用DOT工具生成图表）
专家（Expert）模式：进入全部的配置选项。配置完成后可保存（默认Doxyfile），方
便下次使用。
点击（run）按钮运行doxygen生成文档。点击“Show HTML output”可在浏览器中查看生成的说明文档
生成chm文件的具体步骤：
1） 单击Wizard按钮，点击project，输入项目名，名字为文档的大标题，输入版本，然后输入源代码的根目录，勾选“Scan recursively”，输入文档输出路径。
2） 单击Mode标签，不做任何改动，保持默认。
3）单击Output标签，去掉“LaTex”选择“prepare for compressed HTML（.chm）”
4） 单击Diagrams标签，如果已安装了Graphviz，则保持沉默。否则，勾选“use dotTool the Graphviz package”
5）单击Expert按钮，选择“project”，将OUTPUT_LANGUAGE设置为chinese。
选择“input”，将INPUT_ENCODING保持默认utf-8。将FILE_PATTERNS下的后缀一个个删除，只留下*.H,*.h,*.hpp,*.c,*.C,*.cpp.意思是只扫描C++头文件和源文件。
选择“Source Browser”勾选“SOURCE_BROUSER”
选择“HTML”，勾选“HTML_DYNAMIC_SECTION”,表示输出chm文件。同时在CHM-FILE输入文件名为最终要生成的chm文件名，同时点击“HHC-LOCATION”找到chm编译器hhc.exe.
6)单击“RUN”即可输出chm文件。
4.文档化代码
a.修改头文件中的注释，遵从doxygen注释规范。
Doxygen的几种注释风格：
Javadoc类型：
/**
*…text…
*/
QTl类型：
/*!
*…text…
*/
C++类型：
///
///…text….
///
或者
//!
//!...text…
//!
b.在成员之后的注释中要加入“<”标记
如：int var;/*!<…text…*/
c.doxygen组合机制：模块、成员、子页面。
创建模块：在注释块中使用命令\defgroup定义一个组，\ingroup命令添加组中的成员。
也可使用\addtogroup命令替换\ingroup命令，在组之前打开标记“@{”，组之后使用关闭标记“@}”，将每个成员组合在一起。
定义成员组：在开始标记“@{”之前放置单独的注释块。（必须包含\name命令）
d.头文件模版：
/*!
@brief摘要
@file文件名
@author作者
@version版本
@data 日期
@note注释
@waring警告
*/
e :函数的注释：
/*
@brief 函数名
@details函数说明
@param参数
@return 返回值
f : eg:
/** 构造函数
@param[in] pConfig指向TASKCONFIG结构体的指针
@param[in] strWndName目标窗口的名称,如果此参数为空则不和任何窗口交互
@param[in] hRes欲使用的资源句柄,如果参数为空则不使用资源
@warning pConfig不能为空
*/
5.所遇到的相关问题
1）中文注释在文档中乱码。
解决：在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”，这样基于GB的文本编辑器生成的代码就可以正常使用了
2)如何输出.chm文件
必须安装微软或其相兼容的chm编译系统。通常为HTML Help Workshop。
首先在[Wizard...]的Output页面中，选择HTML，然后选择到prepare for compressed HTML(.chm)。
其次在[Expert...]的HTML页面中，将HHC_LOCATION指向微软的hhc工具。通常为C:/Program Files/HTML Help Workshop/hhc.exe。然后点击OK，保存，编译即可。
收藏
举报
TAG:
