From: deskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Date: Thu, 30 Jan 2014 11:41:58 +0000 (+0000)
Subject: Add Doxygen comment to init1.c.
X-Git-Tag: v2.2.0~376
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=4329b08437027a6b6ebfc2f73761d45db40e1fd7;p=hengbandforosx%2Fhengbandosx.git

Add Doxygen comment to init1.c.
---

diff --git a/src/init1.c b/src/init1.c
index 9fdf99948..b012e549e 100644
--- a/src/init1.c
+++ b/src/init1.c
@@ -1544,7 +1544,7 @@ static errr grab_one_feat_action(feature_type *f_ptr, cptr what, int count)
 
 /*!
  * @brief ÃÏ·Á¾ðÊó(f_info)¤Î¥Ñ¡¼¥¹´Ø¿ô /
- * Initialize the "s_info" array, by parsing an ascii "template" file
+ * Initialize the "f_info" array, by parsing an ascii "template" file
  * @param buf ¥Æ¥­¥¹¥ÈÎó
  * @param head ¥Ø¥Ã¥À¹½Â¤ÂÎ
  * @return ¥¨¥é¡¼¥³¡¼¥É
@@ -1913,8 +1913,12 @@ void retouch_f_info(header *head)
 }
 
 
-/*
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(¥Ù¡¼¥¹¥¢¥¤¥Æ¥àÍÑ) /
  * Grab one flag in an object_kind from a textual string
+ * @param k_ptr ÊÝ´ÉÀè¤Î¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr grab_one_kind_flag(object_kind *k_ptr, cptr what)
 {
@@ -1945,8 +1949,11 @@ static errr grab_one_kind_flag(object_kind *k_ptr, cptr what)
 	return (1);
 }
 
-/*
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(ȯưǽÎÏÍÑ) /
  * Grab one activation index flag
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ȯưǽÎÏID
  */
 static byte grab_one_activation_flag(cptr what)
 {
@@ -1980,8 +1987,12 @@ static byte grab_one_activation_flag(cptr what)
 }
 
 
-/*
+/*!
+ * @brief ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à(k_info)¤Î¥Ñ¡¼¥¹´Ø¿ô /
  * Initialize the "k_info" array, by parsing an ascii "template" file
+ * @param buf ¥Æ¥­¥¹¥ÈÎó
+ * @param head ¥Ø¥Ã¥À¹½Â¤ÂÎ
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr parse_k_info(char *buf, header *head)
 {
@@ -2254,9 +2265,12 @@ errr parse_k_info(char *buf, header *head)
 	return (0);
 }
 
-
-/*
- * Grab one flag in an artifact_type from a textual string
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÍÑ) /
+ * Grab one activation index flag
+ * @param a_ptr ÊÝ´ÉÀè¤Î¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¤¬¤¢¤Ã¤¿¾ì¹ç1¡¢¥¨¥é¡¼¤¬¤Ê¤¤¾ì¹ç0¤òÊÖ¤¹
  */
 static errr grab_one_artifact_flag(artifact_type *a_ptr, cptr what)
 {
@@ -2288,8 +2302,12 @@ static errr grab_one_artifact_flag(artifact_type *a_ptr, cptr what)
 }
 
 
-/*
+/*!
+ * @brief ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¾ðÊó(a_info)¤Î¥Ñ¡¼¥¹´Ø¿ô /
  * Initialize the "a_info" array, by parsing an ascii "template" file
+ * @param buf ¥Æ¥­¥¹¥ÈÎó
+ * @param head ¥Ø¥Ã¥À¹½Â¤ÂÎ
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr parse_a_info(char *buf, header *head)
 {
@@ -2482,8 +2500,12 @@ errr parse_a_info(char *buf, header *head)
 }
 
 
-/*
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÍÑ) /
  * Grab one flag in a ego-item_type from a textual string
+ * @param e_ptr ÊÝ´ÉÀè¤Î¥¨¥´¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¤¬¤¢¤Ã¤¿¾ì¹ç1¡¢¥¨¥é¡¼¤¬¤Ê¤¤¾ì¹ç0¤òÊÖ¤¹
  */
 static bool grab_one_ego_item_flag(ego_item_type *e_ptr, cptr what)
 {
@@ -2515,10 +2537,12 @@ static bool grab_one_ego_item_flag(ego_item_type *e_ptr, cptr what)
 }
 
 
-
-
-/*
+/*!
+ * @brief ¥¢¥¤¥Æ¥à¥¨¥´¾ðÊó(e_info)¤Î¥Ñ¡¼¥¹´Ø¿ô /
  * Initialize the "e_info" array, by parsing an ascii "template" file
+ * @param buf ¥Æ¥­¥¹¥ÈÎó
+ * @param head ¥Ø¥Ã¥À¹½Â¤ÂÎ
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr parse_e_info(char *buf, header *head)
 {
@@ -2700,8 +2724,12 @@ errr parse_e_info(char *buf, header *head)
 }
 
 
-/*
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(¥â¥ó¥¹¥¿¡¼ÍÑ1) /
  * Grab one (basic) flag in a monster_race from a textual string
+ * @param e_ptr ÊÝ´ÉÀè¤Î¥â¥ó¥¹¥¿¡¼¼ï²¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr grab_one_basic_flag(monster_race *r_ptr, cptr what)
 {
@@ -2739,8 +2767,12 @@ static errr grab_one_basic_flag(monster_race *r_ptr, cptr what)
 }
 
 
-/*
+/*!
+ * @brief ¥Æ¥­¥¹¥È¥È¡¼¥¯¥ó¤òÁöºº¤·¤Æ¥Õ¥é¥°¤ò°ì¤ÄÆÀ¤ë(¥â¥ó¥¹¥¿¡¼ÍÑ2) /
  * Grab one (spell) flag in a monster_race from a textual string
+ * @param e_ptr ÊÝ´ÉÀè¤Î¥â¥ó¥¹¥¿¡¼¼ï²¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param what »²¾È¸µ¤Îʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr grab_one_spell_flag(monster_race *r_ptr, cptr what)
 {
@@ -2766,10 +2798,12 @@ static errr grab_one_spell_flag(monster_race *r_ptr, cptr what)
 }
 
 
-
-
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¼ï²¾ðÊó(r_info)¤Î¥Ñ¡¼¥¹´Ø¿ô /
  * Initialize the "r_info" array, by parsing an ascii "template" file
+ * @param buf ¥Æ¥­¥¹¥ÈÎó
+ * @param head ¥Ø¥Ã¥À¹½Â¤ÂÎ
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr parse_r_info(char *buf, header *head)
 {