インストール

Doxygenをまだダウンロードしていない場合は、まずダウンロードページにアクセスして最新のディストリビューションを入手してください。

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

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

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

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

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

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

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

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

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

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

次のステップは、bisonflexの最新バージョンをインストールすることです(https://sourceforge.net/projects/winflexbison/を参照)。インストール後、それらを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 Compressed Helpファイルを生成したい場合(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)のツールがコマンドボックスの検索パスに存在することを確認する必要があります。不明な場合はこれらの手順に従い、コマンドボックスからコマンドを実行して動作することを確認してください。

次のセクションに移動するか、インデックスに戻ります。