Add Doxygen comment to birth.c.

diff --git a/src/birth.c b/src/birth.c
index 5cb35f6..0ba255b 100644 (file)
--- a/src/birth.c
+++ b/src/birth.c
@@ -3586,10 +3586,11 @@ static void init_turn(void)
 }
 
 
-/* 
- * Try to wield everything wieldable in the inventory. 
- * Code taken from Angband 3.1.0 under Angband license
- */ 
+/*!
+ * @brief ½ê»ý¾õÂ֤ˤ¢¤ë¥¢¥¤¥Æ¥à¤ÎÃ椫¤é°ìÉôÏȤÎÁõÈ÷²Äǽ¤Ê¤â¤Î¤òÁõÈ÷¤µ¤»¤ë¡£
+ * @details ¥¢¥ó¥Ç¥Ã¥É·Ï¼ï²¤Ï³«»Ï»þ¹ï¤òÌ뤫¤é¤Ë¤¹¤ë¡£
+ * @return ¤Ê¤·
+ */
 static void wield_all(void) 
 { 
        object_type *o_ptr; 
@@ -3651,9 +3652,10 @@ static void wield_all(void)
 } 
 
 
-/*
- * Each player starts out with a few items, given as tval/sval pairs.
- * In addition, he always has some food and a few torches.
+/*!
+ * ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶ÈËè¤Î½é´üÁõÈ÷¥Æ¡¼¥Ö¥ë¡£/\n
+ * Each player starts out with a few items, given as tval/sval pairs.\n
+ * In addition, he always has some food and a few torches.\n
  */
 static byte player_init[MAX_CLASS][3][2] =
 {
@@ -3851,9 +3853,10 @@ static byte player_init[MAX_CLASS][3][2] =
        },
 };
 
-
-/*
- * Hook function for human corpses
+/*!
+ * @brief ¥Ð¥ë¥í¥°¤¬»àÂΤò¿©¤Ù¤é¤ì¤ë¥â¥ó¥¹¥¿¡¼¤«¤ÎȽÄê / Hook function for human corpses
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼£É£Ä
+ * @return »àÂΤò¿©¤Ù¤é¤ì¤ë¤Ê¤éTRUE¤òÊÖ¤¹¡£
  */
 static bool monster_hook_human(int r_idx)
 {
@@ -3866,9 +3869,11 @@ static bool monster_hook_human(int r_idx)
        return FALSE;
 }
 
-
-/*
- * Add an outfit object
+/*!
+ * @brief ½é´ü½ê»ý¥¢¥¤¥Æ¥à¤Î½èÍý / Add an outfit object
+ * @detail ¥¢¥¤¥Æ¥à¤ò´ûÃΤΤâ¤Î¤È¤·¤¿¾å¤Çwield_all()´Ø¿ô¤Ë¤è¤êÁõÈ÷¤µ¤»¤ë¡£
+ * @param o_ptr ½èÍý¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void add_outfit(object_type *o_ptr)
 {
@@ -3886,10 +3891,10 @@ static void add_outfit(object_type *o_ptr)
 }
 
 
-/*
- * Init players with some belongings
- *
- * Having an item makes the player "aware" of its purpose.
+/*!
+ * @brief ¼ï²/¿¦¶È/À­³Ê¤Ê¤É¤Ë´ð¤Å¤­½é´ü½ê»ý¥¢¥¤¥Æ¥à¤òÀßÄꤹ¤ë¥á¥¤¥ó¥»¥Ã¥È´Ø¿ô¡£ / Init players with some belongings
+ * @detail Having an item makes the player "aware" of its purpose.
+ * @return ¤Ê¤·
  */
 void player_outfit(void)
 {
@@ -4143,9 +4148,9 @@ void player_outfit(void)
        k_info[lookup_kind(TV_POTION, SV_POTION_WATER)].aware = TRUE;
 }
 
-
-/*
- * Player race
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¼ï²ÁªÂò¤ò¹Ô¤¦ / Player race
+ * @return ¤Ê¤·
  */
 static bool get_player_race(void)
 {
@@ -4332,8 +4337,9 @@ static bool get_player_race(void)
 }
 
 
-/*
- * Player class
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶ÈÁªÂò¤ò¹Ô¤¦ / Player class
+ * @return ¤Ê¤·
  */
 static bool get_player_class(void)
 {
@@ -4547,8 +4553,9 @@ static bool get_player_class(void)
 }
 
 
