Add Doxygen comment to cmd6.c.

diff --git a/src/cmd6.c b/src/cmd6.c
index 68b1abd..a4cc5f9 100644 (file)
--- a/src/cmd6.c
+++ b/src/cmd6.c
@@ -1,19 +1,17 @@
 /*!
- *  @file cmd6.c
- *  @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¢¥¤¥Æ¥à¤Ë´Ø¤¹¤ë¥³¥Þ¥ó¥É¤Î¼ÂÁõ2 / Spell/Prayer commands
- *  @date 2014/01/02
- *  @author
+ * @file cmd6.c
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¢¥¤¥Æ¥à¤Ë´Ø¤¹¤ë¥³¥Þ¥ó¥É¤Î¼ÂÁõ2 / Spell/Prayer commands
+ * @date 2014/01/27
+ * @author
+ * <pre>
  * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
- *
  * This software may be copied and distributed for educational, research,
  * and not for profit purposes provided that this copyright and statement
  * are included in all such copies.  Other copyrights may also apply.
- */
-
-#include "angband.h"
-
-
-/*
+ * 2014 Deskull rearranged comment for Doxygen.\n
+ * </pre>
+ * @details
+ * <pre>
  * This file includes code for eating food, drinking potions,
  * reading scrolls, aiming wands, using staffs, zapping rods,
  * and activating artifacts.
@@ -51,9 +49,17 @@
  *
  * Note that food/potions/scrolls no longer use bit-flags for effects,
  * but instead use the "sval" (which is also used to sort the objects).
+ * </pre>
  */
 
+#include "angband.h"
 
+
+/*!
+ * @brief ¿©ÎÁ¤ò¿©¤Ù¤ë¥³¥Þ¥ó¥É¤Î¥µ¥Ö¥ë¡¼¥Á¥ó
+ * @param item ¿©¤Ù¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î½ê»ýÉÊID
+ * @return ¤Ê¤·
+ */
 static void do_cmd_eat_food_aux(int item)
 {
        int ident, lev;
@@ -633,8 +639,11 @@ msg_print("
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤ò¥×¥ì¥¤¥ä¡¼¤¬¿©¤Ù¤ë¤³¤È¤¬¤Ç¤­¤ë¤«¤òȽÄꤹ¤ë /
  * Hook to determine if an object is eatable
+ * @param o_ptr ȽÄꤷ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¿©¤Ù¤ë¤³¤È¤¬²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 static bool item_tester_hook_eatable(object_type *o_ptr)
 {
@@ -672,8 +681,10 @@ static bool item_tester_hook_eatable(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¿©ÎÁ¤ò¿©¤Ù¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Eat some food (from the pack or floor)
+ * @return ¤Ê¤·
  */
 void do_cmd_eat_food(void)
 {