doxygen & graphvizでソースドキュメ

暫く使ってないので復習。

• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • -

doxygen & graphvizによるソースコードのドキュメント化

• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • -

■目的
・コードのリファレンス
・ドキュメントの自動作成
・リーディングの補助

■doxygen
ソースコードからドキュメントを生成するツール。
1.要素(クラス、関数、変数、マクロetc)を参照化。
2.要素間の関係をgraphvizを用いて図示化。(クラス図、関数コール)
URL :www.doxygen.org
ライセンス:GPL
対応OS :Windows, MacOSX, Linux
対応言語 :C++, C, Java, Objective-C, Python, IDL,
Fortran, VHDL, PHP, C#, D
出力形式 :HTML, RTF, LateX, man など

■graphviz
「DOT言語(グラフ表示言語)」のスクリプトから各種グラフ画像を
生成するツール群。
URL :www.graphviz.org
ライセンス:CPL
対応OS :Windows, MacOSX, Linux

※doxygen側の設定・操作が必要。
コード → doxygen　→　ドキュメント
　　　　　　　↓↑
　　　　　　 自動
　　　　　　　↓↑
　　　　　　graphviz

■インストール方法
(1)graphvizをインストールする。
・Windows用インストーラをダウンロードしてクリック。

(2)doxygenをインストールする。
・Windows用インストーラをダウンロードしてクリック。

■使用方法
(1) doxygenの各種設定を行う。

・設定例(抜粋)
Specify the working 〜 :
ワークフォルダの設定。

Wizardタブの設定
Mode
Include cross-referenced source code in the output : チェック
⇒ソース間関連。
Diagrams
Use dot tool from the GraphViz package : 全部チェック
⇒コールグラフ図示化。
Expertタブの設定
Project
OUTPUT_LANGUAGE : Japanese
Input
INPUT_ENCODING : CP932
Source Browser
INLINE_SOURCES : チェック

(2)ドキュメント出力する。
Runタブの「Run doxygen」をクリック。