Add Doxygen comment to wizard1.c.

diff --git a/src/wizard1.c b/src/wizard1.c
index f71a079..84a8d5e 100644 (file)
--- a/src/wizard1.c
+++ b/src/wizard1.c
@@ -2329,8 +2329,13 @@ static void spoil_mon_info(cptr fname)
 #define MAX_EVOL_DEPTH 64
 
 
-/*
+/*!
+ * @brief intÇÛÎó¤Çstrncmp()¤È»÷¤¿Èæ³Ó½èÍý¤ò¹Ô¤¦ / 
  * Compare two int-type array like strncmp() and return TRUE if equals
+ * @param a Èæ³Ó¤¹¤ëintÇÛÎó1
+ * @param b Èæ³Ó¤¹¤ëintÇÛÎó2
+ * @param length 
+ * @return ξ¼Ô¤ÎÃͤ¬Åù¤·¤±¤ì¤ÐTRUE¤òÊÖ¤¹
  */
 static bool int_n_cmp(int *a, int *b, int length)
 {
@@ -2348,8 +2353,12 @@ static bool int_n_cmp(int *a, int *b, int length)
 }
 
 
-/*
+/*!
+ * @brief ¤¢¤ëÌÚ¤¬»ØÄꤵ¤ì¤¿ÌÚ¤ÎÉôʬÌÚ¤«¤É¤¦¤«¤òÊÖ¤¹ / 
  * Returns TRUE if an evolution tree is "partial tree"
+ * @param tree ¸µ¤È¤Ê¤ëÌÚ¹½Â¤¥ê¥¹¥È
+ * @param partical_tree ÉôʬÌÚ¤«¤É¤¦¤«È½Äꤷ¤¿¤¤ÌÚ¹½Â¤¥ê¥¹¥È
+ * @return ÉôʬÌڤʤé¤ÐTRUE¤òÊÖ¤¹
  */
 static bool is_partial_tree(int *tree, int *partial_tree)
 {
@@ -2370,8 +2379,14 @@ static bool is_partial_tree(int *tree, int *partial_tree)
 }
 
 
-/*
+/*!
+ * @brief ¿Ê²½¥Ä¥ê¡¼¤ò¥½¡¼¥È¤¹¤ë¤¿¤á¥â¥ó¥¹¥¿¡¼¼ï²¤ÎȽÄê´Ø¿ô / 
  * Sorting hook -- Comp function
+ * @param u ¿Ê²½ÌÚ¹½Â¤¥Ç¡¼¥¿
+ * @param v ̤»ÈÍÑ
+ * @param a Èæ³Ó¤·¤¿¤¤¥â¥ó¥¹¥¿¡¼¼ï²ID1
+ * @param b Èæ³Ó¤·¤¿¤¤¥â¥ó¥¹¥¿¡¼¼ï²ID2
+ * @return 2¤¬Â礭¤±¤ì¤ÐTRUE¤òÊÖ¤¹
  */
 static bool ang_sort_comp_evol_tree(vptr u, vptr v, int a, int b)
 {
@@ -2401,9 +2416,14 @@ static bool ang_sort_comp_evol_tree(vptr u, vptr v, int a, int b)
        return w1 <= w2;
 }
 
-
-/*
+/*!
+ * @brief ¿Ê²½¥Ä¥ê¡¼¤ò¥½¡¼¥È¤¹¤ë¤¿¤áÌÚ¹½Â¤¤Î¥¹¥ï¥Ã¥×´Ø¿ô / 
  * Sorting hook -- Swap function
+ * @param u ¿Ê²½ÌÚ¹½Â¤¥Ç¡¼¥¿
+ * @param v ̤»ÈÍÑ
+ * @param a ¥¹¥ï¥Ã¥×¤·¤¿¤¤ÌÚ¹½Â¤1
+ * @param b ¥¹¥ï¥Ã¥×¤·¤¿¤¤ÌÚ¹½Â¤2
+ * @return 2¤¬Â礭¤±¤ì¤ÐTRUE¤òÊÖ¤¹
  */
 static void ang_sort_swap_evol_tree(vptr u, vptr v, int a, int b)
 {
@@ -2419,9 +2439,11 @@ static void ang_sort_swap_evol_tree(vptr u, vptr v, int a, int b)
        evol_tree[b] = holder;
 }
 
