Fix Doxygen warning in object1.c.

diff --git a/src/object1.c b/src/object1.c
index a2cf9d8..4d2620b 100644 (file)
--- a/src/object1.c
+++ b/src/object1.c
@@ -2545,15 +2545,20 @@ void display_equip(void)
 }
 
 
-/*
+/*!
+ * @brief ½ê»ý/ÁõÈ÷¥ª¥Ö¥¸¥§¥¯¥È¤ËÁªÂò¥¿¥°¤òÍ¿¤¨¤ë/¥¿¥°¤Ë³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤«¤òÊÖ¤¹ /
  * Find the "first" inventory object with the given "tag".
- *
- * A "tag" is a numeral "n" appearing as "@n" anywhere in the
- * inscription of an object.  Alphabetical characters don't work as a
- * tag in this form.
- *
- * Also, the tag "@xn" will work as well, where "n" is a any tag-char,
- * and "x" is the "current" command_cmd code.
+ * @param cp Âбþ¤¹¤ë¥¿¥°ID¤òÍ¿¤¨¤ë»²¾È¥Ý¥¤¥ó¥¿
+ * @param tag ³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤«¤òÄ´¤Ù¤¿¤¤¥¿¥°
+ * @param mode ½ê»ý¡¢ÁõÈ÷¤ÎÀÚ¤êÂؤ¨
+ * @return ¥¿¥°¤Ë³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ * @detail 
+ * A "tag" is a numeral "n" appearing as "@n" anywhere in the\n
+ * inscription of an object.  Alphabetical characters don't work as a\n
+ * tag in this form.\n
+ *\n
+ * Also, the tag "@xn" will work as well, where "n" is a any tag-char,\n
+ * and "x" is the "current" command_cmd code.\n
  */
 static bool get_tag(int *cp, char tag, int mode)
 {
@@ -2664,15 +2669,21 @@ static bool get_tag(int *cp, char tag, int mode)
 }
 
 
-/*
- * Find the "first" floor object with the given "tag".
- *
- * A "tag" is a numeral "n" appearing as "@n" anywhere in the
- * inscription of an object.  Alphabetical characters don't work as a
- * tag in this form.
- *
- * Also, the tag "@xn" will work as well, where "n" is a any tag-char,
- * and "x" is the "current" command_cmd code.
+/*!
+ * @brief ¾²¥ª¥Ö¥¸¥§¥¯¥È¤ËÁªÂò¥¿¥°¤òÍ¿¤¨¤ë/¥¿¥°¤Ë³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤«¤òÊÖ¤¹ /
+ * Find the "first" inventory object with the given "tag".
+ * @param cp Âбþ¤¹¤ë¥¿¥°ID¤òÍ¿¤¨¤ë»²¾È¥Ý¥¤¥ó¥¿
+ * @param tag ³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤«¤òÄ´¤Ù¤¿¤¤¥¿¥°
+ * @param floor_list ¾²¾å¥¢¥¤¥Æ¥à¤ÎÇÛÎó
+ * @param floor_num  ¾²¾å¥¢¥¤¥Æ¥à¤ÎÇÛÎóID
+ * @return ¥¿¥°¤Ë³ºÅö¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤¬¤¢¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ * @detail 
+ * A "tag" is a numeral "n" appearing as "@n" anywhere in the\n
+ * inscription of an object.  Alphabetical characters don't work as a\n
+ * tag in this form.\n
+ *\n
+ * Also, the tag "@xn" will work as well, where "n" is a any tag-char,\n
+ * and "x" is the "current" command_cmd code.\n
  */
 static bool get_tag_floor(int *cp, char tag, int floor_list[], int floor_num)
 {
@@ -2754,8 +2765,12 @@ static bool get_tag_floor(int *cp, char tag, int floor_list[], int floor_num)
 }
 
 
-/*
+/*!
+ * @brief ¥¿¥°ID¤Ë¤¢¤ï¤»¤Æ¥¿¥°¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¤Î¥ê¥¹¥È¤òÊÖ¤¹ /
  * Move around label characters with correspond tags
+ * @param label ¥é¥Ù¥ë¥ê¥¹¥È¤ò¼èÆÀ¤¹¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @param mode ½ê»ýÉʥꥹ¥È¤«ÁõÈ÷Éʥꥹ¥È¤«¤ÎÀÚ¤êÂؤ¨
+ * @return ¤Ê¤·
  */
 static void prepare_label_string(char *label, int mode)
 {
@@ -2785,8 +2800,15 @@ static void prepare_label_string(char *label, int mode)
 }
 
 
