Doxygen文档
Doxygen文档
Doxygen可以为C++, C, Java, IDL (Corba and Microsoft flavors) PHP和C#生成文档
大致用途有三：
可以生成一个在线html文档或者一个离线的LATEX格式文档也支持RTF(MS-Word) PostScript, hyperlinked PDF, compressed HTML, 和Unix man pages多种格式生成。文档直接由源码生成，这使得保持文档和代码一致性更加轻松。
可以配置doxygen从无文档的源码中提取代码结构。这就便于在大型源码中迅速上路。也可以将这些不同元素间的关系使用图形表达出来，包括依赖图，继承图和collaboration图，这些都是自动生成的。
甚至可以使用它来生成平常的文档，例如手册
Doxygen在Linux下开发，但高度可移植，可运行在各种平台之下。
这个手册包括下面三个部分，每个部分分为以下几个章节
第一部分是用户手册
Installation讲述如何下载，编译和安装doxygen
Getting started如何快速上手
Documenting the code讲述使用代码生成文档的各种方式
Lists讲述如何生成列表
Grouping讲述如何组织这些元素
Including formulas讲述如何在文档中插入公式
Graphs and diagrams讲述doxygen可以生成的各种图表
Preprocessing解释doxygen如何处理宏定义
Linking to external documentation解释如何让doxygen与外部文档生成链接
Frequently Asked Questions常见问题
Troubleshooting如何解决常见问题
第二部分是参考手册
Features doxygen特性
Doxygen History doxygen的开发历史和开发任务
Doxygen usage如何使用doxygen
Doxytag usage如何使用doxytag程序
Doxywizard usage如何使用doxywizard程序
Installdox usage在使用tag文件时，如何使用doxygen所生成的installdox脚本
Output Formats如何生成Doxygen所支持的各种输出文件格式
Automatic link generation如何在文档中添加链接到文件，类和成员
Configuration如何调整doxygen来生成你想要的文档
Special Commands在文档内可以使用的特殊命令
HTML Commands文档内可以使用的HTML命令
第三部分文档是为开发者准备的：
Doxygen's Internals描述了doxygen是如何设计的
Perl Module output format documentation描述了如何使用PerlMod输出
Internationalization explains解释了如何添加对新的输出语言的支持
第一章：出发吧
程序doxygen是分析源码和生成文档的。可以参考Doxytag usage了解详细的使用方法。只是在没有源码时，所以需要生成对外部文档的引用时（例如doxygen所生成的文档），使用Doxytag。
下图展示如何工具间的关系和工具间信息的流程