OSDN Git Service

Add Doxygen comment to cmd6.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 27 Jan 2014 11:56:14 +0000 (11:56 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 27 Jan 2014 11:56:14 +0000 (11:56 +0000)
src/cmd6.c

index 35d28ea..ef474aa 100644 (file)
@@ -2347,7 +2347,15 @@ void do_cmd_read_scroll(void)
        do_cmd_read_scroll_aux(item, object_is_aware(o_ptr));
 }
 
-
+/*!
+ * @brief ¾ó¤Î¸ú²Ì¤òȯư¤¹¤ë
+ * @param sval ¥ª¥Ö¥¸¥§¥¯¥È¤Îsval
+ * @param use_charge »ÈÍѲó¿ô¤ò¾ÃÈñ¤·¤¿¤«¤É¤¦¤«¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
+ * @param powerful ¶¯ÎÏȯư¾å¤Î½èÍý¤Ê¤é¤ÐTRUE
+ * @param magic ËâÆ»¶ñ½Ñ¾å¤Î½èÍý¤Ê¤é¤ÐTRUE
+ * @param known È½ÌÀºÑ¤Ê¤é¤ÐTRUE
+ * @return È¯Æ°¤Ë¤è¤ê¸ú²ÌÆâÍƤ¬³ÎÄꤷ¤¿¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 static int staff_effect(int sval, bool *use_charge, bool powerful, bool magic, bool known)
 {
        int k;
@@ -2709,11 +2717,13 @@ msg_print("
        return ident;
 }
 
-/*
+/*!
+ * @brief ¾ó¤ò»È¤¦¥³¥Þ¥ó¥É¤Î¥µ¥Ö¥ë¡¼¥Á¥ó / 
  * Use a staff.                        -RAK-
- *
+ * @param item »È¤¦¥ª¥Ö¥¸¥§¥¯¥È¤Î½ê»ýÉÊID
+ * @return ¤Ê¤·
+ * @details
  * One charge of one staff disappears.
- *
  * Hack -- staffs of identify can be "cancelled".
  */
 static void do_cmd_use_staff_aux(int item)
@@ -2902,7 +2912,10 @@ static void do_cmd_use_staff_aux(int item)
        }
 }
 
-
+/*!
+ * @brief ¾ó¤ò»È¤¦¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @return ¤Ê¤·
+ */
 void do_cmd_use_staff(void)
 {
        int  item;
@@ -2930,7 +2943,14 @@ void do_cmd_use_staff(void)
        do_cmd_use_staff_aux(item);
 }
 
-
+/*!
+ * @brief ËâË¡ËÀ¤Î¸ú²Ì¤òȯư¤¹¤ë
+ * @param sval ¥ª¥Ö¥¸¥§¥¯¥È¤Îsval
+ * @param dir È¯Æ°¤ÎÊý¸þID
+ * @param powerful ¶¯ÎÏȯư¾å¤Î½èÍý¤Ê¤é¤ÐTRUE
+ * @param magic ËâÆ»¶ñ½Ñ¾å¤Î½èÍý¤Ê¤é¤ÐTRUE
+ * @return È¯Æ°¤Ë¤è¤ê¸ú²ÌÆâÍƤ¬³ÎÄꤷ¤¿¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 static int wand_effect(int sval, int dir, bool powerful, bool magic)
 {
        int ident = FALSE;
@@ -3229,26 +3249,26 @@ msg_print("
        return ident;
 }
 
-
-/*
+/*!
+ * @brief ËâË¡ËÀ¤ò»È¤¦¥³¥Þ¥ó¥É¤Î¥µ¥Ö¥ë¡¼¥Á¥ó / 
  * Aim a wand (from the pack or floor).
- *
+ * @param item »È¤¦¥ª¥Ö¥¸¥§¥¯¥È¤Î½ê»ýÉÊID
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * Use a single charge from a single item.
  * Handle "unstacking" in a logical manner.
- *
  * For simplicity, you cannot use a stack of items from the
  * ground.  This would require too much nasty code.
- *
  * There are no wands which can "destroy" themselves, in the inventory
  * or on the ground, so we can ignore this possibility.  Note that this
  * required giving "wand of wonder" the ability to ignore destruction
  * by electric balls.
- *
  * All wands can be "cancelled" at the "Direction?" prompt for free.
- *
  * Note that the basic "bolt" wands do slightly less damage than the
  * basic "bolt" rods, but the basic "ball" wands do the same damage
  * as the basic "ball" rods.
+ * </pre>
  */
 static void do_cmd_aim_wand_aux(int item)
 {
@@ -3405,7 +3425,10 @@ static void do_cmd_aim_wand_aux(int item)
        }
 }
 
-
+/*!
+ * @brief ËâË¡ËÀ¤ò»È¤¦¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @return ¤Ê¤·
+ */
 void do_cmd_aim_wand(void)
 {
        int     item;