OSDN Git Service

Add Doxygen comment to cmd4.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 24 Jan 2014 12:18:57 +0000 (12:18 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 24 Jan 2014 12:18:57 +0000 (12:18 +0000)
src/cmd4.c

index 08596e5..3f8c6f9 100644 (file)
@@ -315,8 +315,10 @@ static bool open_auto_dump(cptr buf, cptr mark)
        return TRUE;
 }
 
-/*
- *  Append foot part and close auto dump.
+/*!
+ * @brief prf¥Õ¥¡¥¤¥ë¤ò¥Õ¥¡¥¤¥ë¥¯¥í¡¼¥º¤¹¤ë /
+ * Append foot part and close auto dump.
+ * @return ¤Ê¤·
  */
 static void close_auto_dump(void)
 {
@@ -344,8 +346,11 @@ static void close_auto_dump(void)
 
 
 #ifndef JP
-/*
- * Return suffix of ordinal number
+
+/*!
+ * @brief Return suffix of ordinal number
+ * @num number
+ * @return pointer of suffix string.
  */
 cptr get_ordinal_number_suffix(int num)
 {
@@ -365,8 +370,13 @@ cptr get_ordinal_number_suffix(int num)
 #endif
 
 
-/*
- *   Take note to the diary.
+/*!
+ * @brief Æüµ­¤Ë¥á¥Ã¥»¡¼¥¸¤òÄɲ乤ë /
+ * Take note to the diary.
+ * @param type Æüµ­ÆâÍƤÎID
+ * @param num Æüµ­ÆâÍƤÎID¤Ë±þ¤¸¤¿¿ôÃÍ
+ * @param note Æüµ­ÆâÍƤÎID¤Ë±þ¤¸¤¿Ê¸»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @return ¥¨¥é¡¼ID
  */
 errr do_cmd_write_nikki(int type, int num, cptr note)
 {
@@ -887,6 +897,10 @@ errr do_cmd_write_nikki(int type, int num, cptr note)
 
 #define MAX_SUBTITLE (sizeof(subtitle)/sizeof(subtitle[0]))
 
+/*!
+ * @brief Æüµ­¤Î¥¿¥¤¥È¥ëɽµ­¤ÈÆâÍƽÐÎÏ /
+ * @return ¤Ê¤·
+ */
 static void do_cmd_disp_nikki(void)
 {
        char nikki_title[256];
@@ -986,6 +1000,10 @@ static void do_cmd_disp_nikki(void)
        show_file(FALSE, buf, nikki_title, -1, 0);
 }
 
+/*!
+ * @brief Æüµ­¤ËǤ°Õ¤ÎÆâÍƤòɽµ­¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @return ¤Ê¤·
+ */
 static void do_cmd_bunshou(void)
 {
        char tmp[80] = "\0";
@@ -1003,6 +1021,10 @@ static void do_cmd_bunshou(void)
        }
 }
 
+/*!
+ * @brief ºÇ¸å¤Ë¼èÆÀ¤·¤¿¥¢¥¤¥Æ¥à¤Î¾ðÊó¤òÆüµ­¤ËÄɲ乤ë¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @return ¤Ê¤·
+ */
 static void do_cmd_last_get(void)
 {
        char buf[256];