はじめに
MayaとかでよくつかわれるPythonをDoxygen使ってドキュメント化する話です。
PythonにはPydocというドキュメント化機能があるようなのですが、他の言語との互換性のあるDoxygenを使いたく、やってみました。
環境は64bit Windows7です。
なぜか資料も少ないので、備忘録がてら書いてみます。
ひょっとしてPythonでは一般的ではないんでしょうか？
インストール
まず、Doxygenのインストールです。
Doxygen公式のダウンロードから
A binary distribution for Windows.
というのがあるのでそこの64bitを選択、ダウンロードします。
インストーラもきちっと整備されているのでぽちぽち次に進んでいけば、インストール自体は問題にならないかと思います。
Doxywizardの起動
Doxygenのインストールが完了したらDoxywizard.exeを立ち上げます。
画面左下、Windowsマーク（昔で言うスタートボタン）から検索すると出てくると思います。
DoxygenはDoxywizardを使ったGUIとコマンドプロンプトを使ったCUIがありますが、今回はGUIでやります。
DoxywizardのWizard設定
1.ワーキングディレクトリへのパス。
つまりこのDoxygenプロジェクトの動作する先を設定します。
2.Wizard（基本設定）まず基本設定から行います。
3.Project name : プロジェクト名を入力します。
Project synopsis : プロジェクトの概要（なくても大丈夫です）
Project Version or ID : プロジェクトのバージョンまたはID（なくても大丈夫です）
logo : 任意のロゴをいれられます（なくても大丈夫です）
4.Sorce code directory ソースコードのあるフォルダパス
まとめたいソースコードがあるフォルダを指定します。デフォルトでは１階層目しか走査しません。"Scan recursively"にチェックをいれることでサブフォルダまで全部チェックするはずです。
5.Destination directory 出力ディレクトリ
できあがったドキュメントをどこに保存するかを指定します。
1.TopicをModeに切り替えます
2.Pythonがないので、Optimize for Java or C# output （Java C#に最適化）に設定します。不思議。
1.Outputへ
2.書き出す形式を選びます。
今回はplain HTML(ピュアなHTMLファイル）にしました。
場合によってはchmファイル（Windowsのヘルプファイルとかに良くつかわれる形式）などを選ぶといいと思います。
1.Diagrams 図
2.今回は図、なしを選びました。
1.Run doxygen
doxygenを実行。これにより設定内容をもとにドキュメントが生成されます。
2.Show HTML output
出力したHTMLをブラウザで開きます。
次は、PythonでのDoxygen向けコメントの書き方を。
参考：
日本語のDoxygenマニュアルページ
参考にしたブログ
おもな設定