-/*
- * Player seikaku
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÀ­³ÊÁªÂò¤ò¹Ô¤¦ / Player Player seikaku
+ * @return ¤Ê¤·
  */
 static bool get_player_seikaku(void)
 {
@@ -4792,6 +4799,10 @@ static bool get_player_seikaku(void)
 }
 
 #ifdef ALLOW_AUTOROLLER
+/*!
+ * @brief ¥ª¡¼¥È¥í¡¼¥é¤ÇÆÀ¤¿¤¤Ç½ÎÏÃͤδð½à¤ò·è¤á¤ë¡£
+ * @return ¤Ê¤·
+ */
 static bool get_stat_limits(void)
 {
        int i, j, m, cs, os;
@@ -5054,6 +5065,10 @@ static bool get_stat_limits(void)
 #endif
 
 #ifdef ALLOW_AUTOROLLER
+/*!
+ * @brief ¥ª¡¼¥È¥í¡¼¥é¤ÇÆÀ¤¿¤¤Ç¯Î𡢿ÈĹ¡¢Âνš¢¼Ò²ñŪÃϰ̤δð½à¤ò·è¤á¤ë¡£
+ * @return ¤Ê¤·
+ */
 static bool get_chara_limits(void)
 {
 #define MAXITEMS 8
@@ -5363,8 +5378,9 @@ static bool get_chara_limits(void)
 #define HISTPREF_LIMIT 1024
 static char *histpref_buf = NULL;
 
-/*
- * Hook function for reading the histpref.prf file.
+/*!
+ * @brief À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¤ÎÆâÍƤò¥Ð¥Ã¥Õ¥¡¤Ë²Ã¤¨¤ë¡£ / Hook function for reading the histpref.prf file.
+ * @return ¤Ê¤·
  */
 void add_history_from_pref_line(cptr t)
 {
@@ -5374,7 +5390,10 @@ void add_history_from_pref_line(cptr t)
        my_strcat(histpref_buf, t, HISTPREF_LIMIT);
 }
 
-
+/*!
+ * @brief À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¤ò¥Õ¥¡¥¤¥ë¤«¤é¥í¡¼¥É¤¹¤ë¡£
+ * @return ¤Ê¤·
+ */
 static bool do_cmd_histpref(void)
 {
        char buf[80];
@@ -5480,8 +5499,9 @@ static bool do_cmd_histpref(void)
        return TRUE;
 }
 
-/*
- *  Character background edit-mode
+/*!
+ * @brief À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¤òÊÔ½¸¤¹¤ë¡£/Character background edit-mode
+ * @return ¤Ê¤·
  */
 static void edit_history(void)
 {
@@ -5684,12 +5704,13 @@ static void edit_history(void)
 }
 
 
-/*
- * Helper function for 'player_birth()'
- *
+/*!
+ * @brief player_birth()´Ø¿ô¤Î¥µ¥Ö¥»¥Ã¥È/Helper function for 'player_birth()'
+ * @details
  * The delay may be reduced, but is recommended to keep players
  * from continuously rolling up characters, which can be VERY
  * expensive CPU wise.  And it cuts down on player stupidity.
+ * @return ¤Ê¤·
  */
 static bool player_birth_aux(void)
 {
@@ -6413,9 +6434,9 @@ static bool player_birth_aux(void)
        return (TRUE);
 }
 
-
-/*
- * Ask whether the player use Quick Start or not.
+/*!
+ * @brief ¥¯¥¤¥Ã¥¯¥¹¥¿¡¼¥È½èÍý¤ÎÌ䤤¹ç¤ï¤»¤È¼Â¹Ô¤ò¹Ô¤¦¡£/Ask whether the player use Quick Start or not.
+ * @return ¤Ê¤·
  */
 static bool ask_quick_start(void)
 {
@@ -6499,11 +6520,12 @@ static bool ask_quick_start(void)
 }
 
 
-/*
- * Create a new character.
- *
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼ºîÀ®½èÍý¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó/ Create a new character.
+ * @details
  * Note that we may be called with "junk" leftover in the various
  * fields, so we must be sure to clear them first.
+ * @return ¤Ê¤·
  */
 void player_birth(void)
 {
@@ -6615,7 +6637,11 @@ void player_birth(void)
                window_flag[2] |= PW_INVEN;
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼ºîÀ®½èÍýÃæ¤Î¥¹¥Æ¡¼¥¿¥¹É½¼¨½èÍý
+ * @params fff ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void dump_yourself(FILE *fff)
 {
        char temp[80*10];