《Doxygen中文手册》之索引

介绍

Doxygen是可用于C++、 C、 Java、 Objective-C、 Python、 IDL (Corba 和 Microsoft flavors)以及部分PHP、 C#和 D语言的文档系统。

它能通过以下三种方式帮助你：
　　1，它能从一系列源文件中生成在线浏览文档（HTML形式）或离线参考手册（LATEX形式）。还支持RTF（MS-Word），PostScript，带超链接的PDF，压缩的HTML和Unix man页。文档是直接从源文件中提取出来的，这使得文档与源代码很容易保持同步。
　　2，通过配置doxygen，你可以从未文档化的源文件中提取出代码结构。这对于从大的源码包中快速理清头绪是非常有用的。它还能自动产生出包含关系图、继承图和协作图，使你能直观地看出各种元素间的关系。
　　3，你甚至可以“滥用“doxygen来创建平常的文档（就像本文档）。

doxygen是在Linux和Mac OS X下开发的，但是它被设计成高可移植的。这使得它可运行在其它Unix变种操作系统上。此外，它还能在windows下运行。

本手册分为三部分，其中每个部分又分为几节。

第一部分是用户手册：

• Installation一节讨论了如何在你的平台上下载、编译和安装doxygen。
• Getting started一节告诉你如何快速地产生你的第一块文档。
• Documenting the code 一节示范了代码被文档化的多种方法。
• Lists 一节展示了如何创建项目列表。
• Grouping一节展示了如何将各种东西集合在一起以组成一个项目列表。
• Including formulas一节展示了如何在文档中插入规则。
• Graphs and diagrams描述了doxygen可生成的图表和图形。
• Preprocessing一节说明了doxygen是如何处理宏定义的。
• Automatic link generation一节展示了如何在文档中链接文件、类和成员。
• Output Formats一节展示了如何生成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脚本。
• Configuration一节显示了如何调整doxygen以生成你要的文档。
• Special Commands一节显示了可在文档中使用的特殊命令的概述。
• HTML Commands一节显示了可在文档中使用的HTML命令的概述。
• XML Commands一节显示了可在文档中使用的XML命令的概述。

第三部分是为开发者提供的信息：

• Doxygen's Internals一节给出了doxygen内部构造的一个整体概述。
  
• Perl Module output format documentation 显示了如何使用PerlMod的输出。
• Internationalization 一节说明了如何增加对新的输出语言的支持。

Doxygen许可证
Copyright © 1997-2005 by Dimitri van Heesch。
Doxygen 遵循 GNU General Public License。
Doxygen产生的文档不受此许可证的影响。

用户例子

Doxygen支持许多输出格式，HTML是其中最流行的一种。我搜集了一些来自真实工程，使用了doxygen的漂亮的例子。

它们是一系列使用doxygen的工程中的一部分。如果你知道其它使用了doxygen的工程，请告诉我，我会将它加进来。

未来的工作

虽然doxygen已经被很多人成功地使用，但仍有提升的空间。因此，我编辑了一个可能或被请求增强的列表。

感谢
（略）