[Refactor] マップ表示系関数のDoxygenコメントを追記及び修正

diff --git a/src/view/display-map.cpp b/src/view/display-map.cpp
index f73a650..39ae981 100644 (file)
--- a/src/view/display-map.cpp
+++ b/src/view/display-map.cpp
@@ -80,7 +80,15 @@ static void image_random(TERM_COLOR *ap, SYMBOL_CODE *cp)
 }
 
 /*!
- * @brief Mコマンドによる縮小マップの表示を行う / Extract the attr/char to display at the given (legal) map location
+ * @brief 指定した座標の地形の表示属性を取得する / Extract the attr/char to display at the given (legal) map location
+ * @param player_ptr プレイヤー情報への参照ポインタ
+ * @param y 階の中のy座標
+ * @param x 階の中のy座標
+ * @param ap 文字色属性
+ * @param cp 文字種属性
+ * @param tap 文字色属性(タイル)
+ * @param tcp 文字種属性(タイル)
+ * @return なし
  */
 void map_info(player_type *player_ptr, POSITION y, POSITION x, TERM_COLOR *ap, SYMBOL_CODE *cp, TERM_COLOR *tap, SYMBOL_CODE *tcp)
 {

diff --git a/src/window/display-sub-windows.cpp b/src/window/display-sub-windows.cpp
index 2cfcb41..7b9e959 100644 (file)
--- a/src/window/display-sub-windows.cpp
+++ b/src/window/display-sub-windows.cpp
@@ -368,6 +368,11 @@ void fix_overhead(player_type *player_ptr)
     }
 }
 
+/*!
+ * @brief 自分の周辺の地形をTermに表示する
+ * @param プレイヤー情報への参照ポインタ
+ * @return なし
+ */
 static void display_dungeon(player_type *player_ptr)
 {
     TERM_COLOR ta = 0;
@@ -402,8 +407,7 @@ static void display_dungeon(player_type *player_ptr)
 }
 
 /*!
- * @brief ダンジョンの地形をサブウィンドウに表示する /
- * Hack -- display dungeon view in sub-windows
+ * @brief 自分の周辺のダンジョンの地形をサブウィンドウに表示する / display dungeon view around player in a sub window
  * @param player_ptr プレーヤーへの参照ポインタ
  * @return なし
  */

diff --git a/src/window/main-window-util.cpp b/src/window/main-window-util.cpp
index afd2d46..0e317b2 100644 (file)
--- a/src/window/main-window-util.cpp
+++ b/src/window/main-window-util.cpp
@@ -173,8 +173,14 @@ static void display_shortened_item_name(player_type *player_ptr, object_type *o_
     term_putstr(0, y, 12, attr, buf);
 }
 
-/*
- * Display a "small-scale" map of the dungeon in the active Term
+/*!
+ * @brief 縮小マップ表示 / Display a "small-scale" map of the dungeon in the active Term
+ * @param player_ptr プレイヤー情報への参照ポインタ
+ * @param cy 縮小マップ上のプレイヤーのy座標
+ * @param cx 縮小マップ上のプレイヤーのx座標
+ * @return なし
+ * @details
+ * メインウィンドウ('M'コマンド)、サブウィンドウ兼(縮小図)用。
  */
 void display_map(player_type *player_ptr, int *cy, int *cx)
 {