From: deskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Date: Mon, 20 Jan 2014 13:42:59 +0000 (+0000)
Subject: Add Doxygen comment to cmd1.c.
X-Git-Tag: v2.2.0~422
X-Git-Url: http://git.osdn.net/view?p=hengband%2Fhengband.git;a=commitdiff_plain;h=cf0120ee05165fe24556d9a6cf42d410d666667f

Add Doxygen comment to cmd1.c.
---

diff --git a/src/cmd1.c b/src/cmd1.c
index 02b24070e..1a0efb2a9 100644
--- a/src/cmd1.c
+++ b/src/cmd1.c
@@ -563,25 +563,25 @@ void search(void)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬¥ª¥Ö¥¸¥§¥¯¥È¤ò½¦¤Ã¤¿ºÝ¤Î¥á¥Ã¥»¡¼¥¸É½¼¨½èÍý /
  * Helper routine for py_pickup() and py_pickup_floor().
- *
- * Add the given dungeon object to the character's inventory.
- *
- * Delete the object afterwards.
+ * @param o_idx ¼èÆÀ¤·¤¿¥ª¥Ö¥¸¥§¥¯¥È¤Î»²¾ÈID
+ * @return ¤Ê¤·
+ * @details
+ * ¥¢¥¤¥Æ¥à¤ò½¦¤Ã¤¿ºÝ¤Ë¡Ö£²¤Ä¤Î¥±¡¼¥­¤ò»ý¤Ã¤Æ¤¤¤ë¡×\n
+ * "You have two cakes." ¤È¥¢¥¤¥Æ¥à¤ò½¦¤Ã¤¿¸å¤Î¹ç·×¤Î¤ß¤Îɽ¼¨¤¬¥ª¥ê¥¸¥Ê¥ë\n
+ * ¤À¤¬¡¢°ãÏ´¶¤¬\n
+ * ¤¢¤ë¤È¤¤¤¦»ØŦ¤ò¤¦¤±¤¿¤Î¤Ç¡¢¡Ö¡Á¤ò½¦¤Ã¤¿¡¢¡Á¤ò»ý¤Ã¤Æ¤¤¤ë¡×¤È¤¤¤¦É½¼¨\n
+ * ¤Ë¤«¤¨¤Æ¤¢¤ë¡£¤½¤Î¤¿¤á¤ÎÇÛÎó¡£\n
+ * Add the given dungeon object to the character's inventory.\n
+ * Delete the object afterwards.\n
  */
 void py_pickup_aux(int o_idx)
 {
 	int slot;
 
 #ifdef JP
-/*
- * ¥¢¥¤¥Æ¥à¤ò½¦¤Ã¤¿ºÝ¤Ë¡Ö£²¤Ä¤Î¥±¡¼¥­¤ò»ý¤Ã¤Æ¤¤¤ë¡×
- * "You have two cakes." ¤È¥¢¥¤¥Æ¥à¤ò½¦¤Ã¤¿¸å¤Î¹ç·×¤Î¤ß¤Îɽ¼¨¤¬¥ª¥ê¥¸¥Ê¥ë
- * ¤À¤¬¡¢°ãÏ´¶¤¬
- * ¤¢¤ë¤È¤¤¤¦»ØŦ¤ò¤¦¤±¤¿¤Î¤Ç¡¢¡Ö¡Á¤ò½¦¤Ã¤¿¡¢¡Á¤ò»ý¤Ã¤Æ¤¤¤ë¡×¤È¤¤¤¦É½¼¨
- * ¤Ë¤«¤¨¤Æ¤¢¤ë¡£¤½¤Î¤¿¤á¤ÎÇÛÎó¡£
- */
 	char o_name[MAX_NLEN];
 	char old_name[MAX_NLEN];
 	char kazu_str[80];
@@ -659,7 +659,11 @@ void py_pickup_aux(int o_idx)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬¥ª¥Ö¥¸¥§¥¯¥È¾å¤Ë¾è¤Ã¤¿ºÝ¤Îɽ¼¨½èÍý
+ * @param pickup ¼«Æ°½¦¤¤½èÍý¤ò¹Ô¤¦¤Ê¤é¤ÐTRUE¤È¤¹¤ë
+ * @return ¤Ê¤·
+ * @details
  * Player "wants" to pick up an object or gold.
  * Note that we ONLY handle things that can be picked up.
  * See "move_player()" for handling of other things.
@@ -820,8 +824,12 @@ void carry(bool pickup)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Ø¤Î¥È¥é¥Ã¥×Ì¿ÃæȽÄê /
  * Determine if a trap affects the player.
+ * @param power ´ðËܲóÈòÆñÅÙ
+ * @return ¥È¥é¥Ã¥×¤¬Ì¿Ã椷¤¿¾ì¹çTRUE¤òÊÖ¤¹¡£
+ * @details
  * Always miss 5% of the time, Always hit 5% of the time.
  * Otherwise, match trap power against player armor.
  */
@@ -852,7 +860,11 @@ static int check_hit(int power)
 }
 
 
-
+/*!
+ * @brief Íî¤È¤··ê·Ï¥È¥é¥Ã¥×¤ÎȽÄê¤È¥×¥ì¥¤¥ä¡¼¤ÎÈï³²½èÍý
+ * @param trap_feat_type¥È¥é¥Ã¥×¤Î¼ïÊÌID
+ * @return ¤Ê¤·
+ */
 static void hit_trap_pit(int trap_feat_type)
 {
 	int dam;
@@ -913,6 +925,10 @@ static void hit_trap_pit(int trap_feat_type)
 	take_hit(DAMAGE_NOESCAPE, dam, trap_name, -1);
 }
 
