第一部分构成用户手册
- “安装”部分讨论了如何在您的平台上下载、编译和安装 Doxygen。
- “入门”部分介绍了如何快速生成您的第一份文档。
- “代码文档化”部分演示了代码可以被文档化的各种方式。
- “Markdown 支持”部分展示了 Doxygen 支持的 Markdown 格式。
- “列表”部分展示了如何创建列表。
- “分组”部分展示了如何将事物分组。
- “包含表格”部分展示了如何在文档中插入表格。
- “包含公式”部分展示了如何在文档中插入公式。
- “图形和图表”部分介绍了 Doxygen 可以生成的图表。
- “预处理”部分解释了 Doxygen 如何处理宏定义。
- “自动链接生成”部分展示了如何在文档中添加指向文件、类和成员的链接。
- “输出格式”部分展示了如何生成 Doxygen 支持的各种输出格式。
- “搜索”部分展示了在 HTML 文档中搜索的各种方法。
- “外部索引和搜索”部分展示了如何使用外部搜索和索引工具。
- “附加文档”部分解释了如何创建与 API 无关的文档页面。
- “定制输出”部分解释了如何定制 Doxygen 生成的输出。
- “自定义命令”部分展示了如何在注释中定义和使用自定义命令。
- “链接到外部文档”部分解释了如何让 Doxygen 创建指向外部生成的文档的链接。
- “常见问题解答”提供了常见问题的答案。
- “故障排除”告诉您在遇到问题时该怎么做。
第二部分构成参考手册
第三部分提供开发人员信息
Doxygen 许可证
版权所有 © 1997-2026，由 Dimitri van Heesch。
特此授予使用、复制、修改和分发本软件及其文档的权限，遵循 GNU 通用公共许可证的条款。不对本软件的适用性作任何声明。本软件按“原样”提供，不附带明示或暗示的保证。有关更多详细信息，请参阅 GNU 通用公共许可证。
Doxygen 生成的文档是其生产输入产生的衍生作品；这些文档不受本许可证的影响。
用户示例
Doxygen 支持多种 输出格式，其中 HTML 是最受欢迎的。我收集了 一些使用 Doxygen 的真实项目示例。
这些是使用 Doxygen 的 项目列表的一部分。如果您知道其他项目，请 告知我，我会添加它们。
未来工作
尽管 Doxygen 已经被大量公司和开源项目成功使用，但总有改进的空间。
您也可以在 bug 跟踪器 中提交增强请求。
致谢
感谢
-
Malte Zöckler 和 Roland Wunderling，DOC++ 的作者。Doxygen 的第一个版本借用了一些旧版 DOC++ 的代码。尽管我之后重写了几乎所有代码，但 DOC++ 仍然为我编写 Doxygen 提供了一个良好的开端。
- Qt Software 的所有员工，感谢他们创建了出色的 GUI 工具包。
- Steffen Schümann 感谢他创建了 ghc::filesystem，Doxygen 使用了它。
- Michael McTernan 感谢他创建了 mscgen，现在它已被嵌入 Doxygen。
- 我的兄弟 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 感谢他协调了国际化支持。所有语言维护者感谢他们将 Doxygen 翻译成多种语言。
- 还有许多其他人提供了建议、补丁和错误报告。
1.16.0 生成