From: deskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Date: Fri, 31 Jan 2014 11:50:27 +0000 (+0000)
Subject: Add Doxygen comment to init2.c.
X-Git-Tag: v2.2.0~373
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=872db2a01fbe8331133a39194a27d495f2347232;p=hengband%2Fhengband.git

Add Doxygen comment to init2.c.
---

diff --git a/src/init2.c b/src/init2.c
index 89b090735..9f33718ba 100644
--- a/src/init2.c
+++ b/src/init2.c
@@ -348,8 +348,12 @@ static errr check_modification_date(int fd, cptr template_file)
 /*** Initialize from binary image files ***/
 
 
-/*
+/*!
+ * @brief raw¥Õ¥¡¥¤¥ë¤«¤é¤Î¥Ç¡¼¥¿¤ÎÆɤ߼è¤ê½èÍý
  * Initialize the "*_info" array, by parsing a binary "image" file
+ * @param fd ¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
+ * @param head raw¥Õ¥¡¥¤¥ë¤Î¥Ø¥Ã¥À
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_info_raw(int fd, header *head)
 {
@@ -417,8 +421,13 @@ static errr init_info_raw(int fd, header *head)
 
 
 
-/*
+/*!
+ * @brief ¥Ø¥Ã¥À¹½Â¤ÂΤι¹¿·
  * Initialize the header of an *_info.raw file.
+ * @param head raw¥Õ¥¡¥¤¥ë¤Î¥Ø¥Ã¥À
+ * @param num ¥Ç¡¼¥¿¿ô
+ * @param len ¥Ç¡¼¥¿¤ÎŤµ
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static void init_header(header *head, int num, int len)
 {
@@ -438,9 +447,17 @@ static void init_header(header *head, int num, int len)
 }
 
 
-/*
+/*!
+ * @brief ¥Ø¥Ã¥À¹½Â¤ÂΤι¹¿·
  * Initialize the "*_info" array
- *
+ * @param filename ¥Õ¥¡¥¤¥ë̾(³ÈÄ¥»Òtxt/raw)
+ * @param head ½èÍý¤ËÍѤ¤¤ë¥Ø¥Ã¥À¹½Â¤ÂÎ
+ * @param info ¥Ç¡¼¥¿ÊÝ´ÉÀè¤Î¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @param name ̾¾ÎÍѲÄÊÑʸ»úÎó¤ÎÊÝ´ÉÀè
+ * @param text ¥Æ¥­¥¹¥ÈÍѲÄÊÑʸ»úÎó¤ÎÊÝ´ÉÀè
+ * @param tag ¥¿¥°ÍѲÄÊÑʸ»úÎó¤ÎÊÝ´ÉÀè
+ * @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').
  */