インストール

Doxygenをまだダウンロードしていない場合は、ダウンロードページにアクセスして最新版を入手してください。

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

ソース配布版をダウンロードした場合、実行可能ファイルをビルドするには少なくとも以下のものが必要です。

  • GNUツール flexbisonlibiconvGNU 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可視化ツールキットバージョン2.38以降。インクルード依存関係グラフ、グラフィカルな継承グラフ、およびコラボレーショングラフに必要です。graphvizを自分でコンパイルする場合は、freetypeサポートを含めるようにしてください(freetypeライブラリとヘッダーファイルが必要です)。そうしないと、グラフが適切なテキストラベルをレンダリングしません。
  • HTML出力で数式を使用する場合(MathJaxを使用しない場合)、またはpdflatexを使用しない場合は、Ghostscriptインタープリターが必要です。www.ghostscript.comで見つけることができます。

テストには、少なくとも以下の追加の依存関係が必要です。

  • xmllint (libxml2-utils)
  • bibtex (texlive-binaries)

コンパイル手順

  1. まだアーカイブを解凍していない場合は解凍します。

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

  2. ビルドディレクトリを作成します(例えば、ソースツリー内)。

    cd doxygen-$VERSION
    mkdir build
    cd build
    

  3. Makefileジェネレータでcmakeを実行します。

    cmake -G "Unix Makefiles" ..
    

    cmakeは使用しているプラットフォームを特定しようとし、必要なツールを探します。不足しているものがあれば報告します。

    Qt-5.14以降がインストールされており、GUIフロントエンドをビルドしたい場合は、次のように有効にする必要があります。

    cmake -Dbuild_wizard=YES ..
    

    他の設定オプションの概要については、以下を使用してください。

    cmake -L ..
    

  4. makeを実行してプログラムをコンパイルします。

    make
    

    プログラムは問題なくコンパイルされ、バイナリ(doxygenおよびオプションでdoxywizard)はビルドディレクトリ内のbinディレクトリに利用可能になります。

  5. オプション:ユーザーマニュアルを生成します。

    cmake -Dbuild_doc=YES ..
    make docs
    

    DoxygenにHTMLおよびPDFドキュメントを生成させるには。

    ビルドディレクトリ内のHTMLディレクトリには、HTMLドキュメントが含まれます(HTMLブラウザでhtmlディレクトリ内のファイルindex.htmlを指すだけです)。

  6. オプション:静的リンク

    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パッケージの一部です)。他のinstallツールでは、バイナリが間違ったディレクトリに置かれる可能性があります!

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

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

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

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

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

次のステップは、bisonflexのモダンなバージョンをインストールすることです(https://sourceforge.net/projects/winflexbison/filesを参照し、win_flex_bison3-latest.zipを選択します。インストール後、それらをpathに追加し、win_flex.exeflex.exeに、win_bison.exebison.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 Help Workshopが必要です。2021年初頭に、Microsoftはダウンロードリンクなどを含む元のページをオフラインにしました(HTML Help Workshopはすでに長年メンテナンスモードでした)。HTML Help Workshopは、Webアーカイブからインストール実行ファイルをダウンロードできます。

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

PDF出力や科学的な数式を使用するには、LaTeXGhostscriptもインストールする必要があります。

{\LaTeX}にはいくつかのディストリビューションがあります。Doxygenで動作する人気のものはMikTexproTeXtです。

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

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

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