OSDN Git Service

Add Doxygen comments to wild.c.
authorDeskull <deskull@users.sourceforge.jp>
Fri, 14 Feb 2014 14:30:37 +0000 (23:30 +0900)
committerDeskull <deskull@users.sourceforge.jp>
Fri, 14 Feb 2014 14:30:37 +0000 (23:30 +0900)
src/wild.c

index 7847f4c..dc29212 100644 (file)
@@ -763,7 +763,7 @@ static wilderness_grid w_letter[255];
 /*!
  * @brief w_info.txt¤Î¥Ç¡¼¥¿²òÀÏ /
  * Parse a sub-file of the "extra info"
- * @param buf
+ * @param buf Æɤ߼è¤Ã¤¿¥Ç¡¼¥¿¹Ô¤Î¥Ð¥Ã¥Õ¥¡
  * @param ymin Ì¤»ÈÍÑ
  * @param xmin ¹­°èÃÏ·Á¥Þ¥Ã¥×¤òÆɤ߹þ¤ß¤¿¤¤xºÂɸ¤Î³«»Ï°ÌÃÖ
  * @param ymax Ì¤»ÈÍÑ
@@ -913,8 +913,11 @@ errr parse_line_wilderness(char *buf, int ymin, int xmin, int ymax, int xmax, in
 }
 
 
-/*
+
+/*!
+ * @brief ¥²¡¼¥à³«»Ï»þ¤Ë³Æ¹ÓÌî¥Õ¥í¥¢¤ÎÍð¿ô¥·¡¼¥É¤ò»ØÄꤹ¤ë /
  * Generate the random seeds for the wilderness
+ * @return ¤Ê¤·
  */
 void seed_wilderness(void)
 {
@@ -937,8 +940,11 @@ void seed_wilderness(void)
  */
 typedef wilderness_type *wilderness_type_ptr;
 
-/*
+
+/*!
+ * @brief ¥²¡¼¥à³«»Ï»þ¤Î¹ÓÌî½é´ü²½¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize wilderness array
+ * @return ¥¨¥é¡¼¥³¡¼¥É
  */
 errr init_wilderness(void)
 {
@@ -957,7 +963,14 @@ errr init_wilderness(void)
        return 0;
 }
 
-
+/*!
+ * @brief ¹ÓÌî¤ÎÃÏÀªÀßÄê¤ò½é´ü²½¤¹¤ë /
+ * Initialize wilderness array
+ * @param terrain ½é´ü²½¤·¤¿¤¤ÃÏÀªID
+ * @param feat_global ´ðËÜŪ¤ÊÃÏ·ÁID
+ * @param fmt ÃÏÀªÆâ¤ÎÃÏ·Á¿ô¤ò»²¾È¤¹¤ë¤¿¤á¤ÎÆȼ«¥Õ¥©¡¼¥Þ¥Ã¥È
+ * @return ¤Ê¤·
+ */
 static void init_terrain_table(int terrain, s16b feat_global, cptr fmt, ...)
 {
        va_list vp;
@@ -1007,8 +1020,10 @@ static void init_terrain_table(int terrain, s16b feat_global, cptr fmt, ...)
 }
 
 
-/*
+/*!
+ * @brief ¹ÓÌî¤ÎÃÏÀªÀßÄêÁ´ÂΤò½é´ü²½¤¹¤ë¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Initialize arrays for wilderness terrains
+ * @return ¤Ê¤·
  */
 void init_wilderness_terrains(void)
 {
@@ -1085,7 +1100,11 @@ void init_wilderness_terrains(void)
                feat_mountain, MAX_FEAT_IN_TERRAIN - 8);
 }
 
-
+/*!
+ * @brief ¹ÓÌ¤é¹­°è¥Þ¥Ã¥×¤Ø¤ÎÀÚ¤êÂؤ¨½èÍý /
+ * Initialize arrays for wilderness terrains
+ * @return ÀÚ¤êÂؤ¨¤¬¹Ô¤ï¤ì¤¿¾ì¹ç¤ÏTRUE¤òÊÖ¤¹¡£
+ */
 bool change_wild_mode(void)
 {
        int i;