DoxyGen文档之二

原创 2003年12月29日 17:19:00

下图展示如何工具间的关系和工具间信息的流程<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

<?xml:namespace prefix = v ns = "urn:schemas-microsoft-com:vml" />CSDN_Dev_Image_2003-12-262132570.png

Doxygen information flow

Step 1:创建一个配置文件

Doxygen使用一个配置文件来决定所有的设置。每个工程都应有自己的配置文件。一个工程可以由单个的源文件组成,也可以是一个递归扫描的树。

为简化配置文件的创建,doxygen可以给你创建一个模板配置文件。命令行方式下使用-g参数:

doxygen -g <config-file>

参数<config-file>是配置文件的名字。如果忽略,那么将会创建一个名为Doxyfile的文件。如果名为<config-file>的文件已经存在,那么doxygen将会将其改名为<config-file>.bak。如果使用-(例如减号)作为文件名,doxgen将会从标准输入中读取这个配置文件。

配置文件很像Makeflie的文件格式。在组成上它有很多assignments (tags)

TAGNAME = VALUE or
TAGNAME = VALUE1 VALUE2 ...

所生成的模板配置文件中多数tag都可以使用缺省值。可参考Configuration这一章获得有关配置文件更详细的说明。

       如果你不希望使用notepad手工编辑配置文件,那么你要研究一下doxywizard,这个exedoxygenGUI前台,用于读写doxygen配置文件,并可以通过对话框设置参数。对于一个只有少量C/C++文件(.h.cpp)的工程,甚至可以在INPUT处留空,doxygen将自动在当前目录下查找源文件。(好像没什么用J

 

如果是一个大工程,有个源文件目录或一个树形目录,这时就应该在INPUT中进行设置了,并在FILE_PATTERNS处添加一到多个文件pattern(例如*.cpp *.h)。只有符合pattern的文件会被分析(如果pattern未作设置,将会使用一个源文件扩展名列表)。对于递归分析源文件树,必须将RECURSIVE设置为YES(这个对于大工程是一定的了)。如果需要更进一步定制文件列表可以使用EXCLUDEEXCLUDE_PATTERNS。举例,要忽略所有的测试工程目录,可以这样作(看来也很有用,很多时候专门建了一个include目录,这样就和工程中的文件重复了):

 EXCLUDE_PATTERNS = */test/* 

Doxygen通常分析C/C++源文件。如果一个文件是.idl.odl后缀明,将会认为是IDL文件。如果是.java后缀,将会认为是一个Java文件。如果是.cs后缀,将会认为是一个C#文件。最后.phpphp4.inc.phtml都认为是PHP文件。

 

如果对已有工程(使用doxygen未知的注释),可以使用EXTRACT_ALL选项。这样doxygen将尝试对源码中的所有注释进行分析。Please note that as a consequence warnings about undocumented members will not be generated as long as EXTRACT_ALL is set to YES.

 

有时要分析一些工程中的一部分,cross-reference源文件中的一个注释类会很有用。将SOURCE_BROWSER设置为YESDoxygen可以生成cross-references。也可以INLINE_SOURCES设置为YESIt can also include the sources directly into the documentation by setting INLINE_SOURCES to YES (this can be handy for code reviews for instance).

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具。对于Objective-C来说,目前最好用的工具是appledoc和doxygen。可是这两种工具对于注释的要求略有区别。于是我经...
  • muyu114
  • muyu114
  • 2013年07月24日 17:56
  • 7773

doxygen 使用简介(C,C++为代码作注释)

doxygen注释块 doxygen注释块其实就是在C"C++注释块的基础添加一些额外标识, 使doxygen把它识别出来, 并将它组织到生成的文档中去。 在每个代码项中都可以有两类描述,...
  • u012723995
  • u012723995
  • 2015年08月04日 16:13
  • 1147

如何用doxygen生成文档

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

watcom关于fortran77的文档之二

  • 2008年10月01日 16:06
  • 258KB
  • 下载

JDK1.5中文文档之二

  • 2008年07月29日 15:21
  • 9.2MB
  • 下载

《Oracle 9i中文版基础教程 》随书光盘--整书内容PDF文档---之二.rar

  • 2009年08月05日 11:40
  • 13.74MB
  • 下载

ADS1.2官方文档之二

  • 2009年01月16日 09:24
  • 4.49MB
  • 下载

Doxygen—程序文档生成工具

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和J...
  • bigpudding24
  • bigpudding24
  • 2015年04月24日 15:40
  • 6660

Xcode4快速Doxygen文档注释 — 简明图文教程(3分钟后爽歪歪)

http://blog.chukong-inc.com/index.php/2012/05/16/xcode4_fast_doxygen/ Xcode4快速Doxyg...
  • whgggg
  • whgggg
  • 2013年07月10日 08:39
  • 754

使用Doxygen为VHDL工程生成文档模板

在开发一个项目的时候,也会同时写说明文档的,这时候大家会自然而然想到用word来写,但是word写出来的文档,不便于阅读,所以这里推荐一个文档生成工具:Doxygen。 目前的Doxygen还不支持v...
  • k331922164
  • k331922164
  • 2016年01月19日 00:14
  • 1077
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:DoxyGen文档之二
举报原因:
原因补充:

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