UNIX でのソースコードからのコンパイル

ソースディストリビューションをダウンロードした場合、実行ファイルをビルドするには、少なくとも次のものが必要です。

GNU ツール flex、bison、libiconv、および GNU make
python (バージョン 2.7 以上、https://www.python.org を参照) が必要です。
プラットフォーム用の Makefile を生成するには、cmake バージョン 3.14 以降が必要です。

Doxygen の機能を最大限に活用するには、次の追加ツールをインストールする必要があります。

Qt Software の GUI ツールキット Qt バージョン 5.14 以上 (Qt 6 を含む)。これは GUI フロントエンド Doxywizard をビルドするために必要です。
${\LaTeX}$ ディストリビューション: たとえば TeX Live これは ${\LaTeX}$ 、Postscript、および PDF 出力を生成するために必要です。
Graph visualization toolkit バージョン 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、man ページは /usr/local/man/man1、ドキュメントは /usr/local/doc/doxygen にインストールされます。これを変更するには、Makefile を編集してください。

注: これが機能するには、GNU install ツールが必要です (coreutils パッケージの一部です)。他のインストールツールでは、バイナリが間違ったディレクトリに配置される可能性があります!

RPM または DEB パッケージがある場合は、これらのパッケージに必要な標準のインストール手順に従ってください。

Windows でのソースコードからのコンパイル

バージョン 1.8.10 以降では、ビルドファイルは cmake で生成する必要があります。cmake は https://cmake.org/download/ からダウンロードできます。

現時点では、Visual Studio 2019 のコミュニティバージョンのみがテストされていますが、他のバージョンでも動作する可能性があります。

または、UNIX 方式で Cygwin または MinGW を使用して Doxygen をコンパイルすることもできます。

次のステップは、最新バージョンの bison と flex をインストールすることです (https://sourceforge.net/projects/winflexbison/ を参照)。インストールして path に追加した後、win_flex.exe を flex.exe に、win_bison.exe を bison.exe に名前変更してください) さらに、python (バージョン 2.7 以上、https://www.python.org を参照) をインストールする必要があります。これらのパッケージはコンパイルプロセス中に必要です。

Doxygen のソース tarball をダウンロードして、どこかに配置します (例: c:\tools を使用)

次に、Visual Studio ネイティブコマンドシェル (x86 または x64 用) を起動して、次のように入力します。

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

ソースを展開します (tar はたとえば https://gnuwin32.sourceforge.net/packages.html から入手できます)。または、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.io/ を参照)。

また、特定の機能を有効にして Doxygen を実行するためにインストールする必要がある追加ツールについては、次のセクションをお読みください。

Windows へのバイナリのインストール

Doxygen は自己インストール型アーカイブとして提供されるため、インストールは非常に簡単です。ダイアログに従うだけです。

インストール後、GraphViz (バージョン 2.38 以降を強く推奨) もダウンロードしてインストールすることをお勧めします。Doxygen は GraphViz パッケージの dot ツールを使用して、より見栄えの良い図をレンダリングできます。設定ファイルの HAVE_DOT オプションを参照してください。

圧縮 HTML ファイルを生成する場合 (設定ファイルの GENERATE_HTMLHELP を参照)、Microsoft HTML ヘルプワークショップが必要です。2021 年の初めに、Microsoft は元のページをオフラインにしました (ダウンロードリンクなど)。HTML ヘルプワークショップはすでに長年メンテナンスモードでした)。HTML ヘルプワークショップは、Web アーカイブ (インストール実行可能ファイル) からダウンロードできます。

Qt 圧縮ヘルプファイルを生成する場合 (設定ファイルの QHG_LOCATION を参照)、Qt の一部である qhelpgenerator が必要です。Qt は Qt Software Downloads からダウンロードできます。

PDF 出力を生成したり、科学的な数式を使用したりするには、LaTeX および Ghostscript もインストールする必要があります。

${\LaTeX}$ には、多くのディストリビューションが存在します。Doxygen で動作する一般的なものは、MikTex および proTeXt です。

Ghostscript は、Sourceforge からダウンロードできます。

${\LaTeX}$ および Ghostscript をインストールした後、latex.exe、pdflatex.exe、および gswin32c.exe (または gswin64c.exe) ツールがコマンドボックスの検索パスに存在することを確認する必要があります。不明な場合は、これらの指示に従い、コマンドボックスからコマンドを実行して動作することを確認してください。

次のセクションに進むか、インデックスに戻ります。

目次

UNIX でのソースコードからのコンパイル

UNIX へのバイナリのインストール

Windows でのソースコードからのコンパイル

Windows へのバイナリのインストール