# `doxygen`

{guilabel}`预览`：{daobook}`doxygen`

{daobook}`#` 工作是：

- {github}`daobook/doxygen`：fork 项目 {github}`doxygen/doxygen`，并基于 `master` 切出分支 `xin` 用于中国化；同时部署到 `gh-pages` 分支。

## Doxygen

Doxygen 是事实上的标准工具，用于从注释的 C++ 资源中生成文档，但它也支持其他流行的编程语言，如 C、Objective-C、C#、PHP、Java、Python、IDL（Corba、Microsoft 和 UNO/OpenOffice 风味）、Fortran、VHDL，以及某种程度上的 D。

Doxygen 可以在三个方面帮助你：

- 它可以从一组文档源文件中生成一个在线文档浏览器（HTML）和/或一个离线参考手册（LaTeX）。它还支持生成 RTF（MS-Word）、PostScript、超链接的 PDF、压缩的 HTML、DocBook 和 Unix man pages 的输出。文档是直接从源文件中提取的，这就更容易保持文档与源代码的一致性。
- 你可以配置 doxygen 来从无文档的源文件中提取代码结构。这对于在大型源码分布中快速找到你的方向非常有用。Doxygen 还可以通过包括依赖图、继承图和协作图来可视化各种元素之间的关系，这些都是自动生成的。
- 你也可以使用 doxygen 来创建正常的文档（就像 doxygen 用户手册和 doxygen 网站所做的那样）。

## 下载

Doxygen 的最新二进制文件和源代码可以从以下网站下载：<https://www.doxygen.nl/>。

## 开发者

* Linux & Windows 和 MacOS 的构建状态：<a href="https://github.com/doxygen/doxygen/actions"><img alt="Github Actions Build Status" src="https://github.com/doxygen/doxygen/workflows/CMake%20Build%20for%20Doxygen/badge.svg"></a>

* Coverity 扫描构建状态：<a href="https://scan.coverity.com/projects/2860"> <img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/2860/badge.svg"/> </a>

* Doxygen 的 Doxygen 文档：<a href="https://codedocs.xyz/doxygen/doxygen/"><img src="https://codedocs.xyz/doxygen/doxygen.svg"/></a>

* 安装：请阅读手册中的 [安装](https://www.doxygen.nl/manual/install.html) 部分