第一部分构成用户手册
- 安装 部分讨论了如何为您的平台下载、编译和安装 Doxygen。
- 入门 部分告诉您如何快速生成您的第一份文档。
- 代码文档 部分演示了文档代码的各种方法。
- Markdown 支持 部分展示了 Doxygen 支持的 Markdown 格式。
- 列表 部分展示了如何创建列表。
- 分组 部分展示了如何将事物组合在一起。
- 插入表格 部分展示了如何在文档中插入表格。
- 插入公式 部分展示了如何在文档中插入公式。
- 图表 部分描述了 Doxygen 可以生成的图表。
- 预处理 部分解释了 Doxygen 如何处理宏定义。
- 自动链接生成 部分展示了如何在文档中放置指向文件、类和成员的链接。
- 输出格式 部分展示了如何生成 Doxygen 支持的各种输出格式。
- 搜索 部分展示了在 HTML 文档中搜索的各种方法。
- 外部索引和搜索 部分展示了如何使用外部搜索和索引工具。
- 额外文档 部分解释了如何创建与 API 无关的文档页面。
- 自定义输出 部分解释了如何自定义 Doxygen 生成的输出。
- 自定义命令 部分展示了如何在注释中定义和使用自定义命令。
- 链接到外部文档 部分解释了如何让 Doxygen 创建指向外部生成的文档的链接。
- 常见问题 部分提供了常见问题的答案。
- 故障排除 部分告诉您遇到问题时该怎么做。
第二部分构成参考手册
第三部分为开发者提供信息
Doxygen 许可
版权所有 © 1997-2025 by Dimitri van Heesch。
特此授予在 GNU 通用公共许可条款下使用、复制、修改和分发本软件及其文档的权限。本软件不作任何适用性陈述。它“按原样”提供，不带任何明示或暗示的保证。有关更多详细信息，请参阅GNU 通用公共许可。
Doxygen 生成的文档是其生成所用输入的衍生作品；它们不受此许可的影响。
用户示例
Doxygen 支持多种输出格式，其中 HTML 是最受欢迎的。我收集了一些精彩示例，展示了真实项目如何使用 Doxygen。
这些是使用 Doxygen 的项目列表中的一部分。如果您知道其他项目，请告诉我，我会将其添加进去。
未来工作
尽管 Doxygen 已被大量公司和开源项目成功使用，但仍有改进的空间。
您也可以在错误跟踪器中提交增强请求。
致谢
感谢
-
Malte Zöckler 和 Roland Wunderling，DOC++ 的作者。Doxygen 的第一个版本借用了一旧版 DOC++ 的部分代码。尽管此后我几乎重写了所有代码，但 DOC++ 仍然为我编写 Doxygen 提供了一个良好的开端。
- Qt Software 的所有员工，感谢他们创造了漂亮的 GUI 工具包。
- Steffen Schümann，感谢他创建了 Doxygen 使用的 ghc::filesystem。
- Michael McTernan，感谢他创建了现已嵌入 Doxygen 的 mscgen。
- 我的兄弟 Frank，感谢他渲染了标志。
- Harm van der Heijden，感谢他添加了 HTML 帮助支持。
- Wouter Slegers，感谢他注册了 www.doxygen.org 域名。
- Martin Kreis，感谢他添加了 VHDL 支持。
- Parker Waechter，感谢他添加了 RTF 输出生成器。
- Joerg Baumann，感谢他添加了条件文档块、PDF 链接和配置生成器。
- Tim Mensch，感谢他添加了 todo 命令。
- Christian Hammond，感谢他重新设计了网站。
- Ken Wong，感谢他提供了 HTML 树视图代码。
- Talin，感谢他添加了对带有 XML 标记的 C# 风格注释的支持。
- Petr Prikryl，感谢他协调了国际化支持。所有语言维护者，感谢他们提供了多种语言的翻译。
- 还有许多许多其他人的建议、补丁和错误报告。
1.15.0 生成