OSDN Git Service

Fix Doxygen warning in mspells1.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 17 Jan 2014 14:11:54 +0000 (14:11 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 17 Jan 2014 14:11:54 +0000 (14:11 +0000)
src/mspells1.c

index 7636638..ffb87f0 100644 (file)
@@ -499,9 +499,14 @@ bool clean_shot(int y1, int x1, int y2, int x2, bool is_friend)
 }
 
 /*
- * Cast a bolt at the player
- * Stop if we hit a monster
- * Affect monsters and the player
+ * @brief ¥â¥ó¥¹¥¿¡¼¤Î¥Ü¥ë¥È·¿ËâË¡½èÍý /
+ * Cast a bolt at the player Stop if we hit a monster Affect monsters and the player
+ * @param m_idx ¥â¥ó¥¹¥¿¡¼¤ÎID
+ * @param typ ¸ú²Ì°À­ID
+ * @param dam_hp °ÒÎÏ
+ * @param monspell ¥â¥ó¥¹¥¿¡¼ËâË¡¤ÎID
+ * @param learnable ¥é¡¼¥Ë¥ó¥°²Äǽ¤«Èݤ«
+ * @return ¤Ê¤·
  */
 static void bolt(int m_idx, int typ, int dam_hp, int monspell, bool learnable)
 {
@@ -512,6 +517,15 @@ static void bolt(int m_idx, int typ, int dam_hp, int monspell, bool learnable)
        (void)project(m_idx, 0, py, px, dam_hp, typ, flg, (learnable ? monspell : -1));
 }
 
+/*
+ * @brief ¥â¥ó¥¹¥¿¡¼¤Î¥Ó¡¼¥à·¿ËâË¡½èÍý /
+ * @param m_idx ¥â¥ó¥¹¥¿¡¼¤ÎID
+ * @param typ ¸ú²Ì°À­ID
+ * @param dam_hp °ÒÎÏ
+ * @param monspell ¥â¥ó¥¹¥¿¡¼ËâË¡¤ÎID
+ * @param learnable ¥é¡¼¥Ë¥ó¥°²Äǽ¤«Èݤ«
+ * @return ¤Ê¤·
+ */
 static void beam(int m_idx, int typ, int dam_hp, int monspell, bool learnable)
 {
        int flg = PROJECT_BEAM | PROJECT_KILL | PROJECT_THRU | PROJECT_PLAYER;
@@ -522,9 +536,18 @@ static void beam(int m_idx, int typ, int dam_hp, int monspell, bool learnable)
 
 
 /*
- * Cast a breath (or ball) attack at the player
- * Pass over any monsters that may be in the way
- * Affect grids, objects, monsters, and the player
+ * @brief ¥â¥ó¥¹¥¿¡¼¤Î¥Ü¡¼¥ë·¿¡õ¥Ö¥ì¥¹·¿ËâË¡½èÍý /
+ * Cast a breath (or ball) attack at the player Pass over any monsters that may be in the way Affect grids, objects, monsters, and the player
+ * @param y ÌÜɸÃÏÅÀ¤ÎYºÂɸ
+ * @param x ÌÜɸÃÏÅÀ¤ÎXºÂɸ
+ * @param m_idx ¥â¥ó¥¹¥¿¡¼¤ÎID
+ * @param typ ¸ú²Ì°À­ID
+ * @param dam_hp °ÒÎÏ
+ * @param rad È¾·Â
+ * @param breath TRUE¤Ê¤é¤Ð¥Ö¥ì¥¹½èÍý¡¢FALSE¤Ê¤é¤Ð¥Ü¡¼¥ë½èÍý
+ * @param monspell ¥â¥ó¥¹¥¿¡¼ËâË¡¤ÎID
+ * @param learnable ¥é¡¼¥Ë¥ó¥°²Äǽ¤«Èݤ«
+ * @return ¤Ê¤·
  */
 static void breath(int y, int x, int m_idx, int typ, int dam_hp, int rad, bool breath, int monspell, bool learnable)
 {
@@ -560,7 +583,12 @@ static void breath(int y, int x, int m_idx, int typ, int dam_hp, int rad, bool b
        (void)project(m_idx, rad, y, x, dam_hp, typ, flg, (learnable ? monspell : -1));
 }
 
-
+/*
+ * @brief ¥â¥ó¥¹¥¿¡¼¤Î¥Ü¡¼¥ë·¿¡õ¥Ö¥ì¥¹·¿ËâË¡½èÍý /
+ * @param power ¼ö¤¤¤ÎÃʳ¬
+ * @param o_ptr ¼ö¤¤¤ò¤«¤±¤é¤ì¤ëÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return Í¿¤¨¤ë¼ö¤¤¤ÎID
+ */
 u32b get_curse(int power, object_type *o_ptr)
 {
        u32b new_curse;
@@ -587,6 +615,12 @@ u32b get_curse(int power, object_type *o_ptr)
        return new_curse;
 }
 
+/*
+ * @brief ÁõÈ÷¤Ø¤Î¼ö¤¤ÉÕ²ÃȽÄê¤ÈÉղýèÍý /
+ * @param chance ¼ö¤¤¤Î´ðËܳÎΨ
+ * @param heavy_chance ½Å¤¤¼ö¤¤¤òÁªÂò»è¤ËÆþ¤ì¤ë¤«Èݤ«¡£
+ * @return ¤Ê¤·
+ */
 void curse_equipment(int chance, int heavy_chance)
 {
        bool        changed = FALSE;
@@ -657,7 +691,10 @@ msg_format("
 
 
 /*
+ * @brief IDÃͤ¬Àµ¤·¤¤¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good for hurting the player (directly).
+ * @param spell È½ÄêÂоݤÎID
+ * @return Àµ¤·¤¤ID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_attack(byte spell)
 {
@@ -682,7 +719,10 @@ static bool spell_attack(byte spell)
 
 
 /*
+ * @brief IDÃͤ¬ÂàÈòÌÜŪ¤ËŬ¤·¤¿¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good for escaping.
+ * @param spell È½ÄêÂоݤÎID
+ * @return Å¬¤·¤¿ËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_escape(byte spell)
 {
@@ -697,7 +737,10 @@ static bool spell_escape(byte spell)
 }
 
 /*
+ * @brief IDÃͤ¬Ë¸³²ÌÜŪ¤ËŬ¤·¤¿¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
  * Return TRUE if a spell is good for annoying the player.
+ * @param spell È½ÄêÂоݤÎID
+ * @return Å¬¤·¤¿ËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_annoy(byte spell)
 {
@@ -724,7 +767,10 @@ static bool spell_annoy(byte spell)
 }
 
 /*
- * Return TRUE if a spell summons help.
+ * @brief IDÃͤ¬¾¤´­·¿¤Î¥â¥ó¥¹¥¿¡¼ËâË¡ID¤«¤É¤¦¤«¤òÊÖ¤¹ /
+ * Return TRUE if a spell is good for annoying the player.
+ * @param spell È½ÄêÂоݤÎID
+ * @return ¾¤´­·¿ËâË¡¤ÎID¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_summon(byte spell)
 {
@@ -737,7 +783,10 @@ static bool spell_summon(byte spell)
 
 
 /*
- * Return TRUE if a spell raise-dead.
+ * @brief IDÃͤ¬»à¼ÔÉü³è½èÍý¤«¤É¤¦¤«¤òÊÖ¤¹ /
+ * Return TRUE if a spell is good for annoying the player.
+ * @param spell È½ÄêÂоݤÎID
+ * @return »à¼ÔÉü³è¤Î½èÍý¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool spell_raise(byte spell)
 {