Add Doxygen comment to birth.c.

diff --git a/src/birth.c b/src/birth.c
index 63b6290..f1f886f 100644 (file)
--- a/src/birth.c
+++ b/src/birth.c
@@ -58,19 +58,19 @@ struct hist_type
 
 
 /*!
- * À¸¤¤Î©¤Á¥Æ¡¼¥Ö¥ë¤ÎÄêµÁ / Background information (see below)
- *
- * Chart progression by race:
- *   Human         -->  1 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53
- *   Half-Elf      -->  4 -->  1 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53
- *   Elf/High-Elf  -->  7 -->  8 -->  9 --> 54 --> 55 --> 56
- *   Hobbit        --> 10 --> 11 -->  3 --> 50 --> 51 --> 52 --> 53
- *   Gnome         --> 13 --> 14 -->  3 --> 50 --> 51 --> 52 --> 53
- *   Dwarf         --> 16 --> 17 --> 18 --> 57 --> 58 --> 59 --> 60 --> 61
- *   Half-Orc      --> 19 --> 20 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53
- *   Half-Troll    --> 22 --> 23 --> 62 --> 63 --> 64 --> 65 --> 66
- *
- * XXX XXX XXX This table *must* be correct or drastic errors may occur!
+ * À¸¤¤Î©¤Á¥Æ¡¼¥Ö¥ë¤ÎÄêµÁ / Background information (see below)\n
+ *\n
+ * Chart progression by race:\n
+ *   Human         -->  1 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53\n
+ *   Half-Elf      -->  4 -->  1 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53\n
+ *   Elf/High-Elf  -->  7 -->  8 -->  9 --> 54 --> 55 --> 56\n
+ *   Hobbit        --> 10 --> 11 -->  3 --> 50 --> 51 --> 52 --> 53\n
+ *   Gnome         --> 13 --> 14 -->  3 --> 50 --> 51 --> 52 --> 53\n
+ *   Dwarf         --> 16 --> 17 --> 18 --> 57 --> 58 --> 59 --> 60 --> 61\n
+ *   Half-Orc      --> 19 --> 20 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53\n
+ *   Half-Troll    --> 22 --> 23 --> 62 --> 63 --> 64 --> 65 --> 66\n
+ *\n
+ * XXX XXX XXX This table *must* be correct or drastic errors may occur!\n
  */
 static hist_type bg[] =
 {
@@ -2057,18 +2057,23 @@ static struct {
 /*! ¥ª¡¼¥È¥í¡¼¥éÃæ¡¢³ÆǽÎÏÃͤ¬¿å½à¤òĶ¤¨¤¿²ó¿ô / Autoroll matches */
 static s32b stat_match[6];
 
-/*1 ¥ª¡¼¥È¥í¡¼¥é¤Î»î¹Ô²ó¿ô / Autoroll round */
+/*! ¥ª¡¼¥È¥í¡¼¥é¤Î»î¹Ô²ó¿ô / Autoroll round */
 static s32b auto_round;
 
+/*! 
+ * @brief ¥×¥ì¥¤¥ä¡¼ºîÀ®¤òÃæÃǤ·¤ÆÊѶòÈÚÅܤò½ªÎ»¤¹¤ë
+ * @return ¤Ê¤·
+ */
 static void birth_quit(void)
 {
        remove_loc();
        quit(NULL);
 }
 
-
-/*
- *  Show specific help file
+/*!
+ * @brief »ØÄꤵ¤ì¤¿¥Ø¥ë¥×¥Õ¥¡¥¤¥ë¤òɽ¼¨¤¹¤ë / Show specific help file
+ * @param helpfile ¥Õ¥¡¥¤¥ë̾
+ * @return ¤Ê¤·
  */
 static void show_help(cptr helpfile)
 {
@@ -2083,8 +2088,11 @@ static void show_help(cptr helpfile)
 }
 
 
-/*
- * Choose from one of the available magical realms
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎËâË¡Îΰè¤òÁªÂò¤¹¤ë / Choose from one of the available magical realms
+ * @param choices ÁªÂò²Äǽ¤ÊËâË¡Îΰè¤Î¥Ó¥Ã¥ÈÇÛÎó
+ * @param count ÁªÂò²Äǽ¤ÊËâË¡Îΰè¤òÊÖ¤¹¥Ý¥¤¥ó¥¿·²¡£
+ * @return ÁªÂò¤·¤¿ËâË¡Îΰè¤ÎID
  */
 static byte choose_realm(s32b choices, int *count)
 {
@@ -2345,8 +2353,9 @@ static byte choose_realm(s32b choices, int *count)
 }
 
 
-/*
- * Choose the magical realms
+/*!
+ * @brief ÁªÂò¤·¤¿ËâË¡Îΰè¤Î²òÀâ¤òɽ¼¨¤¹¤ë / Choose the magical realms
+ * @return ¥æ¡¼¥¶¤¬ËâË¡Îΰè¤Î³ÎÄê¤òÁª¤ó¤À¤éTRUE¤òÊÖ¤¹¡£
  */
 static bool get_player_realms(void)
 {
@@ -2480,8 +2489,10 @@ else
 }
 
 
-/*
- * Save the current data for later
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¯¥¤¥Ã¥¯¥¹¥¿¡¼¥È¾ðÊó¤ò¥×¥ì¥¤¥ä¡¼¹½Â¤ÂΤ«¤éÊݸ¤¹¤ë / Save the current data for later
+ * @param birther_ptr ¥¯¥¤¥Ã¥¯¥¹¥¿¡¼¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·¡£
  */
 static void save_prev_data(birther *birther_ptr)
 {
@@ -2529,8 +2540,10 @@ static void save_prev_data(birther *birther_ptr)
 }
 
 
-/*
- * Load the previous data
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¯¥¤¥Ã¥¯¥¹¥¿¡¼¥È¾ðÊó¤ò¥×¥ì¥¤¥ä¡¼¹½Â¤ÂΤØÆɤ߹þ¤à / Load the previous data
+ * @param swap TRUE¤Ê¤é¤Ð¸½ºß¤Î¥×¥ì¥¤¥ä¡¼¹½Â¤Âξå¤È¤ÎÆâÍƤò¥¹¥ï¥Ã¥×¤¹¤ë·Á¤ÇÆɤ߹þ¤à¡£
+ * @return ¤Ê¤·¡£
  */
 static void load_prev_data(bool swap)
 {
@@ -2595,8 +2608,11 @@ static void load_prev_data(bool swap)
 
 
 
-/*
- * Returns adjusted stat -JK-  Algorithm by -JWT-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎǽÎÏÃÍɽ¸½¤Ë´ð¤Å¤¤¤Æ²Ã¸º»»¤ò¹Ô¤¦¡£
+ * @param value ¸½ºß¤ÎǽÎÏÃÍ
+ * @param amount ²Ã¸º»»¤¹¤ëÃÍ
+ * @return ²Ã¸º»»¤Î·ë²Ì
  */
 static int adjust_stat(int value, int amount)
 {