Fix Doxygen warning in object2.c.

diff --git a/src/object2.c b/src/object2.c
index f398805..4c738e9 100644 (file)
--- a/src/object2.c
+++ b/src/object2.c
@@ -6777,10 +6777,12 @@ void reorder_pack(void)
 
 }
 
-
-/*
+/*!
+ * @brief ¸½ºß¥¢¥¯¥Æ¥£¥Ö¤Ë¤Ê¤Ã¤Æ¤¤¤ë¥¦¥£¥ó¥É¥¦¤Ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¾ÜºÙ¤òɽ¼¨¤¹¤ë /
  * Hack -- display an object kind in the current window
- *
+ * @param k_idx ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤Î»²¾ÈID
+ * @return ¤Ê¤·
+ * @details
  * Include list of usable spells for readible books
  */
 void display_koff(int k_idx)
@@ -6855,7 +6857,12 @@ void display_koff(int k_idx)
        }
 }
 
-/* Choose one of items that have warning flag */
+/*!
+ * @brief ·Ù¹ð¤òÊü¤Ä¥¢¥¤¥Æ¥à¤òÁªÂò¤¹¤ë /
+ * Choose one of items that have warning flag
+ * Calculate spell damages
+ * @return ·Ù¹ð¤ò¹Ô¤¦
+ */
 object_type *choose_warning_item(void)
 {
        int i;
@@ -6883,7 +6890,16 @@ object_type *choose_warning_item(void)
        return number ? &inventory[choices[randint0(number)]] : NULL;
 }
 
-/* Calculate spell damages */
+/*!
+ * @brief ·Ù¹ð´ð½à¤òÄê¤á¤ë¤¿¤á¤ËËâË¡¤Î¸ú²Ì°À­¤Ë´ð¤Å¤¤¤ÆºÇÂçËâË¡¥À¥á¡¼¥¸¤ò·×»»¤¹¤ë /
+ * Calculate spell damages
+ * @param m_ptr ËâË¡¤ò¹Ô»È¤¹¤ë¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param typ ¸ú²Ì°À­¤ÎID
+ * @param dam ´ðËÜ¥À¥á¡¼¥¸
+ * @param limit ¥À¥á¡¼¥¸¤Î¸Â³¦ÃÍ
+ * @param max »»½Ð¤·¤¿ºÇÂç¥À¥á¡¼¥¸¤òÊÖ¤¹¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void spell_damcalc(monster_type *m_ptr, int typ, int dam, int limit, int *max)
 {
        monster_race *r_ptr = &r_info[m_ptr->r_idx];
@@ -7122,7 +7138,13 @@ static void spell_damcalc(monster_type *m_ptr, int typ, int dam, int limit, int
        if (dam > *max) *max = dam;
 }
 
-/* Calculate blow damages */
+/*!
+ * @brief ·Ù¹ð´ð½à¤òÄê¤á¤ë¤¿¤á¤Ë¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·âºÇÂç¥À¥á¡¼¥¸¤ò»»½Ð¤¹¤ë /
+ * Calculate blow damages
+ * @param m_ptr ÂÇ·â¤ò¹Ô»È¤¹¤ë¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param blow_ptr ¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·âǽÎϤι½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return »»½Ð¤µ¤ì¤¿ºÇÂç¥À¥á¡¼¥¸¤òÊÖ¤¹¡£
+ */
 static int blow_damcalc(monster_type *m_ptr, monster_blow *blow_ptr)
 {
        int  dam = blow_ptr->d_dice * blow_ptr->d_side;
@@ -7193,7 +7215,13 @@ static int blow_damcalc(monster_type *m_ptr, monster_blow *blow_ptr)
        return dam;
 }
 
-/* Examine the grid (xx,yy) and warn the player if there are any danger */
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬ÆÃÄêÃÏÅÀ¤Ø°ÜÆ°¤·¤¿¾ì¹ç¤Ë·Ù¹ð¤òȯ¤¹¤ë½èÍý /
+ * Examine the grid (xx,yy) and warn the player if there are any danger
+ * @param xx ´í¸±À­¤òÄ´ºº¤¹¤ë¥Þ¥¹¤ÎXºÂɸ
+ * @param yy ´í¸±À­¤òÄ´ºº¤¹¤ë¥Þ¥¹¤ÎYºÂɸ
+ * @return ·Ù¹ð¤ò̵»ë¤·¤Æ¿Ê¤à¤³¤È¤òÁªÂò¤¹¤ë¤«¤«ÌäÂ̵꤬¤±¤ì¤ÐTRUE¡¢·Ù¹ð¤Ë½¾¤Ã¤¿¤Ê¤éFALSE¤òÊÖ¤¹¡£
+ */
 bool process_warning(int xx, int yy)
 {
        int mx, my;
@@ -7349,7 +7377,11 @@ bool process_warning(int xx, int yy)
        return TRUE;
 }
 
-
+/*!
+ * @brief ¥¨¥Ã¥»¥ó¥¹¤ÎÉղòÄǽ¤ÊÉð´ï¤äÌðÃƤ«¤òÊÖ¤¹
+ * @param o_ptr ¥Á¥§¥Ã¥¯¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥Ã¥»¥ó¥¹¤ÎÉղòÄǽ¤ÊÉð´ï¤«ÌðÃƤʤé¤ÐTRUE¤òÊÖ¤¹¡£
+ */
 static bool item_tester_hook_melee_ammo(object_type *o_ptr)
 {
        switch (o_ptr->tval)
@@ -7373,8 +7405,8 @@ static bool item_tester_hook_melee_ammo(object_type *o_ptr)
 }
 
 
