分享
 
 
 

DoxyGen文档之二

王朝other·作者佚名  2006-01-08
窄屏简体版  字體: |||超大  

下图展示如何工具间的关系和工具间信息的流程

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,这个exe是doxygen的GUI前台,用于读写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#文件。最后.php,php4,.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设置为YES,Doxygen可以生成cross-references。也可以INLINE_SOURCES设置为YES。It can also include the sources directly into the documentation by setting INLINE_SOURCES to YES (this can be handy for code reviews for instance).

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有