How to install free softwares in Linux

last update: 29 Sep 2004

home |index |previous |next |contents

kdoc-1.14



kdocはC++のクラス定義ファイル、すなわちヘッダファイルから クラスの依存関係などを解析してHTMLファイル群を生成する、C++用開発ツールのひとつです。

判りにくいソースコードの解析や、開発中にクラスの依存関係などを見直すなど、 操作も簡単で便利なツールです。
2.1 ソフトの入手
以下のサイトから"kdoc"の最新版を入手できます:

ftp://ftp.ph.unimelb.edu.au/pub/users/taj/kde

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

次にディレクトリ./kdoc-1.14に移動します。

    % cd /usr/local/
    % gzip -cd kdoc-1.14.tar.gz | tar xvf -
    % cd kdoc-1.14

以下、"configure"、"make"と"make install"を行ないます。フリーソフトウエアの定型的なインストール手順です。

    % ./configure
    % make
    % make install

2.3 使い方
kdocの基本的な使い方は以下の通りです。

kdoc [-d<outdir>] <library> <headers>
     

ここで:
注: さらに詳しい使い方は、例えば"-h"オプションで見る事が出来ます。
    % kdoc -h


ここで具体的なプログラムを使ってkdocの使い方と結果を見てみましょう。

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


さて、ここでkdocの生成するHTMLファイルを書き込むディレクトリを作ります。 ここでは"kdoc-log"というディレクトリにしますが、適当な名前を使う事が出来ます。
そして、kdocを起動します。library名は"test"としました。これも特に意味はありません。

    % mkdir kdoc-log
    % ls
    kdoc-log src
    % kdoc -d./kdoc-log test ./src/* ./src/person/*

これでディレクトリ"kdoc-log"以下にいくつかのHTMLファイルが生成されます。
インデックスファイルはこちらです。 kdocがどのような出力をするか見る事が出来ます。
2.4 参考サイト
kdocのホームページは次の通りです。
http://www.ph.unimelb.edu.au/~ssk/kde/kdoc


home |index |previous |next |contents


since 04/Oct/2004