-/*
- *  A structure for smithing
+/*!
+ * ¥¨¥Ã¥»¥ó¥¹¾ðÊó¤Î¹½Â¤ÂÎ / A structure for smithing
  */
 typedef struct {
        int add;       /* TR flag number or special essence id */
@@ -7385,8 +7417,8 @@ typedef struct {
 } essence_type;
 
 
-/*
- *  Smithing type data for Weapon smith
+/*!
+ * ¥¨¥Ã¥»¥ó¥¹¾ðÊó¥Æ¡¼¥Ö¥ë Smithing type data for Weapon smith
  */
 #ifdef JP
 static essence_type essence_info[] = 
@@ -7613,8 +7645,8 @@ static essence_type essence_info[] =
 #endif
 
 
-/*
- *  Essense names for Weapon smith
+/*!
+ * ¥¨¥Ã¥»¥ó¥¹Ì¾¥Æ¡¼¥Ö¥ë / Essense names for Weapon smith
  */
 #ifdef JP
 cptr essence_name[] = 
@@ -7822,7 +7854,10 @@ static cptr essence_name[] =
 };
 #endif
 
-
+/*!
+ * @brief ½ê»ý¤·¤Æ¤¤¤ë¥¨¥Ã¥»¥ó¥¹°ìÍ÷¤òɽ¼¨¤¹¤ë
+ * @return ¤Ê¤·
+ */
 static void display_essence(void)
 {
        int i, num = 0;
@@ -7853,6 +7888,10 @@ static void display_essence(void)
        return;
 }
 
+/*!
+ * @brief ¥¨¥Ã¥»¥ó¥¹¤ÎÃê½Ð½èÍý
+ * @return ¤Ê¤·
+ */
 static void drain_essence(void)
 {
        int drain_value[sizeof(p_ptr->magic_num1) / sizeof(s32b)];
@@ -8097,8 +8136,10 @@ static void drain_essence(void)
        p_ptr->window |= (PW_INVEN);
 }
 
-
-
+/*!
+ * @brief Éղ乤륨¥Ã¥»¥ó¥¹¤ÎÂçÊ̤òÁªÂò¤¹¤ë
+ * @return Áª¤ó¤À¥¨¥Ã¥»¥ó¥¹¤ÎÂçÊÌID
+ */
 static int choose_essence(void)
 {
        int mode = 0;
@@ -8213,6 +8254,11 @@ static int choose_essence(void)
        return mode;
 }
 
+/*!
+ * @brief ¥¨¥Ã¥»¥ó¥¹¤ò¼ÂºÝ¤ËÉղ乤ë
+ * @param mode ¥¨¥Ã¥»¥ó¥¹¤ÎÂçÊÌID
+ * @return ¤Ê¤·
+ */
 static void add_essence(int mode)
 {
        int item, max_num = 0;
@@ -8823,7 +8869,10 @@ static void add_essence(int mode)
        p_ptr->window |= (PW_INVEN);
 }
 
-
+/*!
+ * @brief ¥¨¥Ã¥»¥ó¥¹¤ò¾Ãµî¤¹¤ë
+ * @return ¤Ê¤·
+ */
 static void erase_essence(void)
 {
        int item;
@@ -8890,6 +8939,11 @@ static void erase_essence(void)
        p_ptr->window |= (PW_INVEN);
 }
 
+/*!
+ * @brief ÃÃÌꥳ¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
+ * @param only_browse TRUE¤Ê¤é¤Ð¥¨¥Ã¥»¥ó¥¹°ìÍ÷¤Îɽ¼¨¤Î¤ß¤ò¹Ô¤¦
+ * @return ¤Ê¤·
+ */
 void do_cmd_kaji(bool only_browse)
 {
        int mode = 0;
@@ -9080,8 +9134,12 @@ void do_cmd_kaji(bool only_browse)
 }
 
 
-/*
+/*!
+ * @brief ÅêÚ³»þ¤¿¤¤¤Þ¤Ä¤ËÅꤲ¤ä¤¹¤¤/¾Æ´þ/¥¢¥ó¥Ç¥Ã¥É¥¹¥ì¥¤¤ÎÆÃÊ̸ú²Ì¤òÊÖ¤¹¡£
  * Torches have special abilities when they are flaming.
+ * @param o_ptr ÅêÚ³¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param flgs ÆÃÊ̤ËÄɲ乤ë¥Õ¥é¥°¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 void torch_flags(object_type *o_ptr, u32b *flgs)
 {
@@ -9096,6 +9154,14 @@ void torch_flags(object_type *o_ptr, u32b *flgs)
        }
 }
 
+/*!
+ * @brief ÅêÚ³»þ¤¿¤¤¤Þ¤Ä¤Ë¥À¥¤¥¹¤òÍ¿¤¨¤ë¡£
+ * Torches have special abilities when they are flaming.
+ * @param o_ptr ÅêÚ³¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param dd ÆÃÊ̤ʥÀ¥¤¥¹¿ô¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
+ * @param dd ÆÃÊ̤ʥÀ¥¤¥¹ÌÌ¿ô¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void torch_dice(object_type *o_ptr, int *dd, int *ds)
 {
        if ((o_ptr->tval == TV_LITE) && (o_ptr->sval == SV_LITE_TORCH))
@@ -9108,6 +9174,12 @@ void torch_dice(object_type *o_ptr, int *dd, int *ds)
        }
 }
 
+/*!
+ * @brief ÅêÚ³»þÌ¿Ã椷¤¿¤¿¤¤¤Þ¤Ä¤Î¼÷Ì¿¤ò½Ì¤á¤ë¡£
+ * Torches have special abilities when they are flaming.
+ * @param o_ptr ÅêÚ³¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void torch_lost_fuel(object_type *o_ptr)
 {
        if ((o_ptr->tval == TV_LITE) && (o_ptr->sval == SV_LITE_TORCH))