OSDN Git Service

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

index 3d81126..d2f7184 100644 (file)
@@ -1660,8 +1660,10 @@ s16b f_tag_to_index_in_init(cptr str)
 }
 
 
-/*
+/*!
+ * @brief ÃÏ·Á¤ÎÈÆÍÑÄêµÁ¤ò¥¿¥°¤òÄ̤¸¤Æ¼èÆÀ¤¹¤ë /
  * Initialize feature variables
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_feat_variables(void)
 {
@@ -1806,8 +1808,10 @@ static errr init_feat_variables(void)
 }
 
 
-/*
+/*!
+ * @brief ¤½¤Î¾¤Î½é´ü¾ðÊ󹹿· /
  * Initialize some other arrays
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_other(void)
 {
@@ -1931,8 +1935,10 @@ static errr init_other(void)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥ÈÇÛÎó¤ò½é´ü²½¤¹¤ë /
  * Initialize some other arrays
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_object_alloc(void)
 {
@@ -2047,8 +2053,10 @@ if (!num[0]) quit("Į
 }
 
 
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼ÇÛÎó¤ÈÀ¸À®¥Æ¡¼¥Ö¥ë¤ò½é´ü²½¤¹¤ë /
  * Initialize some other arrays
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 static errr init_alloc(void)
 {
@@ -2213,8 +2221,10 @@ static errr init_alloc(void)
 
 
 
-/*
+/*!
+ * @brief ²èÌ̺¸²¼¤Ë¥·¥¹¥Æ¥à¥á¥Ã¥»¡¼¥¸¤òɽ¼¨¤¹¤ë /
  * Hack -- take notes on line 23
+ * @return ¤Ê¤·
  */
 static void note(cptr str)
 {
@@ -2225,12 +2235,16 @@ static void note(cptr str)
 
 
 
-/*
+/*!
+ * @brief Á´¥²¡¼¥à¥Ç¡¼¥¿Æɤ߹þ¤ß¤Î¥µ¥Ö¥ë¡¼¥Á¥ó /
  * Hack -- Explain a broken "lib" folder and quit (see below).
- *
+ * @return ¤Ê¤·
+ * @note
+ * <pre>
  * XXX XXX XXX This function is "messy" because various things
  * may or may not be initialized, but the "plog()" and "quit()"
  * functions are "supposed" to work under any conditions.
+ * </pre>
  */
 static void init_angband_aux(cptr why)
 {
@@ -2266,26 +2280,29 @@ static void init_angband_aux(cptr why)
 }
 
 
-/*
+/*!
+ * @brief Á´¥²¡¼¥à¥Ç¡¼¥¿Æɤ߹þ¤ß¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Hack -- main Angband initialization entry point
- *
+ * @return ¤Ê¤·
+ * @note
+ * <pre>
+ * XXX XXX XXX This function is "messy" because various things
+ * may or may not be initialized, but the "plog()" and "quit()"
+ * functions are "supposed" to work under any conditions.
  * Verify some files, display the "news.txt" file, create
  * the high score file, initialize all internal arrays, and
  * load the basic "user pref files".
- *
  * Be very careful to keep track of the order in which things
  * are initialized, in particular, the only thing *known* to
  * be available when this function is called is the "z-term.c"
  * package, and that may not be fully initialized until the
  * end of this function, when the default "user pref files"
  * are loaded and "Term_xtra(TERM_XTRA_REACT,0)" is called.
- *
  * Note that this function attempts to verify the "news" file,
  * and the game aborts (cleanly) on failure, since without the
  * "news" file, it is likely that the "lib" folder has not been
  * correctly located.  Otherwise, the news file is displayed for
  * the user.
- *
  * Note that this function attempts to verify (or create) the
  * "high score" file, and the game aborts (cleanly) on failure,
  * since one of the most common "extraction" failures involves
@@ -2296,22 +2313,18 @@ static void init_angband_aux(cptr why)
  * code below, since the "lib/apex" directory, being empty in the
  * standard distributions, is most likely to be "lost", making it
  * impossible to create the high score file.
- *
  * Note that various things are initialized by this function,
  * including everything that was once done by "init_some_arrays".
- *
  * This initialization involves the parsing of special files
  * in the "lib/data" and sometimes the "lib/edit" directories.
- *
  * Note that the "template" files are initialized first, since they
  * often contain errors.  This means that macros and message recall
  * and things like that are not available until after they are done.
- *
  * We load the default "user pref files" here in case any "color"
  * changes are needed before character creation.
- *
  * Note that the "graf-xxx.prf" file must be loaded separately,
  * if needed, in the first (?) pass through "TERM_XTRA_REACT".
+ * </pre>
  */
 void init_angband(void)
 {
@@ -2657,8 +2670,9 @@ note("[
 
 }
 
-/*
- *  Get check sum in string form
+/*!
+ * @brief ¥µ¥à¥Á¥§¥Ã¥¯¾ðÊó¤ò½ÐÎÏ / Get check sum in string form
+ * @return ¥µ¥à¥Á¥§¥Ã¥¯¾ðÊó¤Îʸ»úÎó
  */
 cptr get_check_sum(void)
 {