doxygen

Doxygen memo †

doxygenとは、ソースからドキュメントを作成するツールです。

→公式ページ : http://www.doxygen.jp/

1.ファイルをDoxygenで解析する対象にする †

→以下をソースに貼り付け

/**
* @file
* @brief
* 【このファイルの説明】
* @author
* @date
* @version 1.0
* @note
* @attention
*/

2.関数説明を行う †

→以下を関数直上に配置

/**
*
*
* @param
*
* @return
*
*/

3.グローバル変数・#define文の説明を行う †

→以下を説明したいグローバル変数またはdefineの直上に配置

/**
*  説明
*/

4.プロジェクトの説明 †

/**
* @mainpage
* 【このプロジェクトの説明】
*/

5.参照 †

- 参照先
   @ref test_txt

- 参照元
   @page test_txt

6.コード表記 †

@code
@endcode

Appendix.インストール †

doxygenをインストールする前に、Graphvizをインストールする必要があります。

Graphvizのインストール http://www.graphviz.org/ より、ダウンロードしインストール。

ダウンロードページ http://www.stack.nl/~dimitri/doxygen/download.html の、「Doxygen source and binary releases」項目よりダウンロード

doxygen-1.5.1-p1-setup.exe (5.3M)

あとはウィザードでインストールできる

doxygenでGraphvizを使用した絵を描くには、Graphvizのbinディレクトリへパスが通っている必要あり。

2007-07-01 (日) 00:15:55