doxygen

doxygenはkdocよりもさらに強力なC++のためのドキュメント生成ツールです。HTML、LaTeX、およびman形式のドキュメントを生成します。

以下のサイトから"doxygen"の最新版を入手できます：

http://www.stack.nl/~dimitri/doxygen/download.html

なお、gdoxygenはg++コンパイラなどとともに、Qtを必要とします。

3.2 インストール
ファイル"doxygen-0.49-991003.src.tar.gz"を展開するディレクトリ$Workに移動して、バイナリパッケージを展開します。
作業ディレクトリ$Workは任意のディレクトリです。今回は$Work=/usr/localに展開することにします。

次にディレクトリ./doxygen-0.49-991003に移動します。

% cd /usr/local/
% gzip -cd doxygen-0.49-991003.src.tar.gz | tar xvf -
% cd doxygen-0.49-991003

以下、"configure"、"make"と"make install"を行ないます。

% sh ./configure
% make
% make doc
% make install

3.3 使い方

doxygenのマニュアルはdoxygenをインストールしたディレクトリのサブディレクトリ./htmlなどにあります。
ここでは具体例を用いて簡単に使い方を説明します。

注意: doxygenはHTMLだけでなくLaTeX形式でも結果を出力できますが、今回はHTML形式のみとします。

3.3.1 前準備

3.3.1.1 C++ソースの準備

今ホームディレクトリ~以下にC++のソースプログラムのおいてあるサブディレクトリsrcがあるとします。
サブディレクトリsrcには"student.h", "student.cpp"というソースファイルとサブディレクトリ"./person"があります。サブディレクトリ"./person"には"person.h", "person.cpp"というソースファイルがあります。

student.h

student.cpp

person
1. person.cpp

これらのファイルを御覧いただければ判るように、コメント中にいろいろなタグ("\fn", "\clas"など)が書き加えられています。基本的にはC++のコメント文中にdoxygenのタグを書き加えていく方式なので難しくはないのですが、なにしろタグの数が69もあり、ここで説明する事はできません。
こちらにdoxygenのマニュアルが、PS形式(doxygen_manual.ps.zip)と PDF形式(doxygen_manual.pdf.zip)で準備されていますので、詳しくはマニュアルを参照して下さい:

http://www.stack.nl/~dimitri/doxygen/download.html

マニュアルは英語ですが、読む必要はありません。眺めれば使い方はすぐに理解できます。

3.3.1.2 doxygen出力用ディレクトリの作成

doxygenの生成するHTMLファイルを書き込むディレクトリを作ります。ここでは"doxygen-log"というディレクトリにしますが、適当な名前を使う事が出来ます。

% mkdir doxygen-log
% ls
doxygen-log src

3.3.2 configファイルの生成と編集

% ls
doxygen-log src
% doxygen -g test.conf
% ls
doxygen-log src test.conf

17行目： PROJECT_NAME         = TEST
23行目： PROJECT_NUMBER       = 1.0
30行目： OUTPUT_DIRECTORY     = ./doxygen-log
38行目： OUTPUT_LANGUAGE      = Japanese

164行目：INPUT                = ./src ./src/person
171行目：FILE_PATTERNS        = *h *cpp

259行目：GENERATE_LATEX       = NO

305行目：GENERATE_MAN         = NO

configファイル(test.conf)の編集例

3.3.3 doxygenの実行

% doxygen test.conf

こちら

3.4 参考サイト

doxygenのホームページは次の通りです。

http://www.stack.nl/~dimitri/doxygen

home |index |previous |next |contents

since 04/Oct/2004