インストール
Doxygen の ホームページからインストーラーをダウンロードしてインストールする。
使い方
スタートメニュー => すべてのプログラム => doxygen => Doxywizard
で起動。
設定方法
必要と思われる設定項目。File メニューから設定の保存ができる。
Working Directory
良く分かってない。おそらく設定ファイルの保存される場所。
とりあえずどこか適当な場所を設定
Wizard
Project
| 項目名 | 備考 |
|---|---|
| Project Name | プロジェクト名を設定する |
| Source code directory | ドキュメント化したいコードの有るフォルダ |
| Scan recursively | チェックを入れておく。チェックを入れないとサブディレクトリーのファイルが対象にならない。 |
| Destination directory | 出力先ディレクトリ。このディレクトリの中に html フォルダが生成される。 |
Mode
| 項目名 | 備考 |
|---|---|
| Select programming language... | プロジェクトで使用している言語のものを選択する。 |
Output
| 項目名 | 備考 |
|---|---|
| HTML | HTML での出力がほしいのでチェックを入れる。ラジオボタンは with navigation panel がオススメ |
| その他の出力は今回は不要 |
Diagrams
クラスの継承図や関数の呼び出しグラフをどう出力するか。Use built-in... でいいと思う。
Expert
Project
| 項目名 | 備考 |
|---|---|
| OUTPUT_LANGUAGE | Japanese も有るのでそれを選択 |
| STRIP_FROM_PATH | ここで、今回のプロジェクトの親フォルダのパスを追加する。（ここを設定しないと、ソースファイルのパス名がフルパスになる。） |
Input
| 項目名 | 備考 |
|---|---|
| INPUT_ENCODING | ソースファイルの文字コードを設定する。UTF-8 なら "UTF-8" 、Shift-JIS なら "CP932" |
Run
Run doxygen で HTML を生成する。Show HTML output でブラウザで確認。html フォルダ内の index.html
が目的のファイル。