Doxygenを導入してみる
Doxygenはソースに埋め込んだコメントを元にドキュメントを作成するツール。
メモ程度に導入方法をまとめておく。
導入
sudo apt -y install doxygen doxygen-gui graphviz
あとは、
doxywizard
を実行すればGUIが出てくるので、ウィザード通りにすすめる。
スニペット
ファイル
/** * @file * @brief * @author * @date * @details */
@file ファイル名(必須) @brief 一行説明(必須) @author 作成者 @date 作成日 @details 詳細説明
関数
/** * @fn * @brief * @param * @retval * @details */
@fn プロトタイプ宣言(必須) @brief 一行説明(必須) @param 引数 構文:@param[in/out] <引数名> <説明> @retval 戻り値 構文:@retval <値> <説明> @details 詳細説明
変数
//! 説明
変数宣言行の上に書く。
クラスとかは上３つを組み合わせればいける。
