文档 更新日志 扩展 示例  
概述

第一部分构成用户手册

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

第二部分构成参考手册

  • 第 功能 节概述了 Doxygen 可以做什么。
  • 第 Doxygen 用法 节展示了如何使用 doxygen 程序。
  • 第 Doxywizard 用法 节展示了如何使用 doxywizard 程序。
  • 第 配置 节展示了如何微调 Doxygen，使其生成您想要的文档。
  • 第 特殊命令 节概述了可以在文档中使用的特殊命令。
  • 第 HTML 命令 节概述了可以在文档中使用的 HTML 命令。
  • 第 XML 命令 节概述了可以在文档中使用的 C# 风格的 XML 命令。
  • 第 表情符号支持 节介绍了如何在文档中使用表情符号。

第三部分为开发人员提供信息


Doxygen 许可证

版权所有 © 1997-2024 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