OSDN Git Service

Add Doxygen comment to mspells1.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 18 Jan 2014 06:16:22 +0000 (06:16 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 18 Jan 2014 06:16:22 +0000 (06:16 +0000)
src/mspells1.c

index 1149619..1b3c584 100644 (file)
@@ -766,7 +766,7 @@ static bool spell_annoy(byte spell)
        return (FALSE);
 }
 
-/*
+/*!
  * @brief IDÃͤ¬¾¤´­·¿¤Î¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good for annoying the player.
  * @param spell È½ÄêÂоݤÎID
@@ -782,7 +782,7 @@ static bool spell_summon(byte spell)
 }
 
 
-/*
+/*!
  * @brief IDÃͤ¬»à¼ÔÉü³è½èÍý¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good for annoying the player.
  * @param spell È½ÄêÂоݤÎID
@@ -797,9 +797,11 @@ static bool spell_raise(byte spell)
        return (FALSE);
 }
 
-
-/*
+/*!
+ * @brief IDÃͤ¬Àï½ÑŪ¤Ê¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good in a tactical situation.
+ * @param spell È½ÄêÂоݤÎID
+ * @return Àï½ÑŪ¤ÊËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_tactic(byte spell)
 {
@@ -810,8 +812,11 @@ static bool spell_tactic(byte spell)
        return (FALSE);
 }
 
-/*
+/*!
+ * @brief IDÃͤ¬ÌµÅ¨²½¤¹¤ë¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell makes invulnerable.
+ * @param spell È½ÄêÂоݤÎID
+ * @return ¾¤´­·¿ËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_invulner(byte spell)
 {
@@ -822,8 +827,11 @@ static bool spell_invulner(byte spell)
        return (FALSE);
 }
 
-/*
+/*!
+ * @brief IDÃͤ¬²Ã®¤¹¤ë¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell hastes.
+ * @param spell È½ÄêÂоݤÎID
+ * @return ¾¤´­·¿ËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_haste(byte spell)
 {
@@ -835,36 +843,38 @@ static bool spell_haste(byte spell)
 }
 
 
-/*
+/*!
+ * @brief IDÃͤ¬»þ´ÖÄä»ß¤ò¹Ô¤¦¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell world.
+ * @param spell È½ÄêÂоݤÎID
+ * @return »þ´ÖÄä»ßËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_world(byte spell)
 {
-       /* world */
        if (spell == 160 + 6) return (TRUE);
-
-       /* Not a haste spell */
        return (FALSE);
 }
 
 
-/*
+/*!
+ * @brief IDÃͤ¬ÆÃÊ̸ú²Ì¤Î¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell special.
+ * @param spell È½ÄêÂоݤÎID
+ * @return ÆÃÊ̸ú²ÌËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_special(byte spell)
 {
        if (p_ptr->inside_battle) return FALSE;
-
-       /* world */
        if (spell == 160 + 7) return (TRUE);
-
-       /* Not a haste spell */
        return (FALSE);
 }
 
 
-/*
+/*!
+ * @brief IDÃͤ¬¸÷¤Î·õ¤Î¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell psycho-spear.
+ * @param spell È½ÄêÂоݤÎID
+ * @return ¸÷¤Î·õ¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_psy_spe(byte spell)
 {