Doxygen 書き方メモ

主に c/c++ で使われるドキュメンテーションシステム コメント記法をメモ的に掲載する 随時更新予定

ファイルトップ

/**
 * @file [filename]
 * @brief [File description]
 * @author [your name]
 */

関数

/**
 * @fn [function name]
 * @brief [function description]
 * @param [paramator description]
 * @return [return value description]
 * @sa [link to relative function]
 */

変数

//! [description of a]
int a;