Doxygenをまだダウンロードしていない場合は、まずダウンロードページにアクセスして最新のディストリビューションを入手してください。
ソースディストリビューションをダウンロードした場合、実行可能ファイルをビルドするには、少なくとも以下が必要です
flex
、bison
、libiconv
、およびGNU make
python
(バージョン2.7以降、https://www.python.orgを参照)が必要です。Makefile
を生成するには、cmakeバージョン3.14以降が必要です。 Doxygenの機能を最大限に活用するには、以下の追加ツールをインストールする必要があります。
テストには、少なくとも以下の追加の依存関係が必要です
コンパイルは、以下の手順を実行することで行われます
アーカイブを展開します(まだ行っていない場合)。
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
ソースコードのコンパイル後、make install
を実行してDoxygenをインストールします。Linux用のバイナリディストリビューションをダウンロードした場合は、次のように入力します
make install
バイナリは/usr/local/bin
ディレクトリに、manページは/usr/local/man/man1
に、ドキュメントは/usr/local/doc/doxygen
にインストールされます。これを変更するにはMakefileを編集するだけです。
RPMまたはDEBパッケージをお持ちの場合は、これらのパッケージに必要な標準のインストール手順に従ってください。
バージョン1.8.10以降、ビルドファイルはcmakeによって生成される必要があります。cmakeはhttps://cmake.org/download/からダウンロードできます。
現時点ではVisual Studio 2019のコミュニティ版のみがテストされていますが、他のバージョンも機能する可能性があります。
代わりに、DoxygenをUNIX方式で、CygwinまたはMinGWを使用してコンパイルすることもできます。
次のステップは、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を特定の機能を有効にして実行するためにインストールする必要がある追加ツールについては、次のセクションも参照してください。
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出力を生成したり、科学的な数式を使用したりするには、LaTeXとGhostscriptもインストールする必要があります。
にはいくつかのディストリビューションがあります。Doxygenで動作する一般的なものとしては、MikTexとproTeXtがあります。
GhostscriptはSourceforgeからダウンロードできます。
とGhostscriptをインストールした後、latex.exe、pdflatex.exe、およびgswin32c.exe(またはgswin64c.exe)のツールがコマンドボックスの検索パスに存在することを確認する必要があります。不明な場合はこれらの手順に従い、コマンドボックスからコマンドを実行して動作することを確認してください。