ぼく用あれこれまとめ

Doxygen 導入メモ

最終更新:

bokuyo

- view
管理者のみ編集可

Doxygen を導入する

  • 早めにDoxygen を導入することでコメントアウトがどういうときに必要なのかを見定める

先にGraphViz を導入しておくといいかも.



ダウンロード

  • http://www.stack.nl/~dimitri/doxygen/download.html - Doxygen Download Page(Doxygen 公式, ダウンロードページ)
    • 「doxygen-1.7.6.1-setup.exe (9.6MB)」 をダウンロードします。
    • 今回は実行ファイル形式のインストーラを使ってスムーズに導入します。ちなみにWindows (32bit)です。
  • ダウンロードが終わったら実行してください。そのままインストーラが起動します。

インストール

  1. "Welcome to the doxygen Setup Wizard"
    • 何も考えず [ Next > ] で
  2. "License Agreement"
    • ちいさい おともだち の みんな は おうちのかた と いっしょ に よんで "I accept the agreement" で[ Next > ]
  3. "Select Destination Location"
    • インストール先を選んで [ Next > ]
  4. "Select Components"
    • "Full Installation" で全部導入しちゃえ![ Next > ]
  5. "Select Start Menu Folder"
    • スタートメニューに追加しちゃえ [ Next > ]
  6. "Ready to Install"
    • インストール開始しちゃえ! [ Install ]
  7. "Installing"
    • (インストール中)
  8. "Information"
    • インストールが完了するとDoxygen のバージョン情報が表示される
  9. "Completing the doxygen Setup Wizard"
    • インストールお疲れ様でした!

Doxywizard を起動してみよう

  • Doxywizard を起動してみよう
    • インストール後、スタートメニューにDoxywizard が追加されているのでそれをクリック。

Doxygen を使ってドキュメントを生成するおおまかな流れ

  • まず、Doxywizard を起動します

Wizard

  • 4つのTopic ごとに必要項目を入力してください
  1. Project Topic
    • Step 1, Step 2 の必要項目を入力
    • 入力し終えたら、Next で次の項目へ
  2. Mode Topic
  3. Doxygen の動きを最適化するためにいろいろ選択しちゃってください
  4. Output
    • ドキュメントの出力形式(HTML, LaTeX etc.)を選択します
  5. Diagrams
    • ドキュメントにクラス図は必要かどうか。

Expert

  • エキスパートじゃないので設定しなくていいです。

Run

  • "Run doxygen" でドキュメントを生成します
  • "*** Doxygen has finished" でドキュメント生成完了です。


Doxywizard - Project (Step 1)

  • Doxygen の作業ディレクトリを選択します
    • プロジェクト毎にDoxygen の作業ディレクトリを設定する必要があります

Doxywizard - Project (Step 2)

  • Project name
    • プロジェクト名
  • Project synopsis
    • プロジェクトの概要
  • Project version or id
    • プロジェクトのバージョン
  • Project logo
    • プロジェクトのロゴ画像(ほとんどの画像形式には対応しているみたい)
  • Source code directory
    • ソースコードが置いてあるディレクトリ
  • Scan recursively
    • チェックを入れると指定したディレクトリ内のディレクトリまでスキャンしてくれる
  • Destination directory
    • Doxygen の出力ディレクトリです。ここに生成されたドキュメントファイルが出力されます。

Doxywizard - Mode

Select the desired extraction mode

  • Documented entities only
    • Doxygen 用に書かれたソースコードのみをドキュメント化します
  • All Entities
    • Doxygen 用のソースコードだけでなく指定したディレクトリ内のソースコード全てをドキュメント化します
  • Include cross-referenced source code in the output
    • 相互参照しているソースコードも出力に含みます
    • ちょっとここの説明、うまくできてないかも

Select programming language to optimize the results for

  • プログラミング言語を選択することでDoxygen を最適化します
    • C++ で書いてるので "Optimize for C++ output" を今回は選択

Doxywizard - Output

HTML

  • plain HTML
    • シンプルなHTML
  • with navigation panel
    • フレーム分割されたHTML
  • prepare for compressed HTML
    • Windows でよく見かけるヘルプ。あのヘルプのページで使われるファイル形式がコレ。

LaTeX

  • カッコイイプログラマは LaTeX が好きです。Next
    • HTML 形式のドキュメントだけでいいのであれば、LaTeX にチェックしなくてもかまいません。


Doxywizard - Diagrams

Diagrams to generate

  • No diagrams
    • クラス図が不要な場合はこれを選択
  • Use built-in class diagram generator
    • クラス図が必要な場合はこちら。
  • Use dot tool from the GraphViz package
    • GraphViz というソフトを用いてクラス図を書きたい場合。
    • 次の "Dot graphs to generate" で細かい設定ができます。

Dot graphs to generate

  • Class diagrams
    • クラス図
  • Collaboration diagrams
  • Overall Class hierarchy
  • Include dependency graphs
  • Included by dependency graphs
  • Call graphs
  • Called by graphs


関連リンク

記事メニュー
目安箱バナー