doxygen 和 graphviz 的使用

1.Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。

2.Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形,例如类的继承关系图、合作图,头文件包含关系图等。适用于大多数平台的二进制文件可以在 Graphviz 官网 上找到,AIX 二进制文件可以在 perzl.org 上找到。Doxygen使用了Graphviz的布局引擎dot,所以在文档中将其称作dot。

3.本示例是在ubuntu下进行安装doxygen:

    安装命令sudo apt-get install doxygen doxygen-gui

    1)如果已经存在.doxygen文件,直接执行命令doxygen *.doxygen即可产生doc下的html文档;

    2)如果没有,首先使用命令doxywizard打开gui编辑界面,按下列步骤依次选择即可:

    a.Wizard->project中选择文档存储目录;

    b.Wizard->project中选择源文件目录,并设置遍历层叠目录选项;

    c.Wizard->project中选择文档存放的目标目录;

    d.Wizard->mode中选择生成文档的方式及目标编程语言;

    e.Wizard->output中选择所想要生成的格式;

    f.Wizard->diagrams中选择graphviz形成uml和树状图结构;

    g.Expert->project中选择编码格式和文档生成语言;

    h.Run->run doxygen即可,如果显示灰色为选择目录出现\符号或者没有选中,需要对存储目录进行确定选择;

    i.最后在存储文档的目录下会生成相应的文档,例如html目录即为网页结构文档。

4.本示例是在ubuntu下进行安装Graphviz:

    安装命令sudo apt-get install graphviz graphviz-doc

    自己编写dot文档,进行图标生成,具体可参照

    https://www.ibm.com/developerworks/cn/aix/library/au-aix-graphviz/index.html

展开阅读全文

没有更多推荐了,返回首页