Add Doxygen comment to files.c.

diff --git a/src/files.c b/src/files.c
index 6e90998..ca16af9 100644 (file)
--- a/src/files.c
+++ b/src/files.c
@@ -3059,7 +3059,7 @@ typedef struct {
 
 
 /*!
- * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ìÍ÷¤òɽ¼¨¤¹¤ë¤¿¤á¤Î¥µ¥Ö¥ë¡¼¥Á¥ó /
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ì¼ï¤òɽ¼¨¤¹¤ë¥µ¥Ö¥ë¡¼¥Á¥ó /
  * Helper function, see below
  * @param row ¥³¥ó¥½¡¼¥ëɽ¼¨°ÌÃ֤κ¸¾å¹Ô
  * @param col ¥³¥ó¥½¡¼¥ëɽ¼¨°ÌÃ֤κ¸¾åÎó
@@ -3201,8 +3201,10 @@ static void display_flag_aux(int row, int col, cptr header,
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ìÍ÷ɽ¼¨£± /
  * Special display, part 1
+ * @return ¤Ê¤·
  */
 static void display_player_flag_info(void)
 {
@@ -3330,8 +3332,10 @@ display_flag_aux(row+9, col, "
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ìÍ÷ɽ¼¨£² /
  * Special display, part 2
+ * @return ¤Ê¤·
  */
 static void display_player_other_flag_info(void)
 {
@@ -3521,8 +3525,10 @@ static void display_player_other_flag_info(void)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ìÍ÷ɽ¼¨£²a /
  * Special display, part 2a
+ * @return ¤Ê¤·
  */
 static void display_player_misc_info(void)
 {
@@ -3577,9 +3583,12 @@ put_str("
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÆÃÀ­¥Õ¥é¥°°ìÍ÷ɽ¼¨£²b /
  * Special display, part 2b
- *
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * How to print out the modifications and sustains.
  * Positive mods with no sustain will be light green.
  * Positive mods with a sustain will be dark green.
@@ -3587,6 +3596,7 @@ put_str("
  * Negative mods (from a curse) will be red.
  * Huge mods (>9), like from MICoMorgoth, will be a '*'
  * No mod, no sustain, will be a slate '.'
+ * </pre>
  */
 static void display_player_stat_info(void)
 {
@@ -3882,16 +3892,20 @@ c_put_str(TERM_L_GREEN, "ǽ
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¹¥Æ¡¼¥¿¥¹É½¼¨¥á¥¤¥ó½èÍý
  * Display the character on the screen (various modes)
- *
+ * @param ɽ¼¨¥â¡¼¥ÉID
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * The top one and bottom two lines are left blank.
- *
  * Mode 0 = standard display with skills
  * Mode 1 = standard display with history
  * Mode 2 = summary of various things
  * Mode 3 = summary of various things (part 2)
  * Mode 4 = mutations
+ * </pre>
  */
 void display_player(int mode)
 {
@@ -4156,9 +4170,10 @@ void display_player(int mode)
        }
 }
 
-
-/*
- *
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¹¥Æ¡¼¥¿¥¹É½¼¨¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_display_player(FILE *fff)
 {
@@ -4290,8 +4305,10 @@ static void dump_aux_display_player(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥Ú¥Ã¥È¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_pet(FILE *fff)
 {
@@ -4370,8 +4387,10 @@ static void dump_aux_pet(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶ÈǽÎϾðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_class_special(FILE *fff)
 {
@@ -4627,8 +4646,10 @@ static void dump_aux_class_special(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¥¯¥¨¥¹¥È¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_quest(FILE *fff)
 {
@@ -4664,8 +4685,10 @@ static void dump_aux_quest(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief »à¤ÎľÁ°¥á¥Ã¥»¡¼¥¸Ê¤Ӥ˰ä¸À¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_last_message(FILE *fff)
 {
@@ -4701,9 +4724,10 @@ static void dump_aux_last_message(FILE *fff)
        }
 }
 
-
-/*
- *
+/*!
+ * @brief µ¢´Ô¾ì½ê¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_recall(FILE *fff)
 {
@@ -4736,8 +4760,10 @@ static void dump_aux_recall(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¥ª¥×¥·¥ç¥ó¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_options(FILE *fff)
 {
@@ -4874,8 +4900,10 @@ static void dump_aux_options(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief Æ®µ»¾ì¤Î¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_arena(FILE *fff)
 {
@@ -4932,8 +4960,10 @@ static void dump_aux_arena(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ·âÇË¥â¥ó¥¹¥¿¡¼¤Î¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_monsters(FILE *fff)
 {
@@ -5050,8 +5080,10 @@ static void dump_aux_monsters(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¸µ¼ï²¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_race_history(FILE *fff)
 {
@@ -5087,8 +5119,10 @@ static void dump_aux_race_history(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ¸µËâË¡Îΰè¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_realm_history(FILE *fff)
 {
@@ -5111,8 +5145,10 @@ static void dump_aux_realm_history(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ÆÁ¤Î¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_virtues(FILE *fff)
 {
@@ -5154,8 +5190,10 @@ static void dump_aux_virtues(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ÆÍÁ³ÊѰۤξðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_mutations(FILE *fff)
 {
@@ -5172,8 +5210,10 @@ static void dump_aux_mutations(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ½ê»ýÉʤξðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_equipment_inventory(FILE *fff)
 {
@@ -5227,8 +5267,10 @@ static void dump_aux_equipment_inventory(FILE *fff)
 }
 
 
-/*
- *
+/*!
+ * @brief ²æ¤¬²È¤ÈÇîʪ´Û¤Î¥ª¥Ö¥¸¥§¥¯¥È¾ðÊó¤ò¥Õ¥¡¥¤¥ë¤Ë¥À¥ó¥×¤¹¤ë
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void dump_aux_home_museum(FILE *fff)
 {
@@ -5307,8 +5349,11 @@ static void dump_aux_home_museum(FILE *fff)
 }
 
 
-/*
+/*!
+ * @brief ¥À¥ó¥×½ÐÎϤΥᥤ¥ó¥ë¡¼¥Á¥ó
  * Output the character dump to a file
+ * @param fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr make_character_dump(FILE *fff)
 {