[Refactor] #37353 Doxygen用のコメントを追加 / Added comments for Doxygen

diff --git a/src/cmd/cmd-dump.c b/src/cmd/cmd-dump.c
index ef4065c..e4b0ce7 100644 (file)
--- a/src/cmd/cmd-dump.c
+++ b/src/cmd/cmd-dump.c
@@ -913,6 +913,7 @@ static void do_cmd_erase_nikki(void)
 
 /*!
  * @brief 日記コマンド
+ * @param crerature_ptr プレーヤーへの参照ポインタ
  * @return なし
  */
 void do_cmd_nikki(player_type *creature_ptr)
@@ -3135,11 +3136,17 @@ static concptr monster_group_char[] =
 
 
 /*
- * Build a list of monster indexes in the given group. Return the number
- * of monsters in the group.
+ * todo 引数と戻り値について追記求む
+ * Build a list of monster indexes in the given group.
  *
  * mode & 0x01 : check for non-empty group
  * mode & 0x02 : visual operation only
+
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @param grp_cur ？？？
+ * @param mon_idx[] ？？？
+ * @param mode ？？？
+ * @return The number of monsters in the group
  */
 static IDX collect_monsters(player_type *creature_ptr, IDX grp_cur, IDX mon_idx[], BIT_FLAGS8 mode)
 {
@@ -4004,7 +4011,9 @@ void (*screendump_aux)(void) = NULL;
 
 
 /*
- * Hack -- save a screen dump to a file
+ * Save a screen dump to a file
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 void do_cmd_save_screen(player_type *creature_ptr)
 {
@@ -4600,6 +4609,7 @@ static void do_cmd_knowledge_skill_exp(player_type *creature_ptr)
 /*!
  * @brief 現在のペットを表示するコマンドのメインルーチン /
  * Display current pets
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @return なし
  */
 static void do_cmd_knowledge_pets(player_type *creature_ptr)
@@ -5215,7 +5225,13 @@ static void display_monster_list(int col, int row, int per_page, s16b mon_idx[],
 
 
 /*
+ * todo 引数の詳細について加筆求む
  * Display known monsters.
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @param need_redraw 画面の再描画が必要な時TRUE
+ * @param visual_only ？？？
+ * @param direct_r_idx モンスターID
+ * @return なし
  */
 static void do_cmd_knowledge_monsters(player_type *creature_ptr, bool *need_redraw, bool visual_only, IDX direct_r_idx)
 {
@@ -6203,6 +6219,8 @@ static void do_cmd_knowledge_features(bool *need_redraw, bool visual_only, IDX d
 
 /*
  * List wanted monsters
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 static void do_cmd_knowledge_kubi(player_type *creature_ptr)
 {
@@ -6363,6 +6381,8 @@ static void do_cmd_knowledge_stat(player_type *creature_ptr)
 /*
  * todo player_typeではなくQUEST_IDXを引数にすべきかもしれない
  * Print all active quests
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 static void do_cmd_knowledge_quests_current(player_type *creature_ptr, FILE *fff)
 {
@@ -6596,6 +6616,10 @@ static bool do_cmd_knowledge_quests_aux(FILE *fff, floor_type *floor_ptr, IDX q_
 
 /*
  * Print all finished quests
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @param fff セーブファイル (展開済？)
+ * @param quest_num[] 受注したことのあるクエスト群
+ * @return なし
  */
 void do_cmd_knowledge_quests_completed(player_type *creature_ptr, FILE *fff, QUEST_IDX quest_num[])
 {
@@ -6618,7 +6642,11 @@ void do_cmd_knowledge_quests_completed(player_type *creature_ptr, FILE *fff, QUE
 
 /*
  * Print all failed quests
- */
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @param fff セーブファイル (展開済？)
+ * @param quest_num[] 受注したことのあるクエスト群
+ * @return なし
+*/
 void do_cmd_knowledge_quests_failed(player_type *creature_ptr, FILE *fff, QUEST_IDX quest_num[])
 {
        fprintf(fff, _("《失敗したクエスト》\n", "< Failed Quest >\n"));
@@ -6668,6 +6696,8 @@ static void do_cmd_knowledge_quests_wiz_random(FILE *fff)
 
 /*
  * Print quest status of all active quests
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 static void do_cmd_knowledge_quests(player_type *creature_ptr)
 {
@@ -7017,6 +7047,8 @@ void do_cmd_knowledge(player_type *creature_ptr)
 
 /*
  * Check on the status of an active quest
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 void do_cmd_checkquest(player_type *creature_ptr)
 {
@@ -7032,6 +7064,8 @@ void do_cmd_checkquest(player_type *creature_ptr)
 
 /*
  * Display the time and date
+ * @param creature_ptr プレーヤーへの参照ポインタ
+ * @return なし
  */
 void do_cmd_time(player_type *creature_ptr)
 {

diff --git a/src/core.c b/src/core.c
index 1786b2f..b851afa 100644 (file)
--- a/src/core.c
+++ b/src/core.c
@@ -5744,6 +5744,7 @@ void prevent_turn_overflow(void)
 /*!
  * @brief ゲーム終了処理 /
  * Close up the current game (player may or may not be dead)
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @return なし
  * @details
  * <pre>

diff --git a/src/files.c b/src/files.c
index 45f5773..edfb032 100644 (file)
--- a/src/files.c
+++ b/src/files.c
@@ -4466,6 +4466,7 @@ static void dump_aux_class_special(FILE *fff)
 
 /*!
  * @brief クエスト情報をファイルにダンプする
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @param fff ファイルポインタ
  * @return なし
  */
@@ -4976,6 +4977,7 @@ static void dump_aux_home_museum(FILE *fff)
 /*!
  * @brief ダンプ出力のメインルーチン
  * Output the character dump to a file
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @param fff ファイルポインタ
  * @return エラーコード
  */
@@ -5015,6 +5017,7 @@ errr make_character_dump(player_type *creature_ptr, FILE *fff)
 /*!
  * @brief プレイヤーステータスをファイルダンプ出力する
  * Hack -- Dump a character description file
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @param name 出力ファイル名
  * @return エラーコード
  * @details
@@ -6346,6 +6349,7 @@ void print_tomb(void)
 /*!
  * @brief 死亡、引退時の簡易ステータス表示 /
  * Display some character info
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @return なし
  */
 void show_info(player_type *creature_ptr)

diff --git a/src/report.c b/src/report.c
index 6e58fc5..78b228e 100644 (file)
--- a/src/report.c
+++ b/src/report.c
@@ -280,6 +280,7 @@ static bool http_post(int sd, concptr url, BUF *buf)
 
 /*!
  * @brief キャラクタダンプを作って BUFに保存
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @param dumpbuf 伝送内容バッファ
  * @return エラーコード
  */
@@ -447,6 +448,7 @@ concptr make_screen_dump(void)
 
 /*!
  * @brief スコア転送処理のメインルーチン
+ * @param creature_ptr プレーヤーへの参照ポインタ
  * @return エラーコード
  */
 errr report_score(player_type *creature_ptr)

diff --git a/src/scores.c b/src/scores.c
index 0c24dfb..980279d 100644 (file)
--- a/src/scores.c
+++ b/src/scores.c
@@ -432,6 +432,7 @@ void display_scores(int from, int to)
 
 /*!
  * @brief スコアサーバへの転送処理
+ * @param current_player_ptr プレーヤーへの参照ポインタ
  * @param do_send 実際に転送ア処置を行うか否か
  * @return 転送が成功したらTRUEを返す
  */