Doxygen学习总结（一）

1.Doxygen是一个用来解析源码包和生成文档的工具。依靠源码中的注释，Doxygen可以轻松地生成多种格式的帮助文档。和Qt的qdoc3.exe(Qt帮助文档生成工具)功能类似。

2.支持在大多数操作系统上运行，如：unix（包括linux）、windows家族、Mac系统。

3.支持C /C++, Java, Objective-C , Python，Fortran, VHDL，IDL（Corba和Microsoft 家族）, PHP， C#。

4.输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。

 

Doxygen运行需要两个条件

a 要有注释的源码，可使用Qt注释风格，JavaDoc风格等等。

b 要有个配置文件，可以通过Doxygen的前端界面DoxyWizard生成，也可以通过前端界面调用Doxygen生成帮助文档，也可以自己通过cmd调用。

 

DoxyWizard是一个界面，用Qt编写，界面它分四个模块。

step1 ：doxygen的路径。

step2 ：

             Wizard（向导）  非常方便的向导。可以生成默认的配置文件。

             Expert （专家） 所有的配置文件的属性自己定义（配置文件说明，可查看手册或者鼠标划过时左下角的注释。点击属性的右键可恢复默认值）。

step3 ：生成帮助文档，根据配置文件的设置，生成文档的位置、格式。

 

在Qtcreator是一个IDE，它有一个提示功能，当你在QtCreator添加源码，并且源码的帮助文档qch文件添加到QtCreator的帮助系统之后，鼠标滑过源码的class，会在class上浮现\brief简短描述。

在Doxygen怎么会没有呢，经过查找，不是qhp、qch文件的问题，是我们原来的帮助文档都是用qdoc3.exe生成的html文件，qdoc3生成的在\brief的前后行添加了如下：

类QFtp的html文件，可查看qt\doc\html\下的文件

 

<!-- $$$QFtp-brief -->
<p>The QFtp class provides an implementation of the client side of FTP protocol. <a href="#details">More...</a></p>
<!-- @@@QFtp -->

而Doxygen生成的html文件却没有这两句话。

<!-- $$$QFtp-brief -->

<!-- @@@QFtp -->

所以导致Doxygen生成的qch文件用于QtCreator帮助系统，在源文件中没有brief提示。（笨方法，手动添加）