つくばチャレンジ2010: ドキュメント自動生成ツールDoxygenの設定

ソースコードからドキュメントやクラスの関係図も自動で生成してくれる優れもの。Ubuntuの場合はインストールはとても簡単で、設定もGUIツールを使えば簡単。以下はUbuntu10.4でDoxygenを設定したときのメモ。図はクリックすると拡大する。

Doxygenで生成したUML図

インストール

  • sudo apt-get install doxygen
  • sudo apt-get install doxygen-gui
  • sudo apt-get install graphviz

設定:GUI設定ツールdoxywizardを利用 (図はクリックすると拡大)

  • 前 提
    • 開発言語C++
    • ここでは、/home/ユーザ名/src/SItiK_2010の下に全ソースファイルが置いてあり、SItiK_2010のディレクトリには複数のサブディレクトがあるとする。ユーザ名以下のディレクトリは自分の環境に合わせる。
    • ドキュメントはSItiK_2010ディレクトリの中にdocディレクトリを作りそこに格納する。
  • Wizard->Topics->Projectを選択
    • プロジェクトの名前とバージョンを記入。Scan recursivelyにチェックを入れ、Destination Directoryを./docとする。Scan recursibelyにチェックを入れないと、サブディレクトリ以下をスキャンしない。
  • Wizard->Topics->Modeを選択
    • All Entities,  Include cross-referenced source code in the output, Optimize for C++ outputにチェック
  • Wizard->Topics->Outputを選択
    • 下図のようにチェックを入れる。
  • Wizard->Topics->Diagramsを選択
    • 下図のようにチェックを入れる。
  • Wizard->Expert->Projectを選択
    • 下図のようにチェックを入れる。
  • Wizard->Expert->Buildを選択
    • 下図のようにチェックを入れる。
  • Wizard->Expert->Dotを選択
    • ここでは色々な関係図を書いてもらいたいので、下図のようにできるだけ多くチェックを入れる。
  • Run->Run doxygenを選択
    • doxygenを実行する。
  • ドキュメントを読む
    • ./doc/html/index.htmlをブラウザで開けばドキュメントを読める。終わり。

でむ

コメントを残す

メールアドレスが公開されることはありません。