OSDN Git Service

Add Doxygen comment to monster1.c.
authorDeskull <deskull@users.sourceforge.jp>
Sat, 15 Feb 2014 12:36:16 +0000 (21:36 +0900)
committerDeskull <deskull@users.sourceforge.jp>
Sat, 15 Feb 2014 12:36:16 +0000 (21:36 +0900)
src/monster1.c

index 14141ff..021f822 100644 (file)
@@ -1640,9 +1640,11 @@ static void roff_aux(int r_idx, int mode)
 }
 
 
-
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¾ðÊó¤Î¥Ø¥Ã¥À¤òµ­½Ò¤¹¤ë
  * Hack -- Display the "name" and "attr/chars" of a monster race
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @return ¤Ê¤·
  */
 void roff_top(int r_idx)
 {
@@ -1703,8 +1705,12 @@ void roff_top(int r_idx)
 
 
 
-/*
+/*!
+ * @brief  ¥â¥ó¥¹¥¿¡¼¾ðÊó¤Îɽ¼¨¤È¶¦¤Ë²èÌ̤ò°ì»þ¾Ãµî¤¹¤ë¥µ¥Ö¥ë¡¼¥Á¥ó /
  * Hack -- describe the given monster race at the top of the screen
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @param mode É½¼¨¥ª¥×¥·¥ç¥ó
+ * @return ¤Ê¤·
  */
 void screen_roff(int r_idx, int mode)
 {
@@ -1726,8 +1732,11 @@ void screen_roff(int r_idx, int mode)
 
 
 
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¾ðÊó¤Î¸½ºß¤Î¥¦¥£¥ó¥É¥¦¤Ëɽ¼¨¤¹¤ë /
  * Hack -- describe the given monster race in the current "term" window
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @return ¤Ê¤·
  */
 void display_roff(int r_idx)
 {
@@ -1753,9 +1762,12 @@ void display_roff(int r_idx)
 }
 
 
-
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¾ÜºÙ¾ðÊó¤ò¼«Æ°¥¹¥Ý¥¤¥é¡¼¸þ¤±¤Ë½ÐÎϤ¹¤ë /
  * Hack -- output description of the given monster race
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @param roff_func ½ÐÎϽèÍý¤ò¹Ô¤¦´Ø¿ô¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 void output_monster_spoiler(int r_idx, void (*roff_func)(byte attr, cptr str))
 {