Software / Doxygen

ドキュメント生成の流れ †

設定ファイルの生成、編集 †

• ドキュメント生成のため、設定ファイルを作成します。

  $ doxygen -g doxygen.conf

  • 上の例ではdoxygen.confという設定ファイルが作られますが、設定ファイル名は自由に名前を付けることができます。
• 作成された設定ファイルを編集し、生成を行います。

ドキュメントの生成 †

• 編集した設定ファイルを利用してドキュメントを作成します。

  $ doxygen doxygen.conf

  • 引数のdoxygen.confは設定ファイル

コメントの書き方 †

とりえあず編 †

• 基本的には公開クラス、関数の前にこんな感じでコメントを入れておけばよい。

  /**
   * これはわたしの作ったクラスです。
   */
  class MyClass
  {
    :
    :
  }

ちょっとだけまじめに編 †

 /**
  * \brief サービスエントリコレクション
  *
  * マシンに設定されているサービスの全エントリを取得し
  * サービスエントリのコレクションを作成する。<br>
  * std::vectorを継承しています。
  * \see ServiceEntry, getservent(3), setservent(3) 
  *
  * \attention 利用例
  * \code
  ServiceEntry e;
  ServiceEntrys* entrys = new ServiceEntrys();
  cout << "size = " << entrys->size() << endl;
  for(int i=0; i<entrys->size(); i++)
  {
  e = (ServiceEntry)entrys->at(i);
  cout << e.GetNames()[0] << endl;
  }
  delete entrys;
  \endcode
  \attention 利用例の出力
  * \code
  tcpmux
  tcpmux
  compressnet
    :  
  * \endcode
  *
  * \date 11/2006
  * \author nu
  *
  */
 class ServiceEntrys : public std::vector<ServiceEntry>
   : (略)

• 実際にやってる例。
  • \date, \author などの特殊コメントを使ったりして。\codeでコード例を示すとそれっぽく見えるような気がしなくもない。
  • こちらを参考に: 特殊コマンド編＠doxygenチュートリアル

詳細編 †

• まだないです。

設定ファイルのいじり方 †

• 環境によって違うとは思いますが設定ファイルをある程度いじらないと思い通りにならないことが多いと思います。

とりあえず編 †

プロジェクト名の設定 †

• MyProject?としてみました。
• スペースとか入れるなら""とかでくくるといいかも。(と思っただけで試してない)

出力言語を日本語に †

• デフォルトではドキュメントの基本的な見出しの言語が英語です。
• 見出しが英語でもコメントさえ日本語ならそれほど困りませんが一応。

ドキュメントの文字エンコードの設定 †

• nkf とかを使ってEUCで出るようにしないとファイルの日本語が文字化けしたりします。
• 環境、nkfのバージョンによって多少違うかもしれませんが
• なお、ちゃんと "" でくくるように。

Latexを出力しないように †

• デフォルトではHTML、Latexのドキュメントが生成されます。
• 上の例ではLatex出力をOFFにしてます。好みですが。

ソースファイルもドキュメントから参照できるようにする †

• ドキュメントからもソースを見れるようになります。
• 完璧好みですが。ちなみにヘッダファイルはデフォルトで閲覧可能な設定になっています。

詳細編 †

• まだないです。