OSDN Git Service

Add Doxygen comment to bldg.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 27 Dec 2013 14:34:24 +0000 (14:34 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 27 Dec 2013 14:34:24 +0000 (14:34 +0000)
src/bldg.c

index 2033094..452d447 100644 (file)
@@ -3050,8 +3050,11 @@ msg_print("
 }
 
 
-/*
- * Display quest information
+/*!
+ * @brief ¥¯¥¨¥¹¥È¾ðÊó¤òɽ¼¨¤·¤Ä¤Ä½èÍý¤¹¤ë¡£/ Display quest information
+ * @param quest ¥¯¥¨¥¹¥È¤ÎID
+ * @param do_init ¥¯¥¨¥¹¥È¤Î³«»Ï½èÍý(TRUE)¡¢·ë²Ì½èÍý¤«(FALSE)
+ * @return ¤Ê¤·
  */
 static void get_questinfo(int questnum, bool do_init)
 {
@@ -3098,9 +3101,10 @@ sprintf(tmp_str, "
        }
 }
 
-
-/*
- * Request a quest from the Lord.
+/*!
+ * @brief ¥¯¥¨¥¹¥È½èÍý¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó / Request a quest from the Lord.
+ * @param ¤Ê¤·
+ * @return ¤Ê¤·
  */
 static void castle_quest(void)
 {
@@ -3221,8 +3225,10 @@ msg_format("
 }
 
 
-/*
- * Display town history
+/*!
+ * @brief Ä®¤Ë´Ø¤¹¤ë¥Ø¥ë¥×¤òɽ¼¨¤¹¤ë / Display town history
+ * @param ¤Ê¤·
+ * @return ¤Ê¤·
  */
 static void town_history(void)
 {
@@ -3241,7 +3247,14 @@ static void town_history(void)
        screen_load();
 }
 
-/* critical happens at i / 10000 */
+/*!
+ * @brief ¼Í·â»þ¥¯¥ê¥Æ¥£¥«¥ë¤Ë¤è¤ë¥À¥á¡¼¥¸´üÂÔÃͽ¤Àµ·×»»¡Ê¥¹¥Ê¥¤¥Ñ¡¼¤Î½¸Ãæ½èÍý¤ÈÉð´ï·Ð¸³ÃÍ¡Ë / critical happens at i / 10000
+ * @param weight Éð´ï¤Î½ÅÎÌ
+ * @param plus_ammo ÌðÃƤΥÀ¥á¡¼¥¸½¤Àµ
+ * @param plus_bow µÝ¤Î¥À¥á¡¼¥¸½¤Àµ
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸ÎÌ
+ * @return ¥À¥á¡¼¥¸´üÂÔÃÍ
+ */
 s16b calc_crit_ratio_shot(int weight, int plus_ammo, int plus_bow,  int dam)
 {
        int i;
@@ -3267,6 +3280,14 @@ s16b calc_crit_ratio_shot(int weight, int plus_ammo, int plus_bow,  int dam)
        return i;
 }
 
+/*!
+ * @brief ¼Í·â»þ¥¯¥ê¥Æ¥£¥«¥ë¤Ë¤è¤ë¥À¥á¡¼¥¸´üÂÔÃͽ¤Àµ·×»»¡Ê½ÅḬ̂͸Éôʬ¡Ë / critical happens at i / 10000
+ * @param weight Éð´ï¤Î½ÅÎÌ
+ * @param plus_ammo ÌðÃƤΥÀ¥á¡¼¥¸½¤Àµ
+ * @param plus_bow µÝ¤Î¥À¥á¡¼¥¸½¤Àµ
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸ÎÌ
+ * @return ¥À¥á¡¼¥¸´üÂÔÃÍ
+ */
 s16b calc_expect_crit_shot(int weight, int plus_ammo, int plus_bow,  int dam)
 {
        u32b num;
@@ -3300,6 +3321,15 @@ s16b calc_expect_crit_shot(int weight, int plus_ammo, int plus_bow,  int dam)
        return num;
 }
 
+/*!
+ * @brief ¹¶·â»þ¥¯¥ê¥Æ¥£¥«¥ë¤Ë¤è¤ë¥À¥á¡¼¥¸´üÂÔÃͽ¤Àµ·×»»¡Ê½ÅÎ̤ÈÆǿ˽èÍý¡Ë / critical happens at i / 10000
+ * @param weight Éð´ï¤Î½ÅÎÌ
+ * @param plus Éð´ï¤Î¥À¥á¡¼¥¸½¤Àµ
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸
+ * @param meichuu Ì¿ÃæÃÍ
+ * @param dokubari Æǿ˽èÍý¤«Èݤ«
+ * @return ¥À¥á¡¼¥¸´üÂÔÃÍ
+ */
 s16b calc_expect_crit(int weight, int plus, int dam, s16b meichuu, bool dokubari)
 {
        u32b k, num;
@@ -3336,6 +3366,14 @@ s16b calc_expect_crit(int weight, int plus, int dam, s16b meichuu, bool dokubari
        return num;
 }
 
+/*!
+ * @brief ¹¶·â»þ¥¹¥ì¥¤¤Ë¤è¤ë¥À¥á¡¼¥¸´üÂÔÃͽ¤Àµ·×»» / critical happens at i / 10000
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸
+ * @param mult ¥¹¥ì¥¤ÇÜΨ¡Ê³Ý¤±»»Éôʬ¡Ë
+ * @param div ¥¹¥ì¥¤ÇÜΨ¡Ê³ä¤ê»»Éôʬ¡Ë
+ * @param force ÍýÎÏÆÃÊÌ·×»»¥Õ¥é¥°
+ * @return ¥À¥á¡¼¥¸´üÂÔÃÍ
+ */
 static s16b calc_slaydam(int dam, int mult, int div, bool force)
 {
        int tmp;
@@ -3357,6 +3395,20 @@ static s16b calc_slaydam(int dam, int mult, int div, bool force)
        return tmp;
 }
 
+/*!
+ * @brief ¹¶·â»þ¤Î´üÂÔÃÍ·×»»¡Ê¥¹¥ì¥¤¢ª½ÅÎÌ¥¯¥ê¥Æ¥£¥«¥ë¢ªÀÚ¤ìÌ£¸ú²Ì¡Ë
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸
+ * @param mult ¥¹¥ì¥¤ÇÜΨ¡Ê³Ý¤±»»Éôʬ¡Ë
+ * @param div ¥¹¥ì¥¤ÇÜΨ¡Ê³ä¤ê»»Éôʬ¡Ë
+ * @param force ÍýÎÏÆÃÊÌ·×»»¥Õ¥é¥°
+ * @param weight ½ÅÎÌ
+ * @param plus Éð´ï¥À¥á¡¼¥¸½¤Àµ
+ * @param meichuu Ì¿ÃæÃÍ
+ * @param dokubari Æǿ˽èÍý¤«Èݤ«
+ * @param vorpal_mult ÀÚ¤ìÌ£ÇÜΨ¡Ê³Ý¤±»»Éôʬ¡Ë
+ * @param vorpal_div ÀÚ¤ìÌ£ÇÜΨ¡Ê³ä¤ê»»Éôʬ¡Ë
+ * @return ¥À¥á¡¼¥¸´üÂÔÃÍ
+ */
 static u32b calc_expect_dice(u32b dam, int mult, int div, bool force, int weight, int plus, s16b meichuu, bool dokubari, int vorpal_mult, int vorpal_div)
 {
        dam = calc_slaydam(dam, mult, div, force);