-
-/*
+/*!
+ * @brief ¿Ê²½¥Ä¥ê¡¼¤ò¥¹¥Ý¥¤¥é¡¼½ÐÎϤ¹¤ë¥á¥¤¥ó¥ë¡¼¥Á¥ó / 
  * Print monsters' evolution information to file
+ * @param ½ÐÎÏ¥Õ¥¡¥¤¥ë̾
+ * @return ¤Ê¤·
  */
 static void spoil_mon_evol(cptr fname)
 {
@@ -2568,8 +2590,10 @@ static void spoil_mon_evol(cptr fname)
  */
 extern void do_cmd_spoilers(void);
 
-/*
+/*!
+ * @brief ¥¹¥Ý¥¤¥é¡¼½ÐÎϤò¹Ô¤¦¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó / 
  * Create Spoiler files -BEN-
+ * @return ¤Ê¤·
  */
 void do_cmd_spoilers(void)
 {
@@ -2644,8 +2668,12 @@ void do_cmd_spoilers(void)
        }
 }
 
-/*
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È£±·ï¤ò²òÀϤ¹¤ë / 
  * Fill in an object description structure for a given object
+ * @param o_ptr ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param desc_ptr µ­½ÒÆâÍƤò¼ý¤á¤ë¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void random_artifact_analyze(object_type *o_ptr, obj_desc_list *desc_ptr)
 {
@@ -2667,8 +2695,14 @@ static void random_artifact_analyze(object_type *o_ptr, obj_desc_list *desc_ptr)
 #endif
 }
 
-/* Create a spoiler file entry for an artifact */
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È£±·ï¤ò¥¹¥Ý¥¤¥é¡¼½ÐÎϤ¹¤ë / 
+ * Create a spoiler file entry for an artifact
+ * @param o_ptr ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param desc_ptr µ­½ÒÆâÍƤò¼ý¤á¤¿¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * Fill in an object description structure for a given object
+ * @return ¤Ê¤·
+ */
 static void spoiler_print_randart(object_type *o_ptr, obj_desc_list *art_ptr)
 {
        pval_info_type *pval_ptr = &art_ptr->pval_info;
@@ -2731,8 +2765,13 @@ static void spoiler_print_randart(object_type *o_ptr, obj_desc_list *art_ptr)
        fprintf(fff, "%s%s\n\n", INDENT1, art_ptr->misc_desc);
 }
 
-/* Create a part of file for random artifacts */
 
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÆâÍƤò¥¹¥Ý¥¤¥é¡¼½ÐÎϤ¹¤ë¥µ¥Ö¥ë¡¼¥Á¥ó / 
+ * @param o_ptr ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param i ½ÐÎϤ·¤¿¤¤µ­Ï¿¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈID
+ * @return ¤Ê¤·
+ */
 static void spoil_random_artifact_aux(object_type *o_ptr, int i)
 {
        obj_desc_list artifact;
@@ -2748,8 +2787,11 @@ static void spoil_random_artifact_aux(object_type *o_ptr, int i)
        spoiler_print_randart(o_ptr, &artifact);
 }
 
-/*
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÆâÍƤò¥¹¥Ý¥¤¥é¡¼½ÐÎϤ¹¤ë¥á¥¤¥ó¥ë¡¼¥Á¥ó / 
  * Create a list file for random artifacts
+ * @param fname ½ÐÎÏ¥Õ¥¡¥¤¥ë̾
+ * @return ¤Ê¤·
  */
 void spoil_random_artifact(cptr fname)
 {