Doxygenを使ったドキュメント生成ではじめにやること。
はじめに
Doxygenを使って、ドキュメントを生成するときに、はじめにやることを記載しておく。
概要
- 設定ファイルを生成する。
- 設定ファイルを編集する。
- ソースファイルにドキュメント付けをする。
- doxygenを実行する。
- 生成されたドキュメントを確認する。
設定ファイルを編集する
「EXTRACT_ALL」をYESにする。
EXTRACT_ALL = YES
ソースファイルにドキュメント付けをする
簡単に、ドキュメント付けしたものを以下に示す。
/*! @brief main本体.
* @param [in] argc
* @param [in] *argv
* @return 成否を返す.
* @retval 0 正常終了.
* @retval 1 異常終了.
*/
int
main( int argc,
char *argv )
{
usage( argc, argv );
// cat 本体
_cat( argc, argv );
return 0;
}
