OSDN Git Service

Add Doxygen comment to init2.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 31 Jan 2014 12:05:04 +0000 (12:05 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 31 Jan 2014 12:05:04 +0000 (12:05 +0000)
src/init2.c

index 9f33718..3d81126 100644 (file)
@@ -701,8 +701,10 @@ static errr init_info(cptr filename, header *head,
 }
 
 
-/*
+/*!
+ * @brief ÃÏ·Á¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "f_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_f_info(void)
 {
@@ -724,8 +726,10 @@ static errr init_f_info(void)
 }
 
 
-/*
+/*!
+ * @brief ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "k_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_k_info(void)
 {
@@ -745,8 +749,10 @@ static errr init_k_info(void)
 
 
 
-/*
+/*!
+ * @brief ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "a_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_a_info(void)
 {
@@ -766,8 +772,10 @@ static errr init_a_info(void)
 
 
 
-/*
+/*!
+ * @brief ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "e_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_e_info(void)
 {
@@ -787,8 +795,10 @@ static errr init_e_info(void)
 
 
 
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¼ï²¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "r_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_r_info(void)
 {
@@ -808,8 +818,10 @@ static errr init_r_info(void)
 
 
 
-/*
+/*!
+ * @brief ¥À¥ó¥¸¥ç¥ó¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "d_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_d_info(void)
 {
@@ -828,9 +840,11 @@ static errr init_d_info(void)
 }
 
 
-/*
+/*!
+ * @brief Vault¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "v_info" array
- *
+ * @return ¥¨¥é¡¼¥³¡¼¥É
+ * @note
  * Note that we let each entry have a unique "name" and "text" string,
  * even if the string happens to be empty (everyone has a unique '\0').
  */
@@ -851,8 +865,10 @@ errr init_v_info(void)
 }
 
 
-/*
+/*!
+ * @brief ¿¦¶Èµ»Ç½¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "s_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_s_info(void)
 {
@@ -871,8 +887,10 @@ static errr init_s_info(void)
 }
 
 
-/*
+/*!
+ * @brief ¿¦¶ÈËâË¡¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize the "m_info" array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_m_info(void)
 {
@@ -1450,8 +1468,10 @@ static byte store_table[MAX_STORES][STORE_CHOICES][2] =
 };
 
 
-/*
+/*!
+ * @brief ´ðËܾðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize misc. values
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_misc(void)
 {
@@ -1462,8 +1482,10 @@ static errr init_misc(void)
 }
 
 
-/*
+/*!
+ * @brief Ä®¾ðÊóÆɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize town array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_towns(void)
 {
@@ -1552,8 +1574,10 @@ static errr init_towns(void)
        return 0;
 }
 
-/*
+/*!
+ * @brief Å¹¾ðÊó½é´ü²½¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize buildings
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr init_buildings(void)
 {
@@ -1595,8 +1619,10 @@ errr init_buildings(void)
 }
 
 
-/*
+/*!
+ * @brief ¥¯¥¨¥¹¥È¾ðÊó½é´ü²½¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize quest array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_quests(void)
 {
@@ -1619,7 +1645,11 @@ static errr init_quests(void)
 
 static bool feat_tag_is_not_found = FALSE;
 
-
+/*!
+ * @brief ÃÏ·Á¥¿¥°¤«¤éID¤òÆÀ¤ë /
+ * Initialize quest array
+ * @return ÃÏ·ÁID
+ */
 s16b f_tag_to_index_in_init(cptr str)
 {
        s16b feat = f_tag_to_index(str);