インストール

まず、最新のディストリビューションをお持ちでなければ、ダウンロードのページへ行って、取得してください。

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

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

GNU ツール flex, bison, libiconv, GNU make, strip
自分のプラットフォームに応じた Makefile を生成するためには、 cmake version 2.8.12 以降が必要です。

Doxygen の機能を完全に発揮させるには、以下のツールを追加でインストールしてください。
- Qt Software の GUI ツールキット Qt version 4.3 以上(現状、Qt 5.x は未サポートです)。これは GUI フロントエンド doxywizard のビルドに必要です。
- ディストリビューション: 例えば TeX Live これは LaTeX、PostScript、PDF 出力の生成に必要です。
- Graphviz ver.1.8.10 以上
  インクルード依存図、グラフィカルな継承図、およびコラボレーション図のために必要です。
  graphviz を自分でコンパイルするのであれば、フリータイプ・サポート(フリータイプ・ライブラリとヘッダーファイルが必要)をインクルードしてください。
  さもなければ、グラフに適切なテキストラベルが表示されません。
- HTML出力に公式を入れる(MathJaxを使わない場合)、あるいは `pdflatexを使いたくない場合は、ghostscript インタープリタが必要です。
  www.ghostscript.com にあります。
コンパイルは、現在、以下のステップを実行することによって行います。
1. アーカイブを解凍していなければ、解凍します。
  
  gunzip doxygen-$VERSION.src.tar.gz # アーカイブを展開する tar xf doxygen-$VERSION.src.tar # ファイルを取り出す
2. ビルド用のディレクトリを作成(ソースツリーの中など) cd doxygen-$VERSION mkdir build
3. makefileジェネレータを使ってcmakeを実行する cmake -G "Unix Makefiles" .. cmake は、あなたのプラットフォームを決定しようとします。そして、必要なツールを探し、何が欠乏しているかを報告します。
  
  Qt-4.3以上をインストールしていて、GUIフロントエンドをビルドしたいのであれば、以下のコマンドで有効化します。
```
cmake -Dbuild_wizard=YES
```
  他の設定オプションの概略を知るには、次のコマンドを使ってください。
```
cmake -L
```
4. makeコマンドを実行してプログラムをコンパイルしてください make
  
  プログラムは、問題なくコンパイルされ、バイナリ(doxygen と doxywizardはオプション)が、ビルドディレクトリの中のbinディレクトリに出力されます。
5. オプション：ユーザマニュアルを生成する cmake -Dbuild_doc=YES make docs
  
  これによって、HTML, PDFドキュメントが生成されます。ビルドディレクトリ内部のHTMLに、htmlドキュメントがあります(htmlディレクトリのindex.htmlを、HTMLブラウザで開いてください)。

Unix でのバイナリのインストール

ソースコードのコンパイルの後、make install を行って Doxygen をインストールします。 Unix のバイナリ・ディストリビューションをダウンロードしたのであれば、次のように実行してください。

    ./configure
    make install

バイナリはディレクトリ <prefix>/bin にインストールされます。 <docdir>/doxygen にドキュメントとサンプルをインストールするには、 make install_docs を使用してください。

<prefix> はデフォルトでは /usr/local ですが、 configure スクリプトの –prefix によって変更できます。デフォルトの <docdir> ディレクトリは <prefix>/share/doc/packagesですが、configure スクリプトの –docdir によって変更できます。

他に、bin ディレクトリから、直接自分の好きなパスの通った binディレクトリに、手作業でコピーすることもできます。 Doxygen を使うには、これで十分です。

メモ: この方法では、GNUのinstall ツールが必要です (coreutils パッケージの一部)。他のinstallツールではバイナリを間違ったディレクトリに入れてしまうことがあります！

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

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

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

現状、Visual Studio 2013のexpressバージョンのみテストされています。しかし、他のバージョンでも動くでしょう。

他に、Cygwin や MinGWを使えば、Unix方式でコンパイルできます。

次に、bison、flexの最近のバージョンをインストールします(http://sourceforge.net/projects/winflexbison.を参照。インストール後、パスをpath変数に追加し、win_flex.exeをflex.exeに名前変更、win_bison.exeを bison.exeに名前変更します。)。更に、python(バージョン2.6以降。http://www.python.org)をインストールしてください。これらのパッケージは、コンパイルに必要です。

doxygenのソースtarballをダウンロードし、どこか(c:\toolsなど)に保存します。

そして、visual studioのネイティブ・コマンドシェルを起動(x86 or x64)し、

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

と入力し、ソースを解凍します。 tarツールは、http://gnuwin32.sourceforge.net/packages.htmlからダウンロードできます。あるいは、7-Zip(http://www.7-zip.org)のような展開ツール、またはWindowsシステム付属の展開機能を使うこともできます。

以上で、doxygen に必要なプロジェクトファイルを生成する準備ができます。

doxygen-x.y.zにcdして移動し、buildディレクトリを作成してcdします。

mkdir build
cd build
cmake -G "Visual Studio 12 2013"

Doxywizardをコンパイルするには、現在Qtバージョン4 (http://qt-project.org/)が必要です。

Doxygenの特定の機能を有効にするには、他にもインストールが必要なツールがあります。次のセクションで説明します。

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

Doxygenは自己解凍形式で提供されていますので、インストールはきわめてシンプルです。ダイアログに従うだけです。

インストール後、GraphViz(バージョン2.20以上を強く推奨します)もダウンロード、インストールします。Doxygenでは GraphVizパッケージの dotツールを使って図を見栄えよくできます。設定ファイルの HAVE_DOTオプションを見てください。

HTML形式の圧縮ファイル(設定ファイルの cfg_generate_html help "GENERATE_HTMLHELP"を参照)を生成するには、Microsoft HTML help workshopが必要です。 Microsoftからダウンロードして下さい。

Qt形式の圧縮ヘルプファイル(設定ファイルの QHG_LOCATION)を生成するには、Qtのqhelpgeneratorというジェネレータが必要です。Qt Software Downloadsからダウンロードして下さい。

PDF出力が必要な場合や、科学技術の公式を使う場合は、LaTeX 及び Ghostscript をインストールしてください。

LaTeXにはディストリビューションがいくつもあります。Doxygenと相性のよく人気なのはMikTex と proTeXt です。

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

と Ghostscriptをインストールしたら、latex.exe, pdflatex.exe, gswin32c.exeへのパスをコマンドの検索パスに通さなければなりません。確実に動作するか確かめるには、この手順に従ってください。

次のセクションに行く / インデックスに戻る