+/*!
+ * @brief ¥À¡¼¥Ä·Ï¥È¥é¥Ã¥×¡ÊÄ̾ï¥À¥á¡¼¥¸¡Ë¤ÎȽÄê¤È¥×¥ì¥¤¥ä¡¼¤ÎÈï³²½èÍý
+ * @return ¥À¡¼¥Ä¤¬Ì¿Ã椷¤¿¾ì¹çTRUE¤òÊÖ¤¹
+ */
 static bool hit_trap_dart(void)
 {
 	bool hit = FALSE;
@@ -933,6 +949,11 @@ static bool hit_trap_dart(void)
 	return hit;
 }
 
+/*!
+ * @brief ¥À¡¼¥Ä·Ï¥È¥é¥Ã¥×¡ÊÄ̾ï¥À¥á¡¼¥¸¡ÜǽÎÏÃ͸º¾¯¡Ë¤ÎȽÄê¤È¥×¥ì¥¤¥ä¡¼¤ÎÈï³²½èÍý
+ * @param stat Äã²¼¤¹¤ëǽÎÏÃÍID
+ * @return ¤Ê¤·
+ */
 static void hit_trap_lose_stat(int stat)
 {
 	if (hit_trap_dart())
@@ -941,6 +962,10 @@ static void hit_trap_lose_stat(int stat)
 	}
 }
 
+/*!
+ * @brief ¥À¡¼¥Ä·Ï¥È¥é¥Ã¥×¡ÊÄ̾ï¥À¥á¡¼¥¸¡Ü¸ºÂ®¡Ë¤ÎȽÄê¤È¥×¥ì¥¤¥ä¡¼¤ÎÈï³²½èÍý
+ * @return ¤Ê¤·
+ */
 static void hit_trap_slow(void)
 {
 	if (hit_trap_dart())
@@ -949,6 +974,14 @@ static void hit_trap_slow(void)
 	}
 }
 
+/*!
+ * @brief ¥À¡¼¥Ä·Ï¥È¥é¥Ã¥×¡ÊÄ̾ï¥À¥á¡¼¥¸¡Ü¾õÂÖ°Û¾ï¡Ë¤ÎȽÄê¤È¥×¥ì¥¤¥ä¡¼¤ÎÈï³²½èÍý
+ * @param trap_messsage ¥á¥Ã¥»¡¼¥¸¤ÎÊ䴰ʸ»úÎó
+ * @param resist ¾õÂÖ°Û¾ï¤ËÄñ¹³¤¹¤ëȽÄ꤬½Ð¤¿¤Ê¤éTRUE
+ * @param set_status ¾õÂÖ°Û¾ï¤ò»ØÄꤹ¤ë´Ø¿ô¥Ý¥¤¥ó¥¿
+ * @param turn ¾õÂÖ°Û¾ï¤ÎÄɲå¿¡¼¥óÎÌ
+ * @return ¤Ê¤·
+ */
 static void hit_trap_set_abnormal_status(cptr trap_message, bool resist, bool (*set_status)(int turn), int turn)
 {
 	msg_print(trap_message);
@@ -959,8 +992,11 @@ static void hit_trap_set_abnormal_status(cptr trap_message, bool resist, bool (*
 	}
 }
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Ø¤Î¥È¥é¥Ã¥×ºîÆ°½èÍý¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Handle player hitting a real trap
+ * @param break_trap ºîÆ°¸å¤Î¥È¥é¥Ã¥×Ç˲õ¤¬³ÎÄꤷ¤Æ¤¤¤ë¤Ê¤é¤ÐTRUE
+ * @return ¤Ê¤·
  */
 static void hit_trap(bool break_trap)
 {
@@ -1334,6 +1370,17 @@ msg_print("
 }
 
 
+/*!
+ * @brief Ũ¥ª¡¼¥é¤Ë¤è¤ë¥×¥ì¥¤¥ä¡¼¤Î¥À¥á¡¼¥¸½èÍý¡ÊÊä½õ¡Ë
+ * @param m_ptr ¥ª¡¼¥é¤ò»ý¤Ä¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param immune ¥À¥á¡¼¥¸¤ò²óÈò¤Ç¤­¤ëÌȱ֥ե饰
+ * @param flags_offset ¥ª¡¼¥é¥Õ¥é¥°ÇÛÎó¤Î»²¾È¥ª¥Õ¥»¥Ã¥È
+ * @param r_flags_offset ¥â¥ó¥¹¥¿¡¼¤ÎÂÑÀ­ÇÛÎó¤Î»²¾È¥ª¥Õ¥»¥Ã¥È
+ * @param aura_flag ¥ª¡¼¥é¥Õ¥é¥°ÇÛÎó
+ * @param dam_func ¥À¥á¡¼¥¸½èÍý¤ò¹Ô¤¦´Ø¿ô¤Î»²¾È¥Ý¥¤¥ó¥¿
+ * @param message ¥ª¡¼¥é¥À¥á¡¼¥¸¤ò¼õ¤±¤¿ºÝ¤Î¥á¥Ã¥»¡¼¥¸
+ * @return ¤Ê¤·
+ */
 static void touch_zap_player_aux(monster_type *m_ptr, bool immune, int flags_offset, int r_flags_offset, u32b aura_flag,
 				 int (*dam_func)(int dam, cptr kb_str, int monspell, bool aura), cptr message)
 {