《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页。⽂档是直接从源⽂件中提取出来的，这使得⽂档与源代码很容易保持同步。
python中文文档  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许可证
Doxygen许可证
Copyright © 1997-2005 by 。
Doxygen 遵循 。
Doxygen产⽣的⽂档不受此许可证的影响。
⽤户例⼦
Doxygen⽀持许多输出格式，HTML是其中最流⾏的⼀种。我搜集了⼀些来⾃真实⼯程，使⽤了doxygen的漂亮的例⼦。 它们是⼀系列使⽤doxygen的⼯程中的⼀部分。如果你知道其它使⽤了doxygen的⼯程，请告诉我，我会将它加进来。
未来的⼯作
未来的⼯作
虽然doxygen已经被很多⼈成功地使⽤，但仍有提升的空间。因此，我编辑了⼀个可能或被请求增强的列表。
感谢
感谢
（略）

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。