OSDN Git Service

Add Doxygen comment to cmd1.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 20 Jan 2014 13:13:11 +0000 (13:13 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 20 Jan 2014 13:13:11 +0000 (13:13 +0000)
src/cmd1.c

index 32c92bd..02b2407 100644 (file)
@@ -19,7 +19,7 @@
  * @brief ¥×¥ì¥¤¥ä¡¼¤«¤é¥â¥ó¥¹¥¿¡¼¤Ø¤Î¼Í·âÌ¿ÃæȽÄê /
  * Determine if the player "hits" a monster (normal combat).
  * @param chance ´ðËÜÌ¿ÃæÃÍ
- * @param m_ptr ¥â¥ó¥¹¥¿¡¼¤Î»²¾ÈID
+ * @param m_ptr ¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
  * @param vis ÌÜɸ¤ò»ë³¦¤ËÊá¤é¤¨¤Æ¤¤¤ë¤Ê¤é¤ÐTRUE¤ò»ØÄê
  * @param o_name ¥á¥Ã¥»¡¼¥¸É½¼¨»þ¤Î¥â¥ó¥¹¥¿¡¼Ì¾
  * @return Ì¿Ãæ¤ÈȽÄꤵ¤ì¤¿¾ì¹çTRUE¤òÊÖ¤¹
@@ -75,7 +75,7 @@ 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).
  * @param chance ´ðËÜÌ¿ÃæÃÍ
- * @param m_ptr ¥â¥ó¥¹¥¿¡¼¤Î»²¾ÈID
+ * @param ac ¥â¥ó¥¹¥¿¡¼¤ÎAC
  * @param vis ÌÜɸ¤ò»ë³¦¤ËÊá¤é¤¨¤Æ¤¤¤ë¤Ê¤é¤ÐTRUE¤ò»ØÄê
  * @return Ì¿Ãæ¤ÈȽÄꤵ¤ì¤¿¾ì¹çTRUE¤òÊÖ¤¹
  * @note Always miss 5%, always hit 5%, otherwise random.
@@ -260,6 +260,13 @@ s16b critical_norm(int weight, int plus, int dam, s16b meichuu, int mode)
 
 
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¹¶·â¤Î¼ï²¥¹¥ì¥¤¥ó¥°ÇÜΨ·×»»
+ * @param mult »»½ÐÁ°¤Î´ðËÜÇÜΨ(/10ÇÜ)
+ * @param flgs ¥¹¥ì¥¤¥Õ¥é¥°ÇÛÎó
+ * @param m_ptr ÌÜɸ¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¥¹¥ì¥¤¥ó¥°²ÃÌ£¸å¤ÎÇÜΨ(/10ÇÜ)
+ */
 static int mult_slaying(int mult, const u32b* flgs, const monster_type* m_ptr)
 {
        static const struct slay_table_t {
@@ -314,6 +321,13 @@ static int mult_slaying(int mult, const u32b* flgs, const monster_type* m_ptr)
        return mult;
 }
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¹¶·â¤Î°À­¥¹¥ì¥¤¥ó¥°ÇÜΨ·×»»
+ * @param mult »»½ÐÁ°¤Î´ðËÜÇÜΨ(/10ÇÜ)
+ * @param flgs ¥¹¥ì¥¤¥Õ¥é¥°ÇÛÎó
+ * @param m_ptr ÌÜɸ¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¥¹¥ì¥¤¥ó¥°²ÃÌ£¸å¤ÎÇÜΨ(/10ÇÜ)
+ */
 static int mult_brand(int mult, const u32b* flgs, const monster_type* m_ptr)
 {
        static const struct brand_table_t {
@@ -364,14 +378,21 @@ static int mult_brand(int mult, const u32b* flgs, const monster_type* m_ptr)
 
        return mult;
 }
-/*
+
+/*!
+ * @brief ¥À¥á¡¼¥¸¤Ë¥¹¥ì¥¤Í×ÁǤò²Ã¤¨¤ëÁí¹ç½èÍý¥ë¡¼¥Á¥ó /
  * Extract the "total damage" from a given object hitting a given monster.
- *
- * Note that "flasks of oil" do NOT do fire damage, although they
- * certainly could be made to do so.  XXX XXX
- *
- * Note that most brands and slays are x3, except Slay Animal (x2),
- * Slay Evil (x2), and Kill dragon (x5).
+ * @param o_ptr »ÈÍÑÉð´ï¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param tdam ¸½ºß»»½ÐÅÓÃæ¤Î¥À¥á¡¼¥¸ÃÍ
+ * @param m_ptr ÌÜɸ¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param thrown ¼Í·â½èÍý¤Ê¤é¤ÐTRUE¤ò»ØÄꤹ¤ë
+ * @return Áí¹çŪ¤Ê¥¹¥ì¥¤¤ò²ÃÌ£¤·¤¿¥À¥á¡¼¥¸ÃÍ
+ * @note
+ * Note that "flasks of oil" do NOT do fire damage, although they\n
+ * certainly could be made to do so.  XXX XXX\n
+ *\n
+ * Note that most brands and slays are x3, except Slay Animal (x2),\n
+ * Slay Evil (x2), and Kill dragon (x5).\n
  */
 s16b tot_dam_aux(object_type *o_ptr, int tdam, monster_type *m_ptr, int mode, bool thrown)
 {
@@ -441,8 +462,12 @@ s16b tot_dam_aux(object_type *o_ptr, int tdam, monster_type *m_ptr, int mode, bo
 }
 
 
-/*
+/*!
+ * @brief ÃÏ·Á¤ä¤½¤Î¾å¤Î¥¢¥¤¥Æ¥à¤Î±£¤µ¤ì¤¿Í×ÁǤòÌÀ¤«¤¹ /
  * Search for hidden things
+ * @param y ÂоݤȤʤë¥Þ¥¹¤ÎYºÂɸ
+ * @param x ÂоݤȤʤë¥Þ¥¹¤ÎXºÂɸ
+ * @return ¤Ê¤·
  */
 static void discover_hidden_things(int y, int x)
 {
@@ -511,6 +536,10 @@ static void discover_hidden_things(int y, int x)
        }
 }
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Îõº÷½èÍýȽÄê
+ * @return ¤Ê¤·
+ */
 void search(void)
 {
        int i, chance;