Fix Doxygen warning in mane.c.

diff --git a/src/mane.c b/src/mane.c
index a79bb02..2793bae 100644 (file)
--- a/src/mane.c
+++ b/src/mane.c
@@ -1,20 +1,26 @@
-/* File: mind.c */
-
-/*
- * 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.
+/*!
+ * @file mane.c
+ * @brief ¤â¤Î¤Þ¤Í¤Î½èÍý¼ÂÁõ / Imitation code
+ * @date 2014/01/14
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\n
+ * This software may be copied and distributed for educational, research,\n
+ * and not for profit purposes provided that this copyright and statement\n
+ * are included in all such copies.  Other copyrights may also apply.\n
+ * 2014 Deskull rearranged comment for Doxygen.\n
  */
 
-/* Purpose: Imitation code */
-
 #include "angband.h"
 
-
 static int damage;
 
+/*!
+ * @brief ¼õ¤±¼è¤Ã¤¿¥Ñ¥é¥á¡¼¥¿¤Ë±þ¤¸¤Æ¤â¤Î¤Þ¤Í¤Î¸ú²Ì¾ðÊó¤ò¤Þ¤È¤á¤¿¥Õ¥©¡¼¥Þ¥Ã¥È¤òÊÖ¤¹
+ * @param p ¾ðÊó¤òÊÖ¤¹Ê¸»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @param power ¤â¤Î¤Þ¤Í¤Î¸úÎϤμïÎà
+ * @param dam ¤â¤Î¤Þ¤Í¤Î°ÒÎÏ
+ * @return ¤Ê¤·
+ */
 static void mane_info(char *p, int power, int dam)
 {
        int plev = p_ptr->lev;
@@ -66,9 +72,13 @@ static void mane_info(char *p, int power, int dam)
 }
 
 
-/*
+/*!
+ * @brief ¤É¤Î¤â¤Î¤Þ¤Í¤òȯư¤¹¤ë¤«ÁªÂò¤¹¤ë½èÍý /
  * Allow user to choose a imitation.
- *
+ * @param sn ¼Â¹Ô¤·¤¿¤â¤Î¤Þ¤Í¤ÎID¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿¡Ê¥­¥ã¥ó¥»¥ë¤Ê¤É¤Î¾ì¹ç-1¤òÊÖ¤¹¡Ë
+ * @param baigaesi TRUE¤Ê¤é¤ÐÇÜÊÖ¤·¾å¤Î½èÍý¤È¤·¤Æ¹Ô¤¦
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
+ * @details
  * If a valid spell is chosen, saves it in '*sn' and returns TRUE
  * If the user hits escape, returns FALSE, and set '*sn' to -1
  * If there are no legal choices, returns FALSE, and sets '*sn' to -2
@@ -280,9 +290,11 @@ put_str("
 }
 
 
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'imitator'.
+/*!
+ * @brief ¤â¤Î¤Þ¤Í½èÍý¤Îȯư /
+ * do_cmd_cast calls this function if the player's class is 'imitator'.
+ * @param spell ȯư¤¹¤ë¥â¥ó¥¹¥¿¡¼¹¶·â¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
  */
 static bool use_mane(int spell)
 {
@@ -1269,9 +1281,22 @@ msg_print("
 }
 
 
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'imitator'.
+/*!
+ * @brief ¤â¤Î¤Þ¤Í¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * do_cmd_cast calls this function if the player's class is 'imitator'.
+ * @param baigaesi TRUE¤Ê¤é¤ÐÇÜÊÖ¤·¾å¤Î½èÍý¤È¤·¤Æ¹Ô¤¦
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
+ * @details
+ * If a valid spell is chosen, saves it in '*sn' and returns TRUE
+ * If the user hits escape, returns FALSE, and set '*sn' to -1
+ * If there are no legal choices, returns FALSE, and sets '*sn' to -2
+ *
+ * The "prompt" should be "cast", "recite", or "study"
+ * The "known" should be TRUE for cast/pray, FALSE for study
+ *
+ * nb: This function has a (trivial) display bug which will be obvious
+ * when you run it. It's probably easy to fix but I haven't tried,
+ * sorry.
  */
 bool do_cmd_mane(bool baigaesi)
 {