• R/O
  • HTTP
  • SSH
  • HTTPS

hengband: Commit

変愚蛮怒のメインリポジトリです


Commit MetaInfo

Revision0cdfaff7d7145a07d4cc41527905395c90fcfabd (tree)
Time2014-02-14 23:30:37
AuthorDeskull <deskull@user...>
CommiterDeskull

Log Message

Add Doxygen comments to wild.c.

Change Summary

Incremental Difference

--- a/src/wild.c
+++ b/src/wild.c
@@ -763,7 +763,7 @@ static wilderness_grid w_letter[255];
763763 /*!
764764 * @brief w_info.txtのデータ解析 /
765765 * Parse a sub-file of the "extra info"
766- * @param buf
766+ * @param buf 読み取ったデータ行のバッファ
767767 * @param ymin 未使用
768768 * @param xmin 広域地形マップを読み込みたいx座標の開始位置
769769 * @param ymax 未使用
@@ -913,8 +913,11 @@ errr parse_line_wilderness(char *buf, int ymin, int xmin, int ymax, int xmax, in
913913 }
914914
915915
916-/*
916+
917+/*!
918+ * @brief ゲーム開始時に各荒野フロアの乱数シードを指定する /
917919 * Generate the random seeds for the wilderness
920+ * @return なし
918921 */
919922 void seed_wilderness(void)
920923 {
@@ -937,8 +940,11 @@ void seed_wilderness(void)
937940 */
938941 typedef wilderness_type *wilderness_type_ptr;
939942
940-/*
943+
944+/*!
945+ * @brief ゲーム開始時の荒野初期化メインルーチン /
941946 * Initialize wilderness array
947+ * @return エラーコード
942948 */
943949 errr init_wilderness(void)
944950 {
@@ -957,7 +963,14 @@ errr init_wilderness(void)
957963 return 0;
958964 }
959965
960-
966+/*!
967+ * @brief 荒野の地勢設定を初期化する /
968+ * Initialize wilderness array
969+ * @param terrain 初期化したい地勢ID
970+ * @param feat_global 基本的な地形ID
971+ * @param fmt 地勢内の地形数を参照するための独自フォーマット
972+ * @return なし
973+ */
961974 static void init_terrain_table(int terrain, s16b feat_global, cptr fmt, ...)
962975 {
963976 va_list vp;
@@ -1007,8 +1020,10 @@ static void init_terrain_table(int terrain, s16b feat_global, cptr fmt, ...)
10071020 }
10081021
10091022
1010-/*
1023+/*!
1024+ * @brief 荒野の地勢設定全体を初期化するメインルーチン /
10111025 * Initialize arrays for wilderness terrains
1026+ * @return なし
10121027 */
10131028 void init_wilderness_terrains(void)
10141029 {
@@ -1085,7 +1100,11 @@ void init_wilderness_terrains(void)
10851100 feat_mountain, MAX_FEAT_IN_TERRAIN - 8);
10861101 }
10871102
1088-
1103+/*!
1104+ * @brief 荒野から広域マップへの切り替え処理 /
1105+ * Initialize arrays for wilderness terrains
1106+ * @return 切り替えが行われた場合はTRUEを返す。
1107+ */
10891108 bool change_wild_mode(void)
10901109 {
10911110 int i;
Show on old repository browser