doxygenでドキュメントを生成する

参考

http://www.doxygen.jp/
http://www.fides.dti.ne.jp/~oka-t/doxygen.html

概要

Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風) 向けのドキュメンテーション・システムです。 PHP、C#、D にもある程度対応しています。
graphvis というツールを併用すると、クラスの派生関係やファイルの依存関係などをグラフ化してくれる。

使い方

 設定ファイルの作成

doxygen -g [<設定ファイル名>]

 設定ファイル編集(クラス図を出力する場合)

HAVE_DOT = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES

 設定ファイルの編集(クラス図を出力しない場合)

上記で作成したファイルを編集する
出力する言語

OUTPUT_LANGUAGE        = Japanese

出力先ディレクトリ

OUTPUT_DIRECTORY       = doc

ソースファイルの文字コード（UTF-8 とか CP932とか）

INPUT_ENCODING         = CP932

左側にツリーを表示

GENERATE_TREEVIEW      = YES

コメントの１行目を概要として表示

JAVADOC_AUTOBRIEF = YES

外部ツール（Graphviz ）を使ってクラス図を生成するか

HAVE_DOT               = NO

出力対象とするスコープやクラスを指定

EXTRACT_ALL = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES