Fix Doxygen warning in object1.c.

diff --git a/src/object1.c b/src/object1.c
index 62d4757..a2cf9d8 100644 (file)
--- a/src/object1.c
+++ b/src/object1.c
@@ -1917,9 +1917,12 @@ prt("[
 
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥ÈÁªÂò»þ¤ÎÁªÂò¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¥é¥Ù¥ë¤òÊÖ¤¹ /
  * Convert an inventory index into a one character label
- * Note that the label does NOT distinguish inven/equip.
+ * @param i ¥×¥ì¥¤¥ä¡¼¤Î½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID
+ * @return Âбþ¤¹¤ë¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È
+ * @details Note that the label does NOT distinguish inven/equip.
  */
 char index_to_label(int i)
 {
@@ -1930,10 +1933,11 @@ char index_to_label(int i)
        return (I2A(i - INVEN_RARM));
 }
 
-
-/*
+/*!
+ * @brief ÁªÂò¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¥é¥Ù¥ë¤«¤é¥×¥ì¥¤¥ä¡¼¤Î½ê»ý¥ª¥Ö¥¸¥§¥¯¥ÈID¤òÊÖ¤¹ /
  * Convert a label into the index of an item in the "inven"
- * Return "-1" if the label does not indicate a real item
+ * @return Âбþ¤¹¤ëID¡£³ºÅö¥¹¥í¥Ã¥È¤Ë¥ª¥Ö¥¸¥§¥¯¥È¤¬Â¸ºß¤·¤Ê¤«¤Ã¤¿¾ì¹ç-1¤òÊÖ¤¹ / Return "-1" if the label does not indicate a real item
+ * @details Note that the label does NOT distinguish inven/equip.
  */
 s16b label_to_inven(int c)
 {
@@ -1953,19 +1957,25 @@ s16b label_to_inven(int c)
 }
 
 
-/* See cmd5.c */
+/*! See cmd5.c */
 extern bool select_ring_slot;
 
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID¤¬»ØÎØÏȤ«¤òÊÖ¤¹ /
+ * @param i ¥×¥ì¥¤¥ä¡¼¤Î½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID
+ * @return »ØÎØÏȤʤé¤ÐTRUE¤òÊÖ¤¹¡£
+ */
 static bool is_ring_slot(int i)
 {
        return (i == INVEN_RIGHT) || (i == INVEN_LEFT);
 }
 
 
-/*
+/*!
+ * @brief ÁªÂò¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¥é¥Ù¥ë¤«¤é¥×¥ì¥¤¥ä¡¼¤ÎÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID¤òÊÖ¤¹ /
  * Convert a label into the index of a item in the "equip"
- * Return "-1" if the label does not indicate a real item
+ * @return Âбþ¤¹¤ëID¡£³ºÅö¥¹¥í¥Ã¥È¤Ë¥ª¥Ö¥¸¥§¥¯¥È¤¬Â¸ºß¤·¤Ê¤«¤Ã¤¿¾ì¹ç-1¤òÊÖ¤¹ / Return "-1" if the label does not indicate a real item
  */
 s16b label_to_equip(int c)
 {
@@ -1988,8 +1998,11 @@ s16b label_to_equip(int c)
 
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤Î³ºÅöÁõÈ÷Éô°ÌID¤òÊÖ¤¹ /
  * Determine which equipment slot (if any) an item likes
+ * @param o_ptr ̾¾Î¤ò¼èÆÀ¤¹¤ë¸µ¤Î¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return Âбþ¤¹¤ëÁõÈ÷Éô°ÌID
  */
 s16b wield_slot(object_type *o_ptr)
 {
@@ -2073,9 +2086,11 @@ s16b wield_slot(object_type *o_ptr)
        return (-1);
 }
 
-
-/*
+/*!
+ * @brief ½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID¤ÎÉô°Ìɽ¸½¤òÊÖ¤¹ /
  * Return a string mentioning how a given item is carried
+ * @param i Éô°Ìɽ¸½¤òµá¤á¤ë¥×¥ì¥¤¥ä¡¼¤Î½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID
+ * @return Éô°Ìɽ¸½¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
  */
 cptr mention_use(int i)
 {
@@ -2168,8 +2183,12 @@ cptr mention_use(int i)
 }
 
 
-/*
+/*!
+ * @brief ½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID¤Î¸½ºß¤Î°·¤¤Êý¤Î¾õÂÖɽ¸½¤òÊÖ¤¹ /
  * Return a string describing how a given item is being worn.
+ * @param i ¾õÂÖɽ¸½¤òµá¤á¤ë¥×¥ì¥¤¥ä¡¼¤Î½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥ÈID
+ * @return ¾õÂÖɽ¸½ÆâÍƤÎʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @details
  * Currently, only used for items in the equipment, not inventory.
  */
 cptr describe_use(int i)
@@ -2262,7 +2281,13 @@ cptr describe_use(int i)
 }
 
 
-/* Hack: Check if a spellbook is one of the realms we can use. -- TY */
+/*!
+ * @brief tval/sval»ØÄê¤Î¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤¬¥×¥ì¥¤¥ä¡¼¤Î»ÈÍѲÄǽ¤ÊËâË¡½ñ¤«¤É¤¦¤«¤òÊÖ¤¹ /
+ * Hack: Check if a spellbook is one of the realms we can use. -- TY
+ * @param tval ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤Îtval
+ * @param sval ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤Îsval
+ * @return »ÈÍѲÄǽ¤ÊËâË¡½ñ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
+ */
 
 bool check_book_realm(const byte book_tval, const byte book_sval)
 {
@@ -2279,9 +2304,11 @@ bool check_book_realm(const byte book_tval, const byte book_sval)
        return (REALM1_BOOK == book_tval || REALM2_BOOK == book_tval);
 }
 
-
-/*
+/*!
+ * @brief ¥¢¥¤¥Æ¥à¤¬item_tester_hook¥°¥í¡¼¥Ð¥ë´Ø¿ô¥Ý¥¤¥ó¥¿¤Î¾ò·ï¤òËþ¤¿¤·¤Æ¤¤¤ë¤«¤òÊÖ¤¹ÈÆÍÑ´Ø¿ô
  * Check an item against the item tester info
+ * @param o_ptr ȽÄê¤ò¹Ô¤¤¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return item_tester_hook¤Î»²¾ÈÀè¡¢¤½¤Î¾¤¤¤¯¤Ä¤«¤ÎÎã³°¤Ë±þ¤¸¤ÆTRUE/FALSE¤òÊÖ¤¹¡£
  */
 bool item_tester_okay(object_type *o_ptr)
 {
@@ -2322,10 +2349,10 @@ bool item_tester_okay(object_type *o_ptr)
 }
 
 
-
-
-/*
+/*!
+ * @brief ½ê»ý¥¢¥¤¥Æ¥à°ìÍ÷¤òɽ¼¨¤¹¤ë /
  * Choice window "shadow" of the "show_inven()" function
+ * @return ¤Ê¤·
  */
 void display_inven(void)
 {
@@ -2418,8 +2445,10 @@ void display_inven(void)
 
 
 
-/*
+/*!
+ * @brief ÁõÈ÷¥¢¥¤¥Æ¥à°ìÍ÷¤òɽ¼¨¤¹¤ë /
  * Choice window "shadow" of the "show_equip()" function
+ * @return ¤Ê¤·
  */
 void display_equip(void)
 {