Add Doxygen comment to wizard1.c.

diff --git a/src/wizard1.c b/src/wizard1.c
index fc987c4..a56fe93 100644 (file)
--- a/src/wizard1.c
+++ b/src/wizard1.c
@@ -996,8 +996,12 @@ typedef struct
 } obj_desc_list;
 
 
-/*
+/*!
+ * @brief ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿Àè¤ËƱ¤¸Ê¸»ú¤òÊ£¿ô½ÐÎϤ¹¤ë /
  * Write out `n' of the character `c' to the spoiler file
+ * @param n ½ÐÎϤ¹¤ë¿ô
+ * @param c ½ÐÎϤ¹¤ë¥­¥ã¥é¥¯¥¿
+ * @return ¤Ê¤·
  */
 static void spoiler_out_n_chars(int n, char c)
 {
@@ -1005,8 +1009,11 @@ static void spoiler_out_n_chars(int n, char c)
 }
 
 
-/*
+/*!
+ * @brief ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿Àè¤Ë²þ¹Ô¤òÊ£¿ô½ÐÎϤ¹¤ë /
  * Write out `n' blank lines to the spoiler file
+ * @param n ²þ¹Ô¤ò½ÐÎϤ¹¤ë¿ô
+ * @return ¤Ê¤·
  */
 static void spoiler_blanklines(int n)
 {
@@ -1014,8 +1021,11 @@ static void spoiler_blanklines(int n)
 }
 
 
-/*
+/*!
+ * @brief ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿Àè¤ËÊ£¿ô¤Î¥Ï¥¤¥Õ¥ó¤ÇÁõ¾þ¤·¤¿Ê¸»úÎó¤ò½ÐÎϤ¹¤ë /
  * Write a line to the spoiler file and then "underline" it with hypens
+ * @param str ½ÐÎϤ·¤¿¤¤Ê¸»úÎó
+ * @return ¤Ê¤·
  */
 static void spoiler_underline(cptr str)
 {
@@ -1026,15 +1036,24 @@ static void spoiler_underline(cptr str)
 
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤ÎÆÃÀ­°ìÍ÷¤ò½ÐÎϤ¹¤ë /
+ * Write a line to the spoiler file and then "underline" it with hypens
+ * @param art_flags ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¥Õ¥é¥°·²
+ * @param flag_ptr ¥Õ¥é¥°µ­½Ò¾ðÊó¤Î»²¾È¥Ý¥¤¥ó¥¿
+ * @param desc_ptr µ­½ÒÆâÍƤòÊÖ¤¹¤¿¤á¤Îʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @param n_elmnts ¥Õ¥é¥°¤ÎÍ×ÁÇ¿ô
+ * @return desc_ptr¤ÈƱ¤¸¥¢¥É¥ì¥¹
+ * @details
+ * <pre>
  * This function does most of the actual "analysis". Given a set of bit flags
  * (which will be from one of the flags fields from the object in question),
  * a "flag description structure", a "description list", and the number of
  * elements in the "flag description structure", this function sets the
  * "description list" members to the appropriate descriptions contained in
  * the "flag description structure".
- *
  * The possibly updated description pointer is returned.
+ * </pre>
  */
 static cptr *spoiler_flag_aux(const u32b art_flags[TR_FLAG_SIZE],
                              const flag_desc *flag_ptr,
@@ -1054,8 +1073,12 @@ static cptr *spoiler_flag_aux(const u32b art_flags[TR_FLAG_SIZE],
 }
 
 
-/*
+/*!
+ * @brief ¥¢¥¤¥Æ¥à¤ÎÆÃÄêµ­½ÒÆâÍƤòÊÖ¤¹ /
  * Acquire a "basic" description "The Cloak of Death [1,+10]"
+ * @param o_ptr µ­½Ò¤òÆÀ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î»²¾È¥Ý¥¤¥ó¥¿
+ * @param desc_ptr µ­½ÒÆâÍƤòÊÖ¤¹¤¿¤á¤Îʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void analyze_general(object_type *o_ptr, char *desc_ptr)
 {