概览

第一部分是用户手册

  • 安装”部分讨论了如何下载、编译和安装 Doxygen 到您的平台。
  • 入门”部分指导您快速生成第一份文档。
  • 代码文档化”部分演示了各种代码文档化的方法。
  • Markdown 支持”部分展示了 Doxygen 支持的 Markdown 格式。
  • 列表”部分展示了如何创建列表。
  • 分组”部分展示了如何将内容分组。
  • 包含表格”部分展示了如何在文档中插入表格。
  • 包含公式”部分展示了如何在文档中插入公式。
  • 图和流程图”部分描述了 Doxygen 可以生成的图表和流程图。
  • 预处理”部分解释了 Doxygen 如何处理宏定义。
  • 自动链接生成”部分展示了如何在文档中放置文件、类和成员的链接。
  • 输出格式”部分展示了如何生成 Doxygen 支持的各种输出格式。
  • 搜索”部分展示了在 HTML 文档中进行搜索的各种方法。
  • 外部索引和搜索”部分展示了如何使用外部搜索和索引工具。
  • 附加文档”部分解释了如何创建与 API 无关的文档页面。
  • 定制输出”部分解释了如何定制 Doxygen 生成的输出。
  • 定制命令”部分展示了如何在注释中定义和使用定制命令。
  • 链接到外部文档”部分解释了如何让 Doxygen 创建链接到外部生成的文档。
  • 常见问题”部分解答了常见问题。
  • 故障排除”部分告诉您遇到问题时该怎么做。

第二部分是参考手册

  • 功能”部分概述了 Doxygen 的能力。
  • Doxygen 用法”部分展示了如何使用 doxygen 程序。
  • Doxywizard 用法”部分展示了如何使用 doxywizard 程序。
  • 配置”部分展示了如何精细调整 Doxygen,以便生成您想要的文档。
  • 特殊命令”部分概述了文档中可以使用的特殊命令。
  • HTML 命令”部分概述了文档中可以使用的 HTML 命令。
  • XML 命令”部分概述了文档中可以使用的 C# 风格的 XML 命令。
  • Emoji 支持”部分介绍了如何在文档中使用 emoji。

第三部分提供了开发者信息


Doxygen 许可证

Copyright © 1997-2025 作者: 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,协调了国际化支持。以及所有为多种语言提供翻译的语言维护者。
  • 以及许多许多其他为建议、补丁和错误报告做出贡献的人。

赞助链接
(与 doxygen 无关)

Heers