Add Doxygen comment to cmd6.c.

diff --git a/doxygen/Hengband.doxyfile b/doxygen/Hengband.doxyfile
index df2f6c6..2846767 100644 (file)
--- a/doxygen/Hengband.doxyfile
+++ b/doxygen/Hengband.doxyfile
@@ -2169,7 +2169,7 @@ INCLUDED_BY_GRAPH      = YES
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CALL_GRAPH             = NO
+CALL_GRAPH             = YES
 
 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
 # dependency graph for every global function or class method.

diff --git a/src/cmd6.c b/src/cmd6.c
index a4cc5f9..35d28ea 100644 (file)
--- a/src/cmd6.c
+++ b/src/cmd6.c
@@ -716,8 +716,11 @@ void do_cmd_eat_food(void)
 }
 
 
-/*
+/*!
+ * @brief Ìô¤ò°û¤à¥³¥Þ¥ó¥É¤Î¥µ¥Ö¥ë¡¼¥Á¥ó /
  * Quaff a potion (from the pack or the floor)
+ * @param item °û¤àÌô¥ª¥Ö¥¸¥§¥¯¥È¤Î½ê»ýÉÊID
+ * @return ¤Ê¤·
  */
 static void do_cmd_quaff_potion_aux(int item)
 {
@@ -1531,8 +1534,11 @@ msg_print("
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤ò¥×¥ì¥¤¥ä¡¼¤¬°û¤à¤³¤È¤¬¤Ç¤­¤ë¤«¤òȽÄꤹ¤ë /
  * Hook to determine if an object can be quaffed
+ * @param o_ptr ȽÄꤷ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return °û¤à¤³¤È¤¬²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 static bool item_tester_hook_quaff(object_type *o_ptr)
 {
@@ -1543,13 +1549,14 @@ static bool item_tester_hook_quaff(object_type *o_ptr)
                if (o_ptr->tval == TV_FLASK && o_ptr->sval == SV_FLASK_OIL)
                        return TRUE;
        }
-
        return FALSE;
 }
 
 
-/*
+/*!
+ * @brief Ìô¤ò°û¤à¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Quaff some potion (from the pack or floor)
+ * @return ¤Ê¤·
  */
 void do_cmd_quaff_potion(void)
 {
@@ -1580,12 +1587,17 @@ void do_cmd_quaff_potion(void)
 }
 
 
-/*
+/*!
+ * @brief ´¬Êª¤òÆɤॳ¥Þ¥ó¥É¤Î¥µ¥Ö¥ë¡¼¥Á¥ó
  * Read a scroll (from the pack or floor).
- *
+ * @param item Æɤ४¥Ö¥¸¥§¥¯¥È¤Î½ê»ýÉÊID
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * Certain scrolls can be "aborted" without losing the scroll.  These
  * include scrolls with no effects but recharge or identify, which are
  * cancelled before use.  XXX Reading them still takes a turn, though.
+ * </pre>
  */
 static void do_cmd_read_scroll_aux(int item, bool known)
 {
@@ -2242,9 +2254,11 @@ take_hit(DAMAGE_NOESCAPE, 111+randint1(111), "
        }
 }
 
-
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤ò¥×¥ì¥¤¥ä¡¼¤¬Æɤळ¤È¤¬¤Ç¤­¤ë¤«¤òȽÄꤹ¤ë /
  * Hook to determine if an object is readable
+ * @param o_ptr ȽÄꤷ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return Æɤळ¤È¤¬²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 static bool item_tester_hook_readable(object_type *o_ptr)
 {
@@ -2254,7 +2268,11 @@ static bool item_tester_hook_readable(object_type *o_ptr)
        return (FALSE);
 }
 
-
+/*!
+ * @brief Æɤॳ¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * Eat some food (from the pack or floor)
+ * @return ¤Ê¤·
+ */
 void do_cmd_read_scroll(void)
 {
        object_type *o_ptr;