OSDN Git Service

Add Doxygen comment to birth.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 28 Dec 2013 08:37:29 +0000 (08:37 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 28 Dec 2013 08:37:29 +0000 (08:37 +0000)
src/birth.c
src/bldg.c

index ef07044..63b6290 100644 (file)
@@ -1,16 +1,20 @@
-/* Purpose: create a player character */
-
-/*
- * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
- *
- * This software may be copied and distributed for educational, research,
- * and not for profit purposes provided that this copyright and statement
- * are included in all such copies.  Other copyrights may also apply.
+/*!
+ * @file birth.c
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎºîÀ®¤ò¹Ô¤¦ / Create a player character
+ * @date 2013/12/28
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\n
+ *\n
+ * This software may be copied and distributed for educational, research,\n
+ * and not for profit purposes provided that this copyright and statement\n
+ * are included in all such copies.  Other copyrights may also apply.\n
+ * 2013 Deskull Doxygen¸þ¤±¤Î¥³¥á¥ó¥ÈÀ°Íý\n
  */
 
 #include "angband.h"
 
-/*
+/*!
+ * ¥ª¡¼¥È¥í¡¼¥é¡¼¤ÎÆâÍƤòÉÁ²è¤¹¤ë´Ö³Ö / 
  * How often the autoroller will update the display and pause
  * to check for user interuptions.
  * Bigger values will make the autoroller faster, but slower
  */
 #define AUTOROLLER_STEP 5431L
 
-/*
- * Define this to cut down processor use while autorolling
- */
 #if 0
-#  define AUTOROLLER_DELAY
+/*!
+ * ¥ª¡¼¥È¥í¡¼¥é¤ò1²ó¤Þ¤ï¤¹¤´¤È¤Ë1/10ÉäΥ¦¥§¥¤¥È¤ò¤«¤±¤ë¥Þ¥¯¥íÄêµÁ / Define this to cut down processor use while autorolling
+ */
+#define AUTOROLLER_DELAY
 #endif
 
-/*
- * Maximum number of tries for selection of a proper quest monster
+/*!
+ * ¥é¥ó¥À¥à¥¯¥¨¥¹¥È¤Î¥â¥ó¥¹¥¿¡¼¤ò³ÎÄꤹ¤ë¤¿¤á¤Ë»î¹Ô¤¹¤ë²ó¿ô / Maximum number of tries for selection of a proper quest monster
  */
 #define MAX_TRIES 100
 
+/* ÁªÂò²Äǽ¤Ê¿¦¶È¤ÎºÇÂç¿ô */
 #define MAX_CLASS_CHOICE     MAX_CLASS
 
-/*
- * Forward declare
+/*!
+ * À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë / Forward declare
  */
 typedef struct hist_type hist_type;
 
-/*
- * Player background information
+/*!
+ * À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë¤Î¹½Â¤ÂÎÄêµÁ / Player background information
  */
 struct hist_type
 {
-       cptr info;                          /* Textual History */
+       cptr info;                          /*!> ¥á¥Ã¥»¡¼¥¸ËÜʸ / Textual History */
 
-       byte roll;                          /* Frequency of this entry */
-       byte chart;                         /* Chart index */
-       byte next;                          /* Next chart index */
-       byte bonus;                         /* Social Class Bonus + 50 */
+       byte roll;                          /*!> ³ÎΨ¤Î½Å¤ß / Frequency of this entry */
+       byte chart;                         /*!> À¸¤¤Î©¤Á¥á¥Ã¥»¡¼¥¸¤Îή¤ì¤ò¼¨¤¹¥Á¥ã¡¼¥ÈID / Chart index */
+       byte next;                          /*!> ¼¡¤Î¥Á¥ã¡¼¥ÈID */
+       byte bonus;                         /*!> ¥á¥Ã¥»¡¼¥¸¤Ëȼ¤¦¼Ò²ñŪÃϰ̤ÎÊѲ½ÎÌ(50¤¬´ð½àÃÍ) / Social Class Bonus + 50 */
 };
 
 
-/*
- * Background information (see below)
+/*!
+ * À¸¤¤Î©¤Á¥Æ¡¼¥Ö¥ë¤ÎÄêµÁ / Background information (see below)
  *
  * Chart progression by race:
  *   Human         -->  1 -->  2 -->  3 --> 50 --> 51 --> 52 --> 53
@@ -1610,6 +1615,7 @@ static hist_type bg[] =
 #endif
 };
 
+/*! ¼ï²¤Î²òÀâ¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë */
 static cptr race_jouhou[MAX_RACES] =
 {
 #ifdef JP
@@ -1766,6 +1772,7 @@ static cptr race_jouhou[MAX_RACES] =
 #endif
 };
 
+/*! ¿¦¶È¤Î²òÀâ¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë */
 static cptr class_jouhou[MAX_CLASS] =
 {
 #ifdef JP
@@ -1885,7 +1892,7 @@ static cptr class_jouhou[MAX_CLASS] =
 #endif
 };
 
-
+/*! Àµ³Î¤Î²òÀâ¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë */
 static cptr seikaku_jouhou[MAX_SEIKAKU] =
 {
 #ifdef JP
@@ -1942,6 +1949,7 @@ static cptr seikaku_jouhou[MAX_SEIKAKU] =
 #endif
 };
 
+/*! ËâË¡Îΰè¤Î¾ÜºÙ²òÀâ¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë */
 static cptr realm_jouhou[VALID_REALM] =
 {
 #ifdef JP
@@ -2000,6 +2008,7 @@ static cptr realm_jouhou[VALID_REALM] =
 #endif
 };
 
+/*! ËâË¡Îΰè¤Î´Ê°×²òÀâ¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë */
 static cptr realm_subinfo[VALID_REALM] =
 {
 #ifdef JP
@@ -2034,11 +2043,10 @@ static cptr realm_subinfo[VALID_REALM] =
 };
 
 
-/*
- * Autoroll limit
- */
+/*! ¥ª¡¼¥È¥í¡¼¥é¤ÎǽÎÏÃÍŪÍ×µá¿å½à / Autoroll limit */
 static s16b stat_limit[6];
 
+/*! ¥ª¡¼¥È¥í¡¼¥é¤ÎǯÎ𡢿ÈĹ¡¢Âνš¢¼Ò²ñŪÃϰ̤ÎÍ×µá¿å½à */
 static struct {
        s16b agemin, agemax;
        s16b htmin, htmax;
@@ -2046,17 +2054,12 @@ static struct {
        s16b scmin, scmax;
 } chara_limit;
 
-/*
- * Autoroll matches
- */
+/*! ¥ª¡¼¥È¥í¡¼¥éÃæ¡¢³ÆǽÎÏÃͤ¬¿å½à¤òĶ¤¨¤¿²ó¿ô / Autoroll matches */
 static s32b stat_match[6];
 
-/*
- * Autoroll round
- */
+/*1 ¥ª¡¼¥È¥í¡¼¥é¤Î»î¹Ô²ó¿ô / Autoroll round */
 static s32b auto_round;
 
-
 static void birth_quit(void)
 {
        remove_loc();
index fe4e4c7..89d5d4f 100644 (file)
@@ -600,7 +600,7 @@ static int cards[5]; /*!< 
 
 /*!
  * @brief ¥Ý¡¼¥«¡¼¤Î»³»¥¤òÀڤ롣
- * @param ¤Ê¤·
+ * @param deck ¥Ç¥Ã¥­¤ÎÇÛÎó
  * @return ¤Ê¤·
  */
 static void reset_deck(int deck[])