Add Doxygen comment to wizard1.c.

diff --git a/src/wizard1.c b/src/wizard1.c
index a56fe93..504a009 100644 (file)
--- a/src/wizard1.c
+++ b/src/wizard1.c
@@ -1087,9 +1087,13 @@ static void analyze_general(object_type *o_ptr, char *desc_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬¥×¥ì¥¤¥ä¡¼¤ËÍ¿¤¨¤ëpval½¤Àµ¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
  * List "player traits" altered by an artifact's pval. These include stats,
  * speed, infravision, tunneling, stealth, searching, and extra attacks.
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param p_ptr pval½¤Àµ¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void analyze_pval(object_type *o_ptr, pval_info_type *p_ptr)
 {
@@ -1144,8 +1148,13 @@ static void analyze_pval(object_type *o_ptr, pval_info_type *p_ptr)
        *affects_list = NULL;
 }
 
-
-/* Note the slaying specialties of a weapon */
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¼ï²¥¹¥ì¥¤ÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
+ * Note the slaying specialties of a weapon
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param slay_list ¼ï²¥¹¥ì¥¤¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void analyze_slay(object_type *o_ptr, cptr *slay_list)
 {
        u32b flgs[TR_FLAG_SIZE];
@@ -1159,7 +1168,14 @@ static void analyze_slay(object_type *o_ptr, cptr *slay_list)
        *slay_list = NULL;
 }
 
-/* Note an object's elemental brands */
+
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î°À­¥Ö¥é¥ó¥ÉÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
+ * Note an object's elemental brands
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param brand_list °À­¥Ö¥é¥ó¥É¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void analyze_brand(object_type *o_ptr, cptr *brand_list)
 {
        u32b flgs[TR_FLAG_SIZE];
@@ -1174,7 +1190,13 @@ static void analyze_brand(object_type *o_ptr, cptr *brand_list)
 }
 
 
-/* Note the resistances granted by an object */
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤ÎÄ̾ïÂÑÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
+ * Note an object's elemental brands
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param resist_list Ä̾ïÂÑÀ­¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void analyze_resist(object_type *o_ptr, cptr *resist_list)
 {
        u32b flgs[TR_FLAG_SIZE];
@@ -1189,7 +1211,13 @@ static void analyze_resist(object_type *o_ptr, cptr *resist_list)
 }
 
 
-/* Note the immunities granted by an object */
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤ÎÌȱÖÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
+ * Note the immunities granted by an object
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param immune_list Ìȱֹ½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void analyze_immune(object_type *o_ptr, cptr *immune_list)
 {
        u32b flgs[TR_FLAG_SIZE];
@@ -1204,7 +1232,13 @@ static void analyze_immune(object_type *o_ptr, cptr *immune_list)
 }
 
 
-/* Note which stats an object sustains */
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î°Ý»ýÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
+ * Note which stats an object sustains
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param sustain_list °Ý»ýÆÃÀ­¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void analyze_sustains(object_type *o_ptr, cptr *sustain_list)
 {
        u32b flgs[TR_FLAG_SIZE];
@@ -1238,9 +1272,13 @@ static void analyze_sustains(object_type *o_ptr, cptr *sustain_list)
 }
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¤½¤Î¾¤ÎÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
  * Note miscellaneous powers bestowed by an artifact such as see invisible,
  * free action, permanent light, etc.
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param misc_list ¤½¤Î¾¤ÎÆÃÀ­¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void analyze_misc_magic(object_type *o_ptr, cptr *misc_list)
 {
@@ -1321,8 +1359,12 @@ static void analyze_misc_magic(object_type *o_ptr, cptr *misc_list)
 }
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤ÎÄɲåé¥ó¥À¥àÆÃÀ­¤ò¹½Â¤ÂΤ˼ý¤á¤ë /
  * Note additional ability and/or resistance of fixed artifacts
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param addition Äɲåé¥ó¥À¥àÂÑÀ­¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void analyze_addition(object_type *o_ptr, char *addition)
 {
@@ -1361,9 +1403,13 @@ static void analyze_addition(object_type *o_ptr, char *addition)
 }
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î´ðËܾðÊó¤òʸ»úÎó¤Ë¼ý¤á¤ë /
  * Determine the minimum depth an artifact can appear, its rarity, its weight,
  * and its value in gold pieces
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param misc_desc ´ðËܾðÊó¤ò¼ý¤á¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void analyze_misc(object_type *o_ptr, char *misc_desc)
 {
@@ -1381,8 +1427,13 @@ static void analyze_misc(object_type *o_ptr, char *misc_desc)
 }
 
 
-/*
+/*!
+ * @brief ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¾ðÊóÁ´ÂΤò¹½Â¤ÂΤ˼ý¤á¤ë /
  * Fill in an object description structure for a given object
+ * and its value in gold pieces
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param misc_desc Á´¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¾ðÊó¤ò¼ý¤á¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void object_analyze(object_type *o_ptr, obj_desc_list *desc_ptr)
 {
@@ -1400,6 +1451,10 @@ static void object_analyze(object_type *o_ptr, obj_desc_list *desc_ptr)
 }
 
 
+/*!
+ * @brief ¥Ð¥Ã¥Õ¥¡¤Ë¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È½ÐÎϾðÊó¥Ø¥Ã¥À¤ò¼ý¤á¤ë /
+ * @return ¤Ê¤·
+ */
 static void print_header(void)
 {
        char buf[80];