在 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 需要此工具。
一个发行版：例如TeX Live。生成、Postscript 和 PDF 输出需要此工具。
Graph 可视化工具包 2.38 或更高版本。生成包含依赖图、图形继承图和协作图需要此工具。如果您自己编译 graphviz，请确保包含 freetype 支持（这需要 freetype 库和头文件），否则图形将无法正确渲染文本标签。
对于 HTML 输出中的公式（未使用 MathJax 时）或不希望使用pdflatex的情况，需要 ghostscript 解释器。您可以在www.ghostscript.com找到它。

为了进行测试，至少应具备以下额外依赖项

xmllint (libxml2-ultils)
bibtex (texlive-binaries)

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

解压存档，除非您已经完成此步骤

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中，man 手册页安装到/usr/local/man/man1中，文档安装到/usr/local/doc/doxygen中。要更改此设置，只需编辑 Makefile。

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

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

在 Windows 上从源代码编译

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

目前仅测试了 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 Help Workshop。2021 年初，Microsoft 将包含下载链接等内容的原始页面下线，HTML Help Workshop 多年以来也已处于维护模式）。您可以从网络存档下载 HTML Help Workshop，链接是安装可执行文件。

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

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

有许多发行版。与 Doxygen 兼容的流行发行版有MikTex和proTeXt。

Ghostscript 可以从 Sourceforge下载。

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

前往下一节或返回索引。