DoxyGen文档三

原创 2003年12月28日 12:26:00
 

Step 2:运行doxygen<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

输入下面的命令,生成一个文档:

doxygen <config-file>

Doxygen将在输入目录下生成一个htmlrtflatexman目录,分别对应于HTMLRTF<?xml:namespace prefix = v ns = "urn:schemas-microsoft-com:vml" />CSDN_Dev_Image_2003-12-262135490.gifUnix-Man文件格式。

 

       缺省的输出目录是doxygen的目录。使用OUTPUT_DIRECTORYHTML_OUTPUT, RTF_OUTPUTLATEX_OUTPUTMAN_OUTPUT可以进行修改。如果输出目录不存在,doxygen会创建出来。

生成的html文档需要一个支持CSS的浏览器。

 

The generated CSDN_Dev_Image_2003-12-262135490.gifdocumentation must first be compiled by a CSDN_Dev_Image_2003-12-262135490.gifcompiler (I use teTeX distribution version 0.9 that contains CSDN_Dev_Image_2003-12-262135496.gifversion 3.14159). To simplify the process of compiling the generated documentation, doxygen writes a Makefile into the latex directory. By typing make in the latex directory the dvi file refman.dvi will be generated (provided that you have a make tool called make of course). This file can then be viewed using xdvi or converted into a PostScript file refman.ps by typing make ps (this requires dvips). To put 2 pages on one physical page use make ps_2on1 instead. The resulting PostScript file can be send to a PostScript printer. If you do not have a PostScript printer, you can try to use ghostscript to convert PostScript into something your printer understands. Conversion to PDF is also possible if you have installed the ghostscript interpreter; just type make pdf (or make pdf_2on1). To get the best results for PDF output you should set the PDF_HYPERLINKS tag to YES.

       CSDN_Dev_Image_2003-12-262135490.gif文档必须首先经过CSDN_Dev_Image_2003-12-262135490.gif编译器(我手头上的是teTeX version 0.9其中包括CSDN_Dev_Image_2003-12-262135496.gifversion 3.14159)。

 

Step 3: Documenting the sources为源码添加注释

Although documenting the source is presented as step 3, in a new project this should of course be step 1. Here I assume you already have some code and you want doxygen to generate a nice document describing the API and maybe the internals as well.

 

如果配置文件中EXTRACT_ALL设置为NO(缺省值),doxygen就只为documented membersfilesclassesnamespaces生成文档。那么应该如何为这些元素添加注释呢?对于membersclassesnamespaces有两个基本选项:

1.        memberclassnamespace之前添加special注释。对于fileclassnamespace members也直接可以在该member后添加注释。参考Special documentation blocks一章。

2.        在其他地方(另一个文件或位置)放置一个特殊的文档块并在此文档块中放置一个structural command。一个structural command in链接到、一个文档块到一个特定的可以documented(例如一个memberclassnamespacefile)。具体参考Documentation at other places一章。

文件只能只能使用第二种选项,因为没有办法将一个注释块放在文件前。当然,file memberfunctionsvariabletypedefsdefines)不需要一个显式的structural command;只要在其前后放置一个特殊的注释就OK了。

 

特殊注释块中的文本被写入到HTMLCSDN_Dev_Image_2003-12-262135490.gif之前,会作个parse

parse的过程中有以下几步:

·         执行文档中的Special Commands

·         If a line starts with some whitespace followed by one or more asterisks (*) and then optionally more whitespace, then all whitespace and asterisks are removed.

·         空白行被认为是段的分隔符。无需再使用一个new-paragraph命令。

·         出现在文本中的单词,如果和documented类相匹配,就生成一个到documented类的链接。

·         Links to members are created when certain patterns are found in the text.参见Automatic link generation以获取有关自动创建链接。

·         HTML tags that are in the documentation are interpreted and converted to CSDN_Dev_Image_2003-12-262135490.gifequivalents for the CSDN_Dev_Image_2003-12-262135490.gifoutput. See section HTML Commands for an overview of all supported HTML tags.

如何用doxygen生成文档

Doxygen是一款基于源代码生成文档的工具,类似于Java中的javadoc. 概念:文档和注释的区别 文档(Documentation) 是给代码的使用者准备的,或者是更高一级的开发...
  • hitlion2008
  • hitlion2008
  • 2013年03月07日 21:05
  • 8450

使用doxygen生成注释文档——visual studio

前期准备:代码注释。 这里介绍两个方法: 一.安装插件 1. 安装GhostDoc插件。(建议设置快捷键为shift+Alt+j) 2. 回到vs界面规范注释规则。 Tools->GhostDoc->...
  • index_cqq
  • index_cqq
  • 2016年03月22日 16:48
  • 2337

使用Doxygen生成全中文的chm帮助文档

下载和安装 Doxygen到 Doxygen 官网 下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。下...
  • xzytl60937234
  • xzytl60937234
  • 2017年04月22日 15:55
  • 798

用 Doxygen 自动生成文档

              用 Doxygen 自动生成文档             Horin|贺勤        Email: horin153@msn.com        Blog: http...
  • horin153
  • horin153
  • 2007年04月30日 15:09
  • 6403

用doxygen生成中英文帮助

来源:http://www.opencv.org.cn/forum/viewtopic.php?f=1&t=2635#p9188 用doxygen生成中英文帮助由 chai2010 于 2008-02...
  • hitxiaya
  • hitxiaya
  • 2010年11月26日 13:52
  • 765

doxygen生成word文档

doxygen生成rtf/word使用小心得2009-07-26 19:53       硕士毕业要写个技术文档,蒙了,真麻。怎么也都不行,后来老师给指了条路:使用doxygen。      网上有许...
  • jiabin_007
  • jiabin_007
  • 2010年01月19日 17:37
  • 1512

Doxygen生成注释文档

概述:  Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Do...
  • tuwenqi2013
  • tuwenqi2013
  • 2017年04月11日 13:27
  • 1093

利用doxygen生成python文档

On and off I have been developing a little Python module to provide KP-ABE and CP-ABE functionality ...
  • carolzhang8406
  • carolzhang8406
  • 2015年11月09日 14:22
  • 1566

Doxygen自动文档生成工具在Eclipse中的集成及使用举例

你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办...
  • lanxuezaipiao
  • lanxuezaipiao
  • 2014年02月16日 17:57
  • 4128

用doxygen自动生成详细设计文档

以前写程序的时候就是从开始就是编码,调试通过了就算结束了。工作了以后这个规则就变了,先要写概要设计文档,再详细文档,再编码,再测试,再返工。。。。。。当后面测试返工调整的时候与以前设计的思路可能已经不...
  • stepbystep_1_1
  • stepbystep_1_1
  • 2009年03月13日 15:58
  • 1594
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:DoxyGen文档三
举报原因:
原因补充:

(最多只允许输入30个字)