Doxygen - bambooflow Note

Doxygen

はじめに

Doxygenはドキュメントシステムである。 C++、C、Java、Objective-C、Python、IDL、と若干の範囲でPHP、C#、D に対応している。

1. これはソースファイルの文書の設定から(HTMLでの)オンラインドキュメントやオフラインのリファレンスマニュアルを生成できる。これらはまたRTF(MS-Word)、PostScript、hyperlinked PDF, 圧縮HTML、Uix manページ出力もサポートしている。ドキュメントはソースから直接吐き出される。そして、ドキュメントとソースコードを一致していておくことが非常に簡単になる。
2. あなたはドキュメントがないソースファイルからコード構造を抜き出すようにdoxygenを構成できる。これは大きなソースディストリビューション上で状態を素早く把握するのにとても役立つ。また、依存関係を示すグラフ、継承ダイアグラム、コラボレーションダイアグラムによって様々な要素との関係を目に見えるようにできる。そして、それらは自動的に生成される。
3. あなたは、通常のドキュメントを作成するために、doxygenを悪用することさえできる。

DoxygenはLinuxとMac OS Xで開発されるが、高い移植性をもつ。そのため、同様な他のUnix風の上において大部分で動作する。さらにまた、Windows版実行可能形式も利用できる。

ダウンロードとインストール

わたしはVine3.2を使用しているのでapt-getで可能だった。

# apt-get install doxygen

また、公式サイトであるここから落とせる。

試し

試しに、SystemCのinlcudeディレクトリにDoxygenを使ってみた。
ぜひとも参考にどうぞ。
http://bambooflow.ashigaru.jp/systemc/documentation/index.html