Add Doxygen comment to floor.c.

diff --git a/src/floors.c b/src/floors.c
index 7c8fd79..a53aff1 100644 (file)
--- a/src/floors.c
+++ b/src/floors.c
@@ -229,9 +229,11 @@ static void kill_saved_floor(saved_floor_type *sf_ptr)
 }
 
 
-/*
- * Initialize new saved floor and get its floor id.  If number of
- * saved floors are already MAX_SAVED_FLOORS, kill the oldest one.
+/*!
+ * @brief ¿·µ¬¤ËÍøÍѲÄǽ¤ÊÊݸ¥Õ¥í¥¢¤òÊÖ¤¹ / Initialize new saved floor and get its floor id.
+ * @return ÍøÍѲÄǽ¤ÊÊݸ¥Õ¥í¥¢ID
+ * @details
+ * If number of saved floors are already MAX_SAVED_FLOORS, kill the oldest one.
  */
 s16b get_new_floor_id(void)
 {
@@ -297,17 +299,19 @@ s16b get_new_floor_id(void)
 }
 
 
-/*
- * Prepare mode flags of changing floor
+/*!
+ * @brief ¥Õ¥í¥¢ÀÚ¤êÂؤ¨»þ¤Î½èÍý¥Õ¥é¥°¤òÄɲ乤ë / Prepare mode flags of changing floor
+ * @param mode Äɲä·¤¿¤¤½ê»ý¥Õ¥é¥°
+ * @return ¤Ê¤·
  */
 void prepare_change_floor_mode(u32b mode)
 {
        change_floor_mode |= mode;
 }
 
-
-/*
- * Builds the dead end
+/*!
+ * @brief ³¬ÃÊ°ÜÆ°Àè¤Î¥Õ¥í¥¢¤¬À¸À®¤Ç¤­¤Ê¤¤»þ¤Ë´Êñ¤Ê¹Ô¤­»ß¤Þ¤ê¥Þ¥Ã¥×¤òºîÀ®¤¹¤ë / Builds the dead end
+ * @return ¤Ê¤·
  */
 static void build_dead_end(void)
 {
@@ -344,14 +348,13 @@ static void build_dead_end(void)
 }
 
 
-/* Maximum number of preservable pets */
-#define MAX_PARTY_MON 21
-
-static monster_type party_mon[MAX_PARTY_MON];
 
+#define MAX_PARTY_MON 21 /*!< ¥Õ¥í¥¢°ÜÆ°»þ¤ËÀè¤Î¥Õ¥í¥¢¤ËÏ¢¤ì¤Æ¹Ô¤±¤ë¥Ú¥Ã¥È¤ÎºÇÂç¿ô Maximum number of preservable pets */
+static monster_type party_mon[MAX_PARTY_MON]; /*!< ¥Õ¥í¥¢°ÜÆ°¤ËÊݸ¤¹¤ë¥Ú¥Ã¥È¥â¥ó¥¹¥¿¡¼¤ÎÇÛÎó */
 
-/*
- * Preserve_pets
+/*!
+ * @brief ¥Õ¥í¥¢°ÜÆ°»þ¤Î¥Ú¥Ã¥ÈÊݸ½èÍý / Preserve_pets
+ * @return ¤Ê¤·
  */
 static void preserve_pet(void)
 {
@@ -485,8 +488,10 @@ static void preserve_pet(void)
 }
 
 
-/*
- * Pre-calculate the racial counters of preserved pets
+/*!
+ * @brief ¥Õ¥í¥¢°ÜÆ°»þ¤Ë¥Ú¥Ã¥È¤òȼ¤Ã¤¿¾ì¹ç¤Î½àÈ÷½èÍý / Pre-calculate the racial counters of preserved pets
+ * @return ¤Ê¤·
+ * @details
  * To prevent multiple generation of unique monster who is the minion of player
  */
 void precalc_cur_num_of_pet(void)
@@ -507,9 +512,9 @@ void precalc_cur_num_of_pet(void)
        }
 }
 
-
-/*
- * Place preserved pet monsters on new floor
+/*!
+ * @brief °ÜÆ°Àè¤Î¥Õ¥í¥¢¤Ëȼ¤Ã¤¿¥Ú¥Ã¥È¤òÇÛÃÖ¤¹¤ë / Place preserved pet monsters on new floor
+ * @return ¤Ê¤·
  */
 static void place_pet(void)
 {
@@ -624,12 +629,14 @@ static void place_pet(void)
 }
 
 
-/*
- * Hack -- Update location of unique monsters and artifacts
- *
- * The r_ptr->floor_id and a_ptr->floor_id are not updated correctly
- * while new floor creation since dungeons may be re-created by
- * auto-scum option.
+/*!
+ * @brief ¥æ¥Ë¡¼¥¯¥â¥ó¥¹¥¿¡¼¤ä¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î½êºß¥Õ¥í¥¢¤ò¹¹¿·¤¹¤ë / Hack -- Update location of unique monsters and artifacts
+ * @param cur_floor_id ¸½ºß¤Î¥Õ¥í¥¢ID
+ * @return ¤Ê¤·
+ * @details 
+ * The r_ptr->floor_id and a_ptr->floor_id are not updated correctly\n
+ * while new floor creation since dungeons may be re-created by\n
+ * auto-scum option.\n
  */
 static void update_unique_artifact(s16b cur_floor_id)
 {
@@ -672,9 +679,9 @@ static void update_unique_artifact(s16b cur_floor_id)
 }
 
 
-/*
- * When a monster is at a place where player will return,
- * Get out of the my way!
+/*!
+ * @brief ¥Õ¥í¥¢°ÜÆ°»þ¡¢¥×¥ì¥¤¥ä¡¼¤Î°ÜÆ°Àè¥â¥ó¥¹¥¿¡¼¤¬´û¤Ë¤¤¤¿¾ì¹ç¥é¥ó¥À¥à¤Ê¶áÎ٤˰ÜÆ°¤µ¤»¤ë / When a monster is at a place where player will return,
+ * @return ¤Ê¤·
  */
 static void get_out_monster(void)
 {
@@ -741,20 +748,16 @@ static void get_out_monster(void)
        }
 }
 
-
-/*
- * Is this feature has special meaning (except floor_id) with c_ptr->special?
+/*!
+ * ¥Þ¥¹¹½Â¤ÂΤÎspecialÍ×ÁǤòÍøÍѤ¹¤ëÃÏ·Á¤«¤É¤¦¤«¤òȽÄꤹ¤ë¥Þ¥¯¥í / Is this feature has special meaning (except floor_id) with c_ptr->special?
  */
 #define feat_uses_special(F) (have_flag(f_info[(F)].flags, FF_SPECIAL))
 
 
-/*
- * Virtually teleport onto the stairs that is connecting between two
- * floors.
- *
- * Teleport level spell and trap doors will always lead the player to
- * the one of the floors connected by the one of the stairs in the
- * current floor.
+/*!
+ * @brief ¿·¥Õ¥í¥¢¤Ë°ÜÆ°¸µ¥Õ¥í¥¢¤Ë·Ò¤¬¤ë³¬ÃʤòÇÛÃÖ¤¹¤ë / Virtually teleport onto the stairs that is connecting between two floors.
+ * @param sf_ptr °ÜÆ°¸µ¤ÎÊݸ¥Õ¥í¥¢¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void locate_connected_stairs(saved_floor_type *sf_ptr)
 {