OSDN Git Service

Add Doxygen comment to do-spell.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 31 Dec 2013 09:48:37 +0000 (09:48 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 31 Dec 2013 09:48:37 +0000 (09:48 +0000)
src/do-spell.c

index a8f1112..d315223 100644 (file)
@@ -205,8 +205,12 @@ static cptr info_weight(int weight)
 }
 
 
-/*
- * Prepare standard probability to become beam for fire_bolt_or_beam()
+/*!
+ * @brief °ìÉô¥Ü¥ë¥ÈËâË¡¤Î¥Ó¡¼¥à²½³ÎΨ¤ò»»½Ð¤¹¤ë / Prepare standard probability to become beam for fire_bolt_or_beam()
+ * @return ¥Ó¡¼¥à²½³ÎΨ(%)
+ * @details
+ * ¥Ï¡¼¥É¥³¡¼¥Æ¥£¥ó¥°¤Ë¤è¤ë¼ÂÁõ¤¬¹Ô¤ï¤ì¤Æ¤¤¤ë¡£
+ * ¥á¥¤¥¸¤Ï(¥ì¥Ù¥ë)%¡¢¥Ï¥¤¥á¥¤¥¸¡¢¥¹¥Ú¥ë¥Þ¥¹¥¿¡¼¤Ï(¥ì¥Ù¥ë)%¡¢¤½¤ì°Ê³°¤Î¿¦¶È¤Ï(¥ì¥Ù¥ë/2)%
  */
 static int beam_chance(void)
 {
@@ -218,9 +222,16 @@ static int beam_chance(void)
        return p_ptr->lev / 2;
 }
 
-
-/*
- * Handle summoning and failure of trump spells
+/*!
+ * @brief ¥È¥é¥ó¥×ËâË¡Æȼ«¤Î¾¤´­½èÍý¤ò¹Ô¤¦ / Handle summoning and failure of trump spells
+ * @param num summon_specific()´Ø¿ô¤ò¸Æ¤Ó½Ð¤¹²ó¿ô
+ * @param pet ¥Ú¥Ã¥È²½¤È¤·¤Æ¾¤´­¤µ¤ì¤ë¤«Èݤ«
+ * @param y ¾¤´­°ÌÃÖ¤ÎyºÂɸ
+ * @param x ¾¤´­°ÌÃÖ¤ÎxºÂɸ
+ * @param lev ¾¤´­¥ì¥Ù¥ë
+ * @param type ¾¤´­¾ò·ïID
+ * @param mode ¥â¥ó¥¹¥¿¡¼À¸À®¾ò·ï¥Õ¥é¥°
+ * @return ¥â¥ó¥¹¥¿¡¼¤¬¡ÊŨÂФâ´Þ¤á¤Æ¡Ë¾¤´Ô¤µ¤ì¤¿¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool trump_summoning(int num, bool pet, int y, int x, int lev, int type, u32b mode)
 {
@@ -277,11 +288,15 @@ static bool trump_summoning(int num, bool pet, int y, int x, int lev, int type,
 }
 
 
-/*
- * This spell should become more useful (more controlled) as the
- * player gains experience levels.  Thus, add 1/5 of the player's
- * level to the die roll.  This eliminates the worst effects later on,
- * while keeping the results quite random.  It also allows some potent
+/*!
+ * @brief ¡Ö¥ï¥ó¥À¡¼¡×¤Î¥é¥ó¥À¥à¤Ê¸ú²Ì¤ò·èÄꤷ¤Æ½èÍý¤¹¤ë¡£
+ * @param dir Êý¸þID
+ * @return ¤Ê¤·
+ * @details
+ * This spell should become more useful (more controlled) as the\n
+ * player gains experience levels.  Thus, add 1/5 of the player's\n
+ * level to the die roll.  This eliminates the worst effects later on,\n
+ * while keeping the results quite random.  It also allows some potent\n
  * effects only at high level.
  */
 static void cast_wonder(int dir)
@@ -365,6 +380,11 @@ static void cast_wonder(int dir)
 }
 
 
+/*!
+ * @brief ¡Ö°­Î´­¡×¤Î¥é¥ó¥À¥à¤Ê¸ú²Ì¤ò·èÄꤷ¤Æ½èÍý¤¹¤ë¡£
+ * @param dir Êý¸þID
+ * @return ¤Ê¤·
+ */
 static void cast_invoke_spirits(int dir)
 {
        int plev = p_ptr->lev;
@@ -531,7 +551,11 @@ static void cast_invoke_spirits(int dir)
        }
 }
 
-
+/*!
+ * @brief ¥«¥ª¥¹Åª¸ú²Ì¤¢¤ë¤¤¤ÏµÚ¤Ó¥·¥ã¥Ã¥Õ¥ë¤Î¡Ö±¿Ì¿¤ÎÎء׸ú²Ì¤ò°ú¿ô´ð½à¤Ë½èÍý¤¹¤ë¡£
+ * @param spell ´ð½à¤È¤Ê¤ë°ú¿ôID
+ * @return ¤Ê¤·
+ */
 static void wild_magic(int spell)
 {
        int counter = 0;
@@ -630,7 +654,10 @@ static void wild_magic(int spell)
        }
 }
 
-
+/*!
+ * @brief ¥È¥é¥ó¥×Îΰè¤Î¡Ö¥·¥ã¥Ã¥Õ¥ë¡×¤Î¸ú²Ì¤ò¥é¥ó¥À¥à¤Ë·è¤á¤Æ½èÍý¤¹¤ë¡£
+ * @return ¤Ê¤·
+ */
 static void cast_shuffle(void)
 {
        int plev = p_ptr->lev;