Doxygenでソースコードからプロジェクトのドキュメントを作成する
ソフトウェアを作る場合、個人だとドキュメントは後回しで実装中心となってしまうことや、あらかじめドキュメントを作成しながら作っていても開発中に変更等を行ってそれをドキュメントに反映しないということがあると思います。
そのときは、まぁ、開発が進んでからちまちま作成してもいいんですが、それだとなかなか辛いものがあります。
そんなときに http://www.stack.nl/~dimitri/doxygen/index.html を使うと、なんと！自動的にドキュメントを生成してくれます。
今回は「Doxygenについて」と「導入について」です。
次回、使い方を説明して行きたいと思います。
Doxygenについて
Doxygenは「ソースコードドキュメント生成ツール」で、C++, C, Java, Objective-C, Python, IDL (Corba と Microsoft flavors), Fortran, VHDL, PHP, C#, いくらかDをサポートしています。
出力形式として、HTML、LaTex、RTF、PS、リンク付きPDF、manなどをサポートしています。
また、LaTex生成時にはmakeファイルも作られるので、makeをするだけでPDFまで作成できます。
#僕の環境ではPDFの生成に関しては手動で行わないといけませんが。
他に便利な機能として、GUIフロントエンドや設定をファイルに保存するなどがあります。
導入
では、導入して行きたいと思います。
USEフラグ
まずは、USEフラグの設定です。
GUIフロントエンドを使う場合には、"qt3" を、
latexで "typesetting Ppackage" 使う場合には、"latex"を追加します。
とりあえず、両方追加します。
# echo "app-doc/doxygen qt3 latex" >> /etc/portage/package.use
試しに使ってみる
細かい機能については気にしないで、とりあえずドキュメントを生成してみたいと思います。
手っ取り早いので、GUIフロントエンドを使います。
$ doxywizard
で、GUIフロントエンドが起動するので、
- "Wizerd" から必要事項を設定
- 設定をファイルに保存する
- 一時ファイルの場所を指定
- Startにより生成が開始されるので終わるのをまつ
以上で完了です。
この時に注意として、マルチバイト文字(ワイド文字は不明)のファイル名には対応していません。ディレクトリもマルチバイト文字(同じく)が含まれると読み込んでくれないです。
かなり急ぎ足でしたが、導入まではこれで終わりです。
お疲れさまでした。
