Doxygen - ドキュメントの自動生成

Page last updated 19 Aug 2011, by Suga koubou. 0 replies

Doxygen - ドキュメントの自動生成

mbed.orgのプログラム・ライブラリ公開機能には Doxygen によるドキュメント自動生成機能がある。

Doxygen は、プログラムソース中に一定の書式でドキュメントを埋め込んでおくと、関数・クラス・列挙型などの違いに応じて自動的に整形したドキュメントを生成してくれる。

ドキュメントは /** ～ */ （JavaDoc style）でくくられたコメントとして埋め込む。

関数・クラス・列挙型などの宣言部の直前に書くと、それについてのドキュメントとなる。
宣言部と分けて書く場合は、構造化コマンドで何についてのドキュメントか明示する。

/** A brief description of the function foo
 * 
 * More details about the function goes here
 * and here
 *
 * @param x a variable used by foo
 * @returns something magical done with x   
 */

要約

@bref 要約

  @bref This is the function.

引数

@param 引数名 説明

  @param name Pointer of result.

戻り値

@return 説明

  @return Pointer of result.

戻り値（値別）

@retval 値 説明

  @retval 0 Success.
  @retval -1 Failure.

注釈

@remarks 註釈

例

/** @file
 *
 * My program.
 */

/** hogehage class
 *
 * This is the class.
 */
class hogehage {
public:
	/** Initialize
	 *
	 * @retval 0 Success
	 * @retval -1 Failure
	 */
	int init ();

	/** Run
	 *
	 * @param val Number
	 */
	void run (int val);
}

/** hehehe function
 *
 * @param num Number
 * @param buf Pointer of buffer
 * @return Volume
 */
int hehehe (int num, char *buf) {
    :
}

構造化コマンド

ドキュメントを別の場所やファイルへ書くことができます。

@struct 宣言文構造体のドキュメントであることを表す
@union 宣言文共用体のドキュメントであることを表す
@enum 宣言文列挙型のドキュメントであることを表す
@def 宣言文#defineのドキュメントであることを表す
@file 宣言文ファイルのドキュメントであることを表す

参考

詳細 戻る

Please log in to post comments.