Apache2.0 APIドキュメントのつくりかた

ここ数日、このページへのアクセスが激増していしており「なんでかなぁ」と思っていたのですが、どうもオレンジニュースさんで取り上げられたのが原因のようです。

ところで、この文書ってApacheのソースがあれば簡単に作成できるものなのですが、そのことはあまり知られていないのでしょうか? 簡単な手順*1をまとめておきますので、ぜひおためしください。

用意するもの

1. Apache2.0.x
2. ScanDoc

手順

$ ls
httpd-2.0.55.tar.gz  scandoc-0.14.tar.gz

$ tar zxvf httpd-2.0.55.tar.gz
$ tar zxvf scandoc-0.14.tar.gz

$ cp -pi scandoc-0.14/scandoc httpd-2.0.55/srclib/apr/build/scandoc.pl

$ cd httpd-2.0.55
$ ./configure
$ make docs

で、docs/api ディレクトリ以下にAPIドキュメントができ上がります。もしお使いのシステム上にDoxygenがインストールされているのなら、

$ make docs

の代わりに

$ make dox

とすればDoxygenを使用したドキュメントが作成されます。

ちなみに……

Apache2.2系では、ドキュメントの作成方法が少しかわっているようです。上と同じ手順で

$ make docs

を行うと、新しい方式について説明したページのURLが表示されます。

*1:っていうほどのものでもないですが :-)