Fix Doxygen warning in mind.c.

diff --git a/src/mind.c b/src/mind.c
index 4e5788f..bb879a1 100644 (file)
--- a/src/mind.c
+++ b/src/mind.c
@@ -1,19 +1,25 @@
-/* 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 mind.c
+ * @brief ³Æ¿¦¶È¤ÎÆü쵻ǽ¼ÂÁõ / Blue magic
+ * @date 2014/01/15
+ * @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
+ * 2005 henkma \n
+ * 2014 Deskull rearranged comment for Doxygen.\n
+ * @details
+ * mind.c¤È¤¢¤ë¤¬¼ÂºÝ¤Ë¤ÏĶǽÎϼԡ¢Îýµ¤½Ñ»Õ¡¢¶¸Àï»Î¡¢¶À»È¤¤¡¢Ç¦¼Ô¤Þ¤Ç¤Î
+ * Æü쵻ǽ¤ò·¤¨¤Æ¼ÂÁõ¤·¤Æ¤¤¤ë¡£
  */
 
-/* Purpose: Mindcrafter code */
+
 
 #include "angband.h"
 #include "mindtips.h"
 
-
+/*! Æü쵻ǽ¤Î°ìÍ÷¥Æ¡¼¥Ö¥ë */
 mind_power mind_powers[5] =
 {
   {
@@ -283,7 +289,13 @@ mind_power mind_powers[5] =
   },
 };
 
-
+/*!
+ * @brief Æü쵻ǽ¤Î¸ú²Ì¾ðÊó¤ò¤Þ¤È¤á¤¿¥Õ¥©¡¼¥Þ¥Ã¥È¤òÊÖ¤¹
+ * @param p ¾ðÊó¤òÊÖ¤¹Ê¸»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @param use_mind ¿¦¶ÈËè¤ÎÆü쵻ǽID
+ * @param power ¥â¥ó¥¹¥¿¡¼ËâË¡¤ÎID
+ * @return ¤Ê¤·
+ */
 void mindcraft_info(char *p, int use_mind, int power)
 {
 #ifdef JP
@@ -419,19 +431,23 @@ void mindcraft_info(char *p, int use_mind, int power)
        }
 }
 
-  /*
+/*!
+ * @brief »ÈÍѲÄǽ¤ÊÆü쵻ǽ¤òÁªÂò¤¹¤ë /
  * Allow user to choose a mindcrafter power.
- *
- * 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.
+ * @param sn ÁªÂò¤·¤¿Æü쵻ǽID¡¢¥­¥ã¥ó¥»¥ë¤Î¾ì¹ç-1¡¢ÉÔÀµ¤ÊÁªÂò¤Î¾ì¹ç-2¤òÊÖ¤¹
+ * @param only_browse °ìÍ÷¤ò¸«¤ë¤À¤±¤Î¾ì¹çTRUE¤òÊÖ¤¹
+ * @return ȯư²Äǽ¤ÊËâË¡¤òÁªÂò¤·¤¿¾ì¹çTRUE¡¢¥­¥ã¥ó¥»¥ë½èÍý¤«ÉÔÀµ¤ÊÁªÂò¤¬¹Ô¤ï¤ì¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
+ * @details
+ * If a valid spell is chosen, saves it in '*sn' and returns TRUE\n
+ * If the user hits escape, returns FALSE, and set '*sn' to -1\n
+ * If there are no legal choices, returns FALSE, and sets '*sn' to -2\n
+ *\n
+ * The "prompt" should be "cast", "recite", or "study"\n
+ * The "known" should be TRUE for cast/pray, FALSE for study\n
+ *\n
+ * nb: This function has a (trivial) display bug which will be obvious\n
+ * when you run it. It's probably easy to fix but I haven't tried,\n
+ * sorry.\n
  */
   static int get_mind_power(int *sn, bool only_browse)
     {
@@ -830,10 +846,11 @@ put_str(format("Lv   %s   Fail Info", ((use_mind == MIND_BERSERKER) || (use_mind
        return (TRUE);
 }
 
-
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'mindcrafter'.
+/*!
+ * @brief ĶǽÎϤÎȯư /
+ * do_cmd_cast calls this function if the player's class is 'mindcrafter'.
+ * @param spell ȯư¤¹¤ëÆü쵻ǽ¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
  */
 static bool cast_mindcrafter_spell(int spell)
 {
@@ -1032,10 +1049,11 @@ msg_print("
        return TRUE;
 }
 
-
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'ForceTrainer'.
+/*!
+ * @brief Îýµ¤½Ñ¤Îȯư /
+ * do_cmd_cast calls this function if the player's class is 'ForceTrainer'.
+ * @param spell ȯư¤¹¤ëÆü쵻ǽ¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
  */
 static bool cast_force_spell(int spell)
 {
@@ -1227,8 +1245,11 @@ msg_print("
        return TRUE;
 }
 
-/* by henkma */
-/* calculate mirrors */
+
+/*!
+ * @brief ¸½ºß¥Õ¥í¥¢¤Ë¸ºß¤·¤Æ¤¤¤ë¶À¤Î¿ô¤ò¿ô¤¨¤ë / calculate mirrors
+ * @return ¶À¤ÎËç¿ô
+ */
 static int number_of_mirrors( void )
 {
   int x,y;
@@ -1241,6 +1262,12 @@ static int number_of_mirrors( void )
   return val;
 }
 
+/*!
+ * @brief ¶ÀËâË¡¤Îȯư /
+ * do_cmd_cast calls this function if the player's class is 'Mirror magic'.
+ * @param spell ȯư¤¹¤ëÆü쵻ǽ¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
+ */
 static bool cast_mirror_spell(int spell)
 {
        int             dir;
@@ -1409,10 +1436,11 @@ msg_print("
        return TRUE;
 }
 
-
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'berserker'.
+/*!
+ * @brief Åܤê¤Îȯư /
+ * do_cmd_cast calls this function if the player's class is 'berserker'.
+ * @param spell ȯư¤¹¤ëÆü쵻ǽ¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
  */
 static bool cast_berserk_spell(int spell)
 {
@@ -1495,11 +1523,11 @@ msg_print("
        return TRUE;
 }
 
-
-
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'ninja'.
+/*!
+ * @brief Ǧ½Ñ¤Îȯư /
+ * do_cmd_cast calls this function if the player's class is 'ninja'.
+ * @param spell ȯư¤¹¤ëÆü쵻ǽ¤ÎID
+ * @return ½èÍý¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
  */
 static bool cast_ninja_spell(int spell)
 {
@@ -1773,11 +1801,9 @@ msg_print("
        return TRUE;
 }
 
-
-
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'mindcrafter'.
+/*!
+ * @brief Æü쵻ǽ¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
+ * @return ¤Ê¤·
  */
 void do_cmd_mind(void)
 {
@@ -2164,9 +2190,9 @@ msg_print("
 }
 
 
-/*
- * do_cmd_cast calls this function if the player's class
- * is 'mindcrafter'.
+/*!
+ * @brief ¸½ºß¥×¥ì¥¤¥ä¡¼¤¬»ÈÍѲÄǽ¤ÊÆü쵻ǽ¤Î°ìÍ÷ɽ¼¨ /
+ * @return ¤Ê¤·
  */
 void do_cmd_mind_browse(void)
 {