在 UNIX 上从源代码编译

如果您下载的是源代码发行版，您至少需要以下工具来构建可执行文件

GNU 工具 flex、bison、libiconv 和 GNU make
您需要 python（版本 2.7 或更高版本，请参阅 https://pythonlang.cn）。
为了为您的平台生成 Makefile，您需要 cmake 版本 3.14 或更高版本。

为了充分利用 Doxygen 的功能，应安装以下附加工具。

Qt Software 的 GUI 工具包 Qt 版本 5.14 或更高版本（包括 Qt 6）。这是构建 GUI 前端 Doxywizard 所必需的。
${\LaTeX}$ 发行版：例如 TeX Live。这是生成 ${\LaTeX}$ 、Postscript 和 PDF 输出所必需的。
Graph 可视化工具包版本 2.38 或更高版本。需要用于包含依赖图、图形化继承图和协作图。如果您自己编译 graphviz，请确保包含 freetype 支持（这需要 freetype 库和头文件），否则图形将无法渲染正确的文本标签。
对于 HTML 输出中的公式（当不使用 MathJax 时）或者您不想使用 pdflatex 的情况，需要 ghostscript 解释器。您可以在 www.ghostscript.com 找到它。

现在通过执行以下步骤完成编译

解压存档，除非您已经这样做过

gunzip doxygen-$VERSION.src.tar.gz    # uncompress the archive
tar xf doxygen-$VERSION.src.tar       # unpack it

创建一个构建目录（例如，在源树内部）
```
cd doxygen-$VERSION
mkdir build
cd build
```
使用 makefile 生成器运行 cmake
```
cmake -G "Unix Makefiles" ..
```
cmake 尝试确定您使用的平台，并将查找所需的工具。如果缺少某些内容，它会报告。

如果您已安装 Qt-5.14 或更高版本，并且想要构建 GUI 前端，则应按如下方式启用它
```
cmake -Dbuild_wizard=YES ..
```
有关其他配置选项的概述，请使用
```
cmake -L ..
```
通过运行 make 编译程序
```
make
```
程序应该可以顺利编译，二进制文件（doxygen 和可选的 doxywizard）应该在构建目录中的 bin 目录中可用。
可选：生成用户手册。
```
cmake -Dbuild_doc=YES ..
make docs
```
让 Doxygen 生成 HTML 和 PDF 文档。

构建目录中的 HTML 目录现在将包含 HTML 文档（只需将 HTML 浏览器指向 html 目录中的文件 index.html）。

可选：静态链接

如果要构建嵌入 libclang 的 Doxygen 的静态链接版本，则需要首先使用以下选项从源代码构建 LLVM 和 clang

cmake -DLIBCLANG_BUILD_STATIC=ON \
      -DBUILD_SHARED_LIBS=OFF \
      -DLLVM_ENABLE_PIC=OFF \
      -DLLVM_BUILD_LLVM_DYLIB=OFF \
      -DLLVM_BUILD_LLVM_C_DYLIB=OFF \
      -DLLVM_ENABLE_TERMINFO=OFF \
      path_to_llvm_root_source_dir

然后使用这些选项构建 Doxygen

cmake -DCMAKE_BUILD_TYPE=Release \
      "-DCMAKE_FIND_LIBRARY_SUFFIXES=.a" \
      "-ldl;-lz;-lpthread" \
      -Duse_libclang=YES \
      path_to_doxygen_root_source_dir

在 UNIX 上安装二进制文件

在源代码编译完成后，执行 make install 来安装 Doxygen。如果您下载了 Linux 的二进制发行版，请键入

make install

二进制文件安装到目录 /usr/local/bin 中，手册页安装到 /usr/local/man/man1 中，文档安装到 /usr/local/doc/doxygen 中。要更改此设置，只需编辑 Makefile。

注意: 您需要 GNU install 工具才能使其工作（它是 coreutils 包的一部分）。其他安装工具可能会将二进制文件放在错误的目录中！

如果您有 RPM 或 DEB 包，请按照这些包要求的标准安装程序进行操作。

在 Windows 上从源代码编译

从 1.8.10 版本开始，构建文件需要由 cmake 生成。可以从 https://cmake.com.cn/download/ 下载 cmake。

目前仅测试了 Visual Studio 2019 的社区版本，但其他版本也可能有效。

或者，您可以使用 Cygwin 或 MinGW 以UNIX 方式编译 Doxygen。

下一步是安装最新版本的 bison 和 flex（请参阅 https://sourceforge.net/projects/winflexbison/。安装并将它们添加到您的 path 后，将 win_flex.exe 重命名为 flex.exe，并将 win_bison.exe 重命名为 bison.exe）此外，您必须安装 python（版本 2.7 或更高版本，请参阅 https://pythonlang.cn）。这些包在编译过程中是必需的。

下载 Doxygen 的源代码 tarball 并将其放在某个位置（例如，使用 c:\tools）

现在启动 Visual Studio 本机命令 shell（对于 x86 或 x64），然后键入

cd c:\tools
tar zxvf doxygen-x.y.z.src.tar.gz

解压源代码（您可以从例如 https://gnuwin32.sourceforge.net/packages.html 获取 tar）。或者，您可以使用解压程序，例如 7-Zip（请参阅 https://www.7-zip.org/）或使用现代 Windows 系统的内置解压功能）。

现在，您的环境已设置为生成 Doxygen 所需的项目文件。

将目录更改为 doxygen-x.y.z 目录，创建并更改为构建目录

mkdir build
cd build
cmake -G "Visual Studio 14 2015" ..

这将创建一个可以在 Visual Studio 中打开的项目文件。

如果您更喜欢从命令提示符编译，则可以改用以下命令

mkdir build
cd build
cmake -G "NMake Makefiles" ..
nmake

请注意，编译 Doxywizard 需要 Qt 5.14 或更高版本（请参阅 https://doc.qt.ac.cn/）。

另请阅读下一节，了解您可能需要安装的其他工具才能在启用某些功能的情况下运行 Doxygen。

在 Windows 上安装二进制文件

Doxygen 以自安装存档的形式提供，因此安装非常简单。只需按照对话框操作即可。

安装后，建议也下载并安装 GraphViz（强烈建议使用 2.38 或更高版本）。 Doxygen 可以使用 GraphViz 包的 dot 工具来渲染更好的图表，请参阅配置文件中的 HAVE_DOT 选项。

如果您想生成压缩的 HTML 文件（请参阅配置文件中的 GENERATE_HTMLHELP），则需要 Microsoft HTML 帮助工坊。在 2021 年初，微软将包含下载链接的原始页面下线了，HTML 帮助工坊已经多年处于维护模式。您可以从网络存档中下载 HTML 帮助工坊，地址为安装可执行文件。

如果您想生成 Qt 压缩帮助文件（请参阅配置文件中的 QHG_LOCATION），则需要作为 Qt 一部分的 qhelpgenerator。您可以从 Qt Software 下载下载 Qt。

为了生成 PDF 输出或使用科学公式，您还需要安装 LaTeX 和 Ghostscript。

对于 ${\LaTeX}$ ，存在许多发行版。与 Doxygen 一起使用的流行发行版是 MikTex 和 proTeXt。

可以从 Sourceforge 下载 Ghostscript。

安装 ${\LaTeX}$ 和 Ghostscript 后，您需要确保工具 latex.exe、pdflatex.exe 和 gswin32c.exe（或 gswin64c.exe）存在于命令框的搜索路径中。如果您不确定，请按照这些说明进行操作，然后从命令框运行命令以验证它是否有效。

转到下一节或返回索引。