Doxygenの操作

ドキュメント作成までの過程は次のようになる。
  1. ソースファイル(プログラムファイル)にドキュメントを書き入れる
  2. Doxygen設定ファイル Doxyfile を生成し、 オプションの変更を行う
  3. ドキュメントを生成する
  4. 生成されたドキュメントを確認する(HTMLファイル)
ソースファイルを書き換えた場合は，c, dの操作で ドキュメントを変更する． (bの操作は不要)

以下は、b〜cの操作

  1. 設定ファイルの生成
    1. プログラムを作成したディレクトリに移動する
    2. 設定ファイル Doxyfile を生成する 
                  $ doxygen -g
    3. 上のコマンドを入力すると，設定ファイル Doxyfile ができている 
                  $ ls -l
      で表示されるファイル一覧で確認することができる．
  2. オプション指定(設定ファイル Doxygen の編集)
    1. エディタを使用してファイル Doxyfile を編集する． 
        OUTPUT_LANGUAGE        = English  →  Japanese
EXTRACT_ALL            = NO       →  YES
SOURCE_BROWSER         = NO       →  YES
STRIP_CODE_COMMENTS    = YES      →  NO
ALPHABETICAL_INDEX     = NO       →  YES
LATEX_CMD_NAME         = latex    →  platex
      ファイル中の上記の行について， 緑色の箇所を 赤色の字句に変更し， 保存する．

  3. ドキュメント生成
    1. 引数無しで doxygen を実行する 
                  $ doxygen
    ソースファイル(プログラムファイル)を修正、変更した場合， 1,2の操作は不要，3の操作をもう1度繰り返す．

Doxygen により，HTMLファイルがディレクトリ html 内に生成される．

html 内の index.html ファイルを webブラウザで開き，内容を確認する．