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

Add Doxygen comment to cmd1.c.
---

diff --git a/src/cmd1.c b/src/cmd1.c
index 274b4c723..32c92bdb4 100644
--- a/src/cmd1.c
+++ b/src/cmd1.c
@@ -12,12 +12,18 @@
 
 
 #include "angband.h"
-#define MAX_VAMPIRIC_DRAIN 50
+#define MAX_VAMPIRIC_DRAIN 50 /*!< µÛ·ì½èÍý¤ÎºÇÂç²óÉüHP */
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤«¤é¥â¥ó¥¹¥¿¡¼¤Ø¤Î¼Í·âÌ¿ÃæȽÄê /
  * Determine if the player "hits" a monster (normal combat).
- * Note -- Always miss 5%, always hit 5%, otherwise random.
+ * @param chance ´ðËÜÌ¿ÃæÃÍ
+ * @param m_ptr ¥â¥ó¥¹¥¿¡¼¤Î»²¾ÈID
+ * @param vis ÌÜɸ¤ò»ë³¦¤ËÊá¤é¤¨¤Æ¤¤¤ë¤Ê¤é¤ÐTRUE¤ò»ØÄê
+ * @param o_name ¥á¥Ã¥»¡¼¥¸É½¼¨»þ¤Î¥â¥ó¥¹¥¿¡¼Ì¾
+ * @return Ì¿Ãæ¤ÈȽÄꤵ¤ì¤¿¾ì¹çTRUE¤òÊÖ¤¹
+ * @note Always miss 5%, always hit 5%, otherwise random.
  */
 bool test_hit_fire(int chance, monster_type *m_ptr, int vis, char* o_name)
 {
@@ -65,10 +71,14 @@ bool test_hit_fire(int chance, monster_type *m_ptr, int vis, char* o_name)
 
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤«¤é¥â¥ó¥¹¥¿¡¼¤Ø¤ÎÂÇ·âÌ¿ÃæȽÄê /
  * Determine if the player "hits" a monster (normal combat).
- *
- * Note -- Always miss 5%, always hit 5%, otherwise random.
+ * @param chance ´ðËÜÌ¿ÃæÃÍ
+ * @param m_ptr ¥â¥ó¥¹¥¿¡¼¤Î»²¾ÈID
+ * @param vis ÌÜɸ¤ò»ë³¦¤ËÊá¤é¤¨¤Æ¤¤¤ë¤Ê¤é¤ÐTRUE¤ò»ØÄê
+ * @return Ì¿Ãæ¤ÈȽÄꤵ¤ì¤¿¾ì¹çTRUE¤òÊÖ¤¹
+ * @note Always miss 5%, always hit 5%, otherwise random.
  */
 bool test_hit_norm(int chance, int ac, int vis)
 {
@@ -98,9 +108,14 @@ bool test_hit_norm(int chance, int ac, int vis)
 
 
 
-/*
- * Critical hits (from objects thrown by player)
- * Factor in item weight, total plusses, and player level.
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤«¤é¥â¥ó¥¹¥¿¡¼¤Ø¤Î¼Í·â¥¯¥ê¥Æ¥£¥«¥ëȽÄê /
+ * Critical hits (from objects thrown by player) Factor in item weight, total plusses, and player level.
+ * @param weight ÌðÃƤνÅÎÌ
+ * @param plus_ammo ÌðÃƤÎÌ¿Ã潤Àµ
+ * @param plus_bow µÝ¤ÎÌ¿Ã潤Àµ
+ * @param dam ¸½ºß»»½ÐÃæ¤Î¥À¥á¡¼¥¸ÃÍ
+ * @return ¥¯¥ê¥Æ¥£¥«¥ë½¤Àµ¤¬Æþ¤Ã¤¿¥À¥á¡¼¥¸ÃÍ
  */
 s16b critical_shot(int weight, int plus_ammo, int plus_bow, int dam)
 {
@@ -165,10 +180,15 @@ s16b critical_shot(int weight, int plus_ammo, int plus_bow, int dam)
 
 
 
-/*
- * Critical hits (by player)
- *
- * Factor in weapon weight, total plusses, player melee bonus
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤«¤é¥â¥ó¥¹¥¿¡¼¤Ø¤ÎÂǷ⥯¥ê¥Æ¥£¥«¥ëȽÄê /
+ * Critical hits (by player) Factor in weapon weight, total plusses, player melee bonus
+ * @param weight ÌðÃƤνÅÎÌ
+ * @param plus Éð´ï¤ÎÌ¿Ã潤Àµ
+ * @param dam ¸½ºß»»½ÐÃæ¤Î¥À¥á¡¼¥¸ÃÍ
+ * @param meichuu ÂÇ·â¤Î´ðËÜÌ¿ÃæÎÏ
+ * @param mode ¥ª¥×¥·¥ç¥ó¥Õ¥é¥°
+ * @return ¥¯¥ê¥Æ¥£¥«¥ë½¤Àµ¤¬Æþ¤Ã¤¿¥À¥á¡¼¥¸ÃÍ
  */
 s16b critical_norm(int weight, int plus, int dam, s16b meichuu, int mode)
 {