-/*
+/*!
+ * @brief ¥¿¥°ID¤Ë¤¢¤ï¤»¤Æ¥¿¥°¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¤Î¥ê¥¹¥È¤òÊÖ¤¹(¾²¾å¥¢¥¤¥Æ¥àÍÑ) /
  * Move around label characters with correspond tags (floor version)
+ * @param label ¥é¥Ù¥ë¥ê¥¹¥È¤ò¼èÆÀ¤¹¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @param floor_list ¾²¾å¥¢¥¤¥Æ¥à¤ÎÇÛÎó
+ * @param floor_num  ¾²¾å¥¢¥¤¥Æ¥à¤ÎÇÛÎóID
+ * @return ¤Ê¤·
+ */
+/*
  */
 static void prepare_label_string_floor(char *label, int floor_list[], int floor_num)
 {
@@ -2815,9 +2837,12 @@ static void prepare_label_string_floor(char *label, int floor_list[], int floor_
 }
 
 
-/*
+/*!
+ * @brief ½ê»ý¥¢¥¤¥Æ¥à¤Îɽ¼¨¤ò¹Ô¤¦ /
  * Display the inventory.
- *
+ * @param target_item ¥¢¥¤¥Æ¥à¤ÎÁªÂò½èÍý¤ò¹Ô¤¦¤«Èݤ«¡£
+ * @return ÁªÂò¤·¤¿¥¢¥¤¥Æ¥à¤Î¥¿¥°
+ * @details
  * Hack -- do not display "trailing" empty slots
  */
 int show_inven(int target_item)
@@ -2989,9 +3014,11 @@ int show_inven(int target_item)
 }
 
 
-
-/*
+/*!
+ * @brief ÁõÈ÷¥¢¥¤¥Æ¥à¤Îɽ¼¨¤ò¹Ô¤¦ /
  * Display the equipment.
+ * @param target_item ¥¢¥¤¥Æ¥à¤ÎÁªÂò½èÍý¤ò¹Ô¤¦¤«Èݤ«¡£
+ * @return ÁªÂò¤·¤¿¥¢¥¤¥Æ¥à¤Î¥¿¥°
  */
 int show_equip(int target_item)
 {
@@ -3196,11 +3223,10 @@ int show_equip(int target_item)
        return target_item_label;
 }
 
-
-
-
-/*
+/*!
+ * @brief ¥µ¥Ö¥¦¥£¥ó¥É¥¦¤Ë½ê»ýÉÊ¡¢ÁõÈ÷Éʥꥹ¥È¤Îɽ¼¨¤ò¹Ô¤¦ /
  * Flip "inven" and "equip" in any sub-windows
+ * @return ¤Ê¤·
  */
 void toggle_inven_equip(void)
 {
@@ -3236,12 +3262,12 @@ void toggle_inven_equip(void)
        }
 }
 
-
-
-/*
+/*!
+ * @brief ÁªÂò¤·¤¿¥¢¥¤¥Æ¥à¤Î³Îǧ½èÍý¤ÎÊä½õ /
  * Verify the choice of an item.
- *
- * The item can be negative to mean "item on floor".
+ * @param item ÁªÂò¥¢¥¤¥Æ¥àID
+ * @return ³Îǧ¤¬Yes¤Ê¤éTRUE¤òÊÖ¤¹¡£
+ * @details The item can be negative to mean "item on floor".
  */
 static bool verify(cptr prompt, int item)
 {
@@ -3278,10 +3304,12 @@ static bool verify(cptr prompt, int item)
 }
 
 
-/*
+/*!
+ * @brief ÁªÂò¤·¤¿¥¢¥¤¥Æ¥à¤Î³Îǧ½èÍý¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @praram item ÁªÂò¥¢¥¤¥Æ¥àID
+ * @return ³Îǧ¤¬Yes¤Ê¤éTRUE¤òÊÖ¤¹¡£
+ * @details The item can be negative to mean "item on floor".
  * Hack -- allow user to "prevent" certain choices
- *
- * The item can be negative to mean "item on floor".
  */
 static bool get_item_allow(int item)
 {
@@ -3333,9 +3361,11 @@ if (!verify("
 }
 
 
-
-/*
+/*!
+ * @brief ¥¢¥¤¥Æ¥à¤ò½¦¤¦¤³¤È¤¬¤Ç¤­¤ë¤«¤òÊÖ¤¹ /
  * Auxiliary function for "get_item()" -- test an index
+ * @param item ÁªÂò¥¢¥¤¥Æ¥àID
+ * @return ¥¢¥¤¥Æ¥à¤ò½¦¤¨¤ë¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 static bool get_item_okay(int i)
 {