- 博客(9)
- 收藏
- 关注
原创 DoxyGen文档之八
第五章:添加公式Doxygen allows you to put formulas in the output (this works only for the HTML and output, not for the RTF nor for the man page output). To be able to include formulas (as images) in the HTM
2003-12-29 17:26:00 1865
原创 DoxyGen文档之九
第六章:Graphs&diagrams图表Doxygen有内建生成生成对C++类层次图的功能。Doxygen使用graphviz 1.5中的”dot”工具来生成更多高级图。Graphviz由AT&T的Bell Labs开发,网址是http://www.research.att.com/sw/tools/graphviz/如果你已经有了”dot”工具,那么可以将HAVE_DOT设置为YE
2003-12-29 17:26:00 2354 1
原创 DoxyGen文档之七
第四章:Grouping归组Doxygen有两种机制进行归组。第一种是全局级,为每个group创建一个新的page。这些groups在注释中被称作“modules”。另一种机制使用于一些compound entity中的member list,称为“member group”。Modules模块Modules是一种归组things在分离的page上的方式。组的成员可以是file,nam
2003-12-29 17:20:00 2288
原创 DoxyGen文档之二
下图展示如何工具间的关系和工具间信息的流程Doxygen information flowStep 1:创建一个配置文件Doxygen使用一个配置文件来决定所有的设置。每个工程都应有自己的配置文件。一个工程可以由单个的源文件组成,也可以是一个递归扫描的树。为简化配置文件的创建,doxygen可以给你创建一个模板配置文件。命令行方式下使用-g参数:doxygen -g
2003-12-29 17:19:00 3664 1
原创 DoxyGen文档三
Step 2:运行doxygen输入下面的命令,生成一个文档:doxygen Doxygen将在输入目录下生成一个html,rtf,latex,man目录,分别对应于HTML,RTF, ,Unix-Man文件格式。 缺省的输出目录是doxygen的目录。使用OUTPUT_DIRECTORY,HTML_OUTPUT, RTF_OUTPUT,LATEX_OUTP
2003-12-28 12:26:00 2985
原创 DoxyGen文档之四
第二章:Documenting the code特殊的注释一种特殊的注释是带有一些额外标记的C/C++注释块,这样doxygen就知道需要将其加入到文档中了。对于每个代码块都有两种注释,这两种注释组成了文档:一种是brief 描述另一种是detailed 描述,都是可选的。可以有多于一个的brief 描述和detailed 描述,但是是无效的。顾名思义,一个brief描述只有
2003-12-28 12:26:00 3011
原创 DoxyGen文档之五
在members之后添加注释如果需要为file,struct,union,class或enmu的members添加注释,并且你需要将这些注释放在compound之内,可以考虑将注释块放在member的后面。这样就要在注释块中添加一个“”标记。下面是个例子:int var; /*!这个块在用来在在一个member之后添加一个注释块(Qt风格)还有一种方式int var;
2003-12-28 12:26:00 1929
原创 DoxyGen文档之六
第三章:Lists列表Doxygen有很多方法来创建项目列表Using dashes 使用短横杠在每个行的开始处以“-”打头,以下缩进对齐,列表每项也以“-”打头,下面是个例子 /*! * A list of events: * - mouse events * -# mouse move event *
2003-12-28 12:26:00 1964
原创 Doxygen文档
Doxygen文档ZhangRui@landwind.com.cnDoxygen可以为C++, C, Java, IDL (Corba and Microsoft flavors) PHP和C#生成文档大致用途有三: 可以生成一个在线html文档或者一个离线的LATEX格式文档也支持RTF(MS-Word) PostScript, hyperlinked PDF, com
2003-12-25 10:28:00 5010 1
空空如也
空空如也
TA创建的收藏夹 TA关注的收藏夹
TA关注的人