Add Doxygen comment to birth.c.

diff --git a/src/birth.c b/src/birth.c
index f1f886f..5cb35f6 100644 (file)
--- a/src/birth.c
+++ b/src/birth.c
@@ -2663,10 +2663,12 @@ static int adjust_stat(int value, int amount)
 
 
 
-/*
- * Roll for a characters stats
- *
- * For efficiency, we include a chunk of "calc_bonuses()".
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎǽÎÏÃͤò°ìÄ̤ê¥í¡¼¥ë¤¹¤ë¡£ / Roll for a characters stats
+ * @details
+ * calc_bonuses()¤Ë¤è¤ë¡¢ÆÈΩ¥¹¥Æ¡¼¥¿¥¹¤«¤é¤ÎÉû¼¡¥¹¥Æ¡¼¥¿¥¹»»½Ð¤â¹Ô¤Ã¤Æ¤¤¤ë¡£
+ * For efficiency, we include a chunk of "calc_bonuses()".\n
+ * @return ¤Ê¤·
  */
 static void get_stats(void)
 {
@@ -2719,6 +2721,10 @@ static void get_stats(void)
        }
 }
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¸Â³¦¥¹¥Æ¡¼¥¿¥¹¤ò·è¤á¤ë¡£
+ * @return ¤Ê¤·
+ */
 void get_max_stats(void)
 {
        int             i, j;
@@ -2761,8 +2767,9 @@ void get_max_stats(void)
 }
 
 
-/*
- * Roll for some info that the auto-roller ignores
+/*!
+ * @brief ¤½¤Î¾¡Ö¥ª¡¼¥È¥í¡¼¥éÃæ¤Ï»»½Ð¤ÎÂоݤˤ·¤Ê¤¤¡×Éû¼¡¥¹¥Æ¡¼¥¿¥¹¤ò½èÍý¤¹¤ë / Roll for some info that the auto-roller ignores
+ * @return ¤Ê¤·
  */
 static void get_extra(bool roll_hitdie)
 {
@@ -2813,8 +2820,9 @@ static void get_extra(bool roll_hitdie)
 }
 
 
-/*
- * Get the racial history, and social class, using the "history charts".
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÀ¸¤¤Î©¤Á¤Î¼«Æ°À¸À®¤ò¹Ô¤¦¡£ / Get the racial history, and social class, using the "history charts".
+ * @return ¤Ê¤·
  */
 static void get_history(void)
 {
@@ -3070,9 +3078,9 @@ static void get_history(void)
        }
 }
 
-
-/*
- * Get character's height and weight
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿ÈĹÂνŤò·è¤á¤ë / Get character's height and weight
+ * @return ¤Ê¤·
  */
 void get_height_weight(void)
 {
@@ -3098,9 +3106,10 @@ void get_height_weight(void)
 }
 
 
-/*
- * Computes character's age, height, and weight
- * by henkma
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎǯÎð¤ò·è¤á¤ë¡£ / Computes character's age, height, and weight by henkma
+ * @details ÆâÉô¤Çget_height_weight()¤â¸Æ¤Ó½Ð¤·¤Æ¤¤¤ë¡£
+ * @return ¤Ê¤·
  */
 static void get_ahw(void)
 {
@@ -3111,9 +3120,9 @@ static void get_ahw(void)
        get_height_weight();
 }
 
-
-/*
- * Get the player's starting money
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î½é´ü½ê»ý¶â¤ò·è¤á¤ë¡£ / Get the player's starting money
+ * @return ¤Ê¤·
  */
 static void get_money(void)
 {
@@ -3149,10 +3158,10 @@ static void get_money(void)
 
 
 
-/*
- * Display stat values, subset of "put_stats()"
- *
- * See 'display_player()' for screen layout constraints.
+/*!
+ * @brief put_stats()¤Î¥µ¥Ö¥ë¡¼¥Á¥ó¤È¤·¤Æ¡¢¥ª¡¼¥È¥í¡¼¥ëÃæ¤Î¥¹¥Æ¡¼¥¿¥¹¤òɽ¼¨¤¹¤ë / Display stat values, subset of "put_stats()"
+ * @details See 'display_player()' for screen layout constraints.
+ * @return ¤Ê¤·
  */
 static void birth_put_stats(void)
 {
@@ -3211,6 +3220,10 @@ static void birth_put_stats(void)
 }
 
 
+/*!
+ * @brief ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¹½Â¤ÂΤδÕÄêºÑ¤ß¥Õ¥é¥°¤ò¥ê¥»¥Ã¥È¤¹¤ë¡£
+ * @return ¤Ê¤·
+ */
 static void k_info_reset(void)
 {
        int i;
@@ -3229,8 +3242,9 @@ static void k_info_reset(void)
 }
 
 
-/*
- * Clear all the global "character" data
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¹½Â¤ÂΤÎÆâÍƤò½é´üÃͤǾõ¤ë / Clear all the global "character" data
+ * @return ¤Ê¤·
  */
 static void player_wipe(void)
 {
@@ -3425,8 +3439,10 @@ static void player_wipe(void)
 }
 
 
-/*
- *  Hook function for quest monsters
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¤¬¥¯¥¨¥¹¥È¤ÎƤȲÂоݤËÀ®¤êÆÀ¤ë¤«¤òÊÖ¤¹ / Hook function for quest monsters
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼£É£Ä
+ * @return ƤȲÂоݤˤǤ­¤ë¤Ê¤éTRUE¤òÊÖ¤¹¡£
  */
 static bool mon_hook_quest(int r_idx)
 {
@@ -3448,8 +3464,10 @@ static bool mon_hook_quest(int r_idx)
 }
 
 
-/*
- * Determine the random quest uniques
+/*!
+ * @brief ¥é¥ó¥À¥à¥¯¥¨¥¹¥È¤ÎƤȲ¥æ¥Ë¡¼¥¯¤ò·è¤á¤ë / Determine the random quest uniques
+ * @param q_ptr ¥¯¥¨¥¹¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 void determine_random_questor(quest_type *q_ptr)
 {
@@ -3492,9 +3510,9 @@ void determine_random_questor(quest_type *q_ptr)
        q_ptr->r_idx = r_idx;
 }
 
-
-/*
- *  Initialize random quests and final quests
+/*!
+ * @brief ¥À¥ó¥¸¥ç¥óÆâÉô¤Î¥¯¥¨¥¹¥È¤ò½é´ü²½¤¹¤ë / Initialize random quests and final quests
+ * @return ¤Ê¤·
  */
 static void init_dungeon_quests(void)
 {
@@ -3541,8 +3559,10 @@ static void init_dungeon_quests(void)
        p_ptr->inside_quest = 0;
 }
 
-/*
- * Reset turn
+/*!
+ * @brief ¥²¡¼¥à¥¿¡¼¥ó¤ò½é´ü²½¤¹¤ë / Reset turn
+ * @details ¥¢¥ó¥Ç¥Ã¥É·Ï¼ï²¤Ï³«»Ï»þ¹ï¤òÌ뤫¤é¤Ë¤¹¤ë¡£
+ * @return ¤Ê¤·
  */
 static void init_turn(void)
 {