OSDN Git Service

Add Doxygen comment to cmd1.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 21 Jan 2014 12:07:36 +0000 (12:07 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 21 Jan 2014 12:07:36 +0000 (12:07 +0000)
src/cmd1.c

index b9fb3ca..cbaa43d 100644 (file)
@@ -2941,6 +2941,14 @@ bool py_attack(int y, int x, int mode)
 }
 
 
+/*!
+ * @brief ¥Ñ¥¿¡¼¥ó¤Ë¤è¤ë°ÜÆ°À©¸Â½èÍý
+ * @param c_y ¥×¥ì¥¤¥ä¡¼¤Î°ÜÆ°¸µYºÂɸ
+ * @param c_x ¥×¥ì¥¤¥ä¡¼¤Î°ÜÆ°¸µXºÂɸ
+ * @param n_y ¥×¥ì¥¤¥ä¡¼¤Î°ÜÆ°ÀèYºÂɸ
+ * @param n_x ¥×¥ì¥¤¥ä¡¼¤Î°ÜÆ°ÀèXºÂɸ
+ * @return °ÜÆ°½èÍý¤¬²Äǽ¤Ç¤¢¤ë¾ì¹ç¡Ê²Äǽ¤Ê¾ì¹ç¤ËÁªÂò¤·¤¿¾ì¹ç¡ËTRUE¤òÊÖ¤¹¡£
+ */
 bool pattern_seq(int c_y, int c_x, int n_y, int n_x)
 {
        feature_type *cur_f_ptr = &f_info[cave[c_y][c_x].feat];
@@ -3093,6 +3101,12 @@ bool pattern_seq(int c_y, int c_x, int n_y, int n_x)
 }
 
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬ÃÏ·ÁƧÇ˲Äǽ¤«¤òÊÖ¤¹
+ * @param feature È½Äꤷ¤¿¤¤ÃÏ·ÁID
+ * @param mode °ÜÆ°¤Ë´Ø¤¹¤ë¥ª¥×¥·¥ç¥ó¥Õ¥é¥°
+ * @return °ÜÆ°²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 bool player_can_enter(s16b feature, u16b mode)
 {
        feature_type *f_ptr = &f_info[feature];
@@ -3116,8 +3130,12 @@ bool player_can_enter(s16b feature, u16b mode)
 }
 
 
-/*
- * Move the player
+/*!
+ * @brief °ÜÆ°¤Ëȼ¤¦¥×¥ì¥¤¥ä¡¼¤Î¥¹¥Æ¡¼¥¿¥¹ÊѲ½½èÍý
+ * @param ny °ÜÆ°ÀèYºÂɸ
+ * @param nx °ÜÆ°ÀèXºÂɸ
+ * @param mpe_mode °ÜÆ°¥ª¥×¥·¥ç¥ó¥Õ¥é¥°
+ * @return ¥×¥ì¥¤¥ä¡¼¤¬»àË´¤ä¥Õ¥í¥¢Î¥Ã¦¤ò¹Ô¤ï¤º¡¢¼ÂºÝ¤Ë°ÜÆ°¤¬²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 bool move_player_effect(int ny, int nx, u32b mpe_mode)
 {
@@ -3345,7 +3363,11 @@ bool move_player_effect(int ny, int nx, u32b mpe_mode)
        return player_bold(ny, nx) && !p_ptr->is_dead && !p_ptr->leaving;
 }
 
-
+/*!
+ * @brief ³ºÅöÃÏ·Á¤Î¥È¥é¥Ã¥×¤¬¥×¥ì¥¤¥ä¡¼¤Ë¤È¤Ã¤Æ̵¸ú¤«¤É¤¦¤«¤òȽÄꤷ¤ÆÊÖ¤¹
+ * @param feat ÃÏ·ÁID
+ * @return ¥È¥é¥Ã¥×¤¬¼«Æ°Åª¤Ë̵¸ú¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 bool trap_can_be_ignored(int feat)
 {
        feature_type *f_ptr = &f_info[feat];