Doxygen配置(翻译)
使用Doxygen文档开发工具时需要进行的配置:可执行文件 doxygen 是原代码分析和生成文档的主要工具. 请看 Doxygen usage 章节来获取更详细的使用帮助.
Doxytag可执行文件---仅仅是用来实现帮助程序员生成不需要看原代码就能了解工程部署信息的doxygen文档的参考文档( 例如:那些使用doxygen生成的文档).请看Doxytag usage 章节来获得更多的使用帮助.
doxywizard 可执行文件很容易就能使用,它是用来为doxygen工具提供配置信息的一个图形化工具.
下面的图显示了开发工具之间的相互关系信息:
http://www.stack.nl/~dimitri/doxygen/infoflow.gif
图:Doxygen information flow
Step 1: 创建一个配置文件
Doxygen使用一个配置文件来确定它所有的设置. 每个工程都应该有它自己的配置文件.
一个工程可以只有一个原文件, 也可以是工程中所有原文件的递归扫描得到的原文件的树状视图。
为了简化doxygen生成配置文件的工作, doxygen 可以为你提供一个模板化的配置文件.
1. 为了创建一个模板化的配置文件,只需要调用doxygen并从命令行中敲入-g:
doxygen -g <config-file>
其中 <config-file>是某个模板化的配置文件的文件名. 如果你省略了文件名, doxygen会为你生成一个默认的Doxyfile的配置文件. 如果<config-file>是一个已经存在的文件名, doxygen 在生成配置模板之前,将会生成一个 <config-file>. Bak备份文件。
2. 如果你使用 - (例如:减号) 作为文件名doxygen将会把你从键盘输入的文字当作配置文件名。
配置文件有着和Makefile相似的格式.主要是:包含了很多的“标志”分配符格式 (tags):
例如:
TAGNAME = VALUE or
TAGNAME = VALUE1 VALUE2 ...
在生成文档模板时,你可以使用默认(即:保留大多数的TAGS)详细信息请看 Configuration 这一章节来获取更多的信息.
如果你不想使用文本编辑工具来编写配置文件,你应该看看 doxywizard 章节的描述, 它是一个可以用来创建/读/写doxygen 配置文档的图形化工具,同时它也可以在路径中进行全路径配置来使doxygen正常工作。
3. 对于一个有很少的原文件和头文件组成的C/C++工程来说, 你可以保留 INPUT 标志为“空” ,那么 doxygen 将会在当前路径下搜索原文件.
4. 如果你的工程很大,你应该把你的工程文件的“根目录”放在INPUT标志后面,需要添加到工程中的文件应该放到FILE_PATTERNS 标志之后(例如: *.cpp *.h). 至少是匹配了1项的文件才能被doxygen程序读入并分析(如果省略了这项设置,则会使用doxygen配置列表中的格式).
补充:asp教程,高级应用