Add Doxygen comment to racial.c.

diff --git a/src/racial.c b/src/racial.c
index 4e0468b..b5f69a8 100644 (file)
--- a/src/racial.c
+++ b/src/racial.c
@@ -12,7 +12,7 @@
 
 #include "angband.h"
 
-/*
+/*!
  * @brief ÂоݤΥ¢¥¤¥Æ¥à¤¬Ìð¤ä¥¯¥í¥¹¥Ü¥¦¤ÎÌð¤ÎºàÎÁ¤Ë¤Ê¤ë¤«¤òÊÖ¤¹¡£/
  * Hook to determine if an object is contertible in an arrow/bolt
  * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿¡£
@@ -27,7 +27,7 @@ static bool item_tester_hook_convertible(object_type *o_ptr)
        return (FALSE);
 }
 
-/*
+/*!
  * @brief ¥ì¥¤¥·¥ã¥ë¡ÖÃÆ/Ìð¤ÎÀ½Â¤¡×½èÍý / do_cmd_cast calls this function if the player's class is 'archer'.
  * Hook to determine if an object is contertible in an arrow/bolt
  * @return À½Â¤¤ò¼ÂºÝ¤Ë¹Ô¤Ã¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹
@@ -307,7 +307,7 @@ static bool do_cmd_archer(void)
        return TRUE;
 }
 
-/*
+/*!
  * @brief ËâÆ»¶ñ½Ñ»Õ¤ÎËâÎϼè¤ê¹þ¤ß½èÍý
  * @return ¼è¤ê¹þ¤ß¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹
  */
@@ -437,7 +437,7 @@ s = "
        return TRUE;
 }
 
-/*
+/*!
  * @brief ËâË¡·Ï¥³¥Þ¥ó¥É¤ò¼Â¹Ô¤Ç¤­¤ë¤«¤ÎȽÄê¤òÊÖ¤¹
  * @return ËâË¡·Ï¥³¥Þ¥ó¥É¤ò»ÈÍѲÄǽ¤Ê¤éTRUE¡¢ÉÔ²Äǽ¤Ê¤é¤ÐÍýͳ¤ò¥á¥Ã¥»¡¼¥¸É½¼¨¤·¤ÆFALSE¤òÊÖ¤¹¡£
  */
@@ -475,7 +475,7 @@ static bool can_do_cmd_cast(void)
                return TRUE;
 }
 
-/*
+/*!
  * @brief ½¤¹ÔÁΤ齤¨ÀßÄê½èÍý
  * @return ¹½¤¨¤òÊѲ½¤µ¤»¤¿¤éTRUE¡¢¹½¤¨ÉÔǽ¤«¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹¡£
  */
@@ -593,7 +593,7 @@ static bool choose_kamae(void)
        return TRUE;
 }
 
-/*
+/*!
  * @brief ·õ½Ñ²È¤Î·¿ÀßÄê½èÍý
  * @return ·¿¤òÊѲ½¤µ¤»¤¿¤éTRUE¡¢·¿¤Î¹½¤¨ÉÔǽ¤«¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹¡£
  */
@@ -737,8 +737,14 @@ static bool choose_kata(void)
 }
 
 
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¾ðÊó¤Îtypedef
+ */
 typedef struct power_desc_type power_desc_type;
 
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¾ðÊó¤Î¹½Â¤ÂÎÄêµÁ
+ */
 struct power_desc_type
 {
        char name[40];
@@ -750,8 +756,10 @@ struct power_desc_type
 };
 
 
-/*
- * Returns the chance to activate a racial power/mutation
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¤ÎȯưÀ®¸ùΨ¤ò·×»»¤¹¤ë / Returns the chance to activate a racial power/mutation
+ * @param pd_ptr ȯư¤·¤¿¤¤¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¾ðÊó¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return À®¸ùΨ(%)¤òÊÖ¤¹
  */
 static int racial_chance(power_desc_type *pd_ptr)
 {
@@ -804,9 +812,12 @@ static int racial_chance(power_desc_type *pd_ptr)
 
 static int  racial_cost;
 
-/*
- * Note: return value indicates that we have succesfully used the power
- * 1: Succeeded, 0: Cancelled, -1: Failed
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¤Îȯư¤ÎȽÄê½èÍý
+ * @param pd_ptr ȯư¤·¤¿¤¤¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¾ðÊó¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return
+ * ȯưÀ®¸ù¤Ê¤é¤Ð1¡¢È¯Æ°¼ºÇԤʤé¤Ð-1¡¢¥­¥ã¥ó¥»¥ë¤Ê¤é¤Ð0¤òÊÖ¤¹¡£
+ * return value indicates that we have succesfully used the power 1: Succeeded, 0: Cancelled, -1: Failed
  */
 static int racial_aux(power_desc_type *pd_ptr)
 {
@@ -898,15 +909,21 @@ static int racial_aux(power_desc_type *pd_ptr)
        return -1;
 }
 
-
-
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼È¯Æ°»þ¤Ë¸ý¤ò»È¤¦·Ñ³Ū¤Ê±Ó¾§½èÍý¤òÃæÃǤ¹¤ë
+ * @return ¤Ê¤·
+ */
 void ratial_stop_mouth()
 {
        if (music_singing_any()) stop_singing();
        if (hex_spelling_any()) stop_hex_spell_all();
 }
 
-
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼È¯Æ°½èÍý
+ * @param command ȯư¤¹¤ë¥ì¥¤¥·¥ã¥ë¤ÎID
+ * @return ½èÍý¤ò¼ÂºÝ¤Ë¼Â¹Ô¤·¤¿¾ì¹ç¤ÏTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹¡£
+ */
 static bool cmd_racial_power_aux(s32b command)
 {
        s16b        plev = p_ptr->lev;
@@ -2198,9 +2215,9 @@ static bool cmd_racial_power_aux(s32b command)
        return TRUE;
 }
 
-
-/*
- * Allow user to choose a power (racial / mutation) to activate
+/*!
+ * @brief ¥ì¥¤¥·¥ã¥ë¡¦¥Ñ¥ï¡¼¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó / Allow user to choose a power (racial / mutation) to activate
+ * @return ¤Ê¤·
  */
 void do_cmd_racial_power(void)
 {