DoxygenVersion 1.3.9.1
Main Page(糊涂熊翻译)
简介
Doxygen是一个支持C++, C, Java, Objective-C, IDL(Corba以及微软的类似东东)文档系统。经过某些扩展之后还可以支持PHP,C#和D。
它可以从三个方面帮助你:
1. 可以从一套文档化的源代码中,生成一份可在线浏览的文档(HTML格式)或离线参考手册(LATEX格式)。还可以生成RTF(MS-Word)Z, PostScript, hyperlinked PDF, compressed HTML以及Unix man pages等格式的文档。文档直接从源代码中抽取,这样很容易保持文档和源代码的一致性。
2. 可以配置doxygen来从没有文档化的源代码中抽取代码结构。这一点对于帮助你快速理清大型的源代码包的脉络很有帮助。你还可以将不同元素之间的关系可视化,通过自动生成的依赖图,继承图,协作图。
3. 你甚至可以“滥用”doxygen来创建普通的文档(本文档就是这样创建的)。
Doxygen是在Linux和Mac OS X上面开发的,但是从一开始就考虑了移植的高度方便性。因此,它可以在大多数其它的Unix类型的操作系统上运行得很好。甚至,在Windows上也可以用。
本手册分成三个部分,每一个部分又分为若干个章节。
第一部分是一份用户手册:
“安装”章节讨论了如何为你的平台下载,编译和安装doxygen。
“起步”章节告诉你如何快速生成你的第一份文档。
“源代码的文档化”章节演示了给源代码加上文档的各种方式。
“列表”章节的内容是创建列表的各种方式。
“合组”章节的内容是如何把相关的东东合成一组。
“公式的到入”章节的内容是如何把公式插入到文档里。
“图形和图表”章节描述了doxygen能够生成的图表和图形。
“预处理”章节解释了doxygen是如何处理宏定义的。
“链接自动生成”章节的内容是在文档中,怎样把链接放到文件,类和成员里面。
“输出格式”章节的内容是怎样生成doxygen支持的各种输出格式。
“链接到外部文档”章节解释了如何让doxygen创建指向外部文档的链接。
“常见提问” 章节给出了常见提问的回答。
“故障排除” 章节告诉你碰到故障怎么办。
第二部分是一份参考手册:
“功能”章节是一个doxygen能干什么的概述。
“doxygen历史” 章节的内容是在doxygen的开发过程中,已经做了哪些,以及还有那些事情要做。
“doxygen用法” 章节的内容是怎样使用doxygen工具。
“doxytag 用法” 章节的内容是怎样使用doxytag工具。
“doxywizard 用法” 章节的内容是怎样使用doxywizard工具。
“installdox 用法”章节的内容是怎样使用再使用标签文件的情况下优doxygen自动生成的installdox脚本。
“Configuration” 章节的内容是如何微调doxygen,使之生成你所预期的文档。
“特殊命令”章节的内容是可以用在文档内部的特殊命令的概述。
“HTML命令” 章节的内容是可以用在文档内部的HTML命令的概述。
第三部提供了一些开发人员关心的信息:
“doxygen的内部原理”章节是对doxygen内部结构的一个全局概述。
“Perl模块输出格式文档”章节的内容是怎样使用PerlMod输出。
“国际化”揭示了怎样添加对新的输出语言的支持。