OSDN Git Service

Fix Doxygen warning in mutation.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 13 Jan 2014 12:55:16 +0000 (12:55 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 13 Jan 2014 12:55:16 +0000 (12:55 +0000)
src/mutation.c

index b36d79c..00aaabf 100644 (file)
@@ -1,18 +1,23 @@
-/* File: mutation.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 mutation.c
+ * @brief ÆÍÁ³ÊѰۥ롼¥ë¤Î¼ÂÁõ / Mutation effects (and racial powers)
+ * @date 2014/01/11
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\n
+ *\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: Mutation effects (and racial powers) */
-
 #include "angband.h"
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ËÆÍÁ³ÊÑ°Û¤òÍ¿¤¨¤ë
+ * @param choose_mut Í¿¤¨¤¿¤¤ÆÍÁ³ÊÑ°Û¤ÎID¡¢0¤Ê¤é¤Ð¥é¥ó¥À¥à¤ËÁªÂò
+ * @return ¤Ê¤·
+ */
 bool gain_random_mutation(int choose_mut)
 {
        int     attempts_left = 20;
@@ -846,7 +851,11 @@ bool gain_random_mutation(int choose_mut)
        }
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤«¤éÆÍÁ³ÊÑ°Û¤ò¼è¤ê½ü¤¯
+ * @param choose_mut ¼è¤ê½ü¤­¤¿¤¤ÆÍÁ³ÊÑ°Û¤ÎID¡¢0¤Ê¤é¤Ð¥é¥ó¥À¥à¤Ë¾Ãµî
+ * @return ¤Ê¤·
+ */
 bool lose_mutation(int choose_mut)
 {
        int attempts_left = 20;
@@ -1469,7 +1478,11 @@ bool lose_mutation(int choose_mut)
        }
 }
 
-
+/*!
+ * @brief ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿¤òÄ̤¸¤ÆÆÍÁ³ÊѰۤΰìÍ÷¤ò½ÐÎϤ¹¤ë
+ * @param OutFile ½ÐÎÏÀè¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void dump_mutations(FILE *OutFile)
 {
        if (!OutFile) return;
@@ -1967,9 +1980,9 @@ void dump_mutations(FILE *OutFile)
        }
 }
 
-
-/*
- * List mutations we have...
+/*!
+ * @brief ÆÍÁ³ÊÑ°Ûɽ¼¨¥³¥Þ¥ó¥É¤Î¼ÂÁõ / List mutations we have...
+ * @return ¤Ê¤·
  */
 void do_cmd_knowledge_mutations(void)
 {
@@ -1997,7 +2010,11 @@ show_file(TRUE, file_name, "
        fd_kill(file_name);
 }
 
-
+/*!
+ * @brief Éä¹æ¤Ê¤·32¥Ó¥Ã¥ÈÀ°¿ô¤Î¥Ó¥Ã¥È¿ô¤òÊÖ¤¹¡£
+ * @param ¥Ó¥Ã¥È¿ô¤òÄ´¤Ù¤¿¤¤ÊÑ¿ô
+ * @return ¥Ó¥Ã¥È¿ô
+ */
 int count_bits(u32b x)
 {
        int n = 0;
@@ -2011,7 +2028,10 @@ int count_bits(u32b x)
        return (n);
 }
 
-
+/*!
+ * @brief ¸½ºß¥×¥ì¥¤¥ä¡¼ÆÀ¤Æ¤¤¤ëÆÍÁ³ÊѰۤοô¤òÊÖ¤¹¡£
+ * @return ¸½ºßÆÀ¤Æ¤¤¤ëÆÍÁ³ÊѰۤοô
+ */
 static int count_mutations(void)
 {
        return (count_bits(p_ptr->muta1) +
@@ -2020,9 +2040,10 @@ static int count_mutations(void)
 }
 
 
-/*
- * Return the modifier to the regeneration rate
- * (in percent)
+/*!
+ * @brief ÆÍÁ³ÊѰۤˤè¤ë¼«Á³²óÉü¥Ú¥Ê¥ë¥Æ¥£¤ò¥Ñ¡¼¥»¥ó¥ÈÃͤÇÊÖ¤¹ /
+ * Return the modifier to the regeneration rate (in percent)
+ * @return ¥Ú¥Ê¥ë¥Æ¥£½¤Àµ(%)
  */
 int calc_mutant_regenerate_mod(void)
 {
@@ -2053,7 +2074,10 @@ int calc_mutant_regenerate_mod(void)
        return (regen);
 }
 
-
+/*!
+ * @brief ÆÍÁ³ÊѰۥ쥤¥·¥ã¥ë¾å¤Ç¸ý¤ò»È¤¦¤è¤ê¤ò¹Ô¤Ã¤¿ºÝ¤Ë²Î¤ä¼ö½Ñ¤òÄä»ß¤¹¤ë /
+ * @return ¤Ê¤·
+ */
 void mutation_stop_mouth()
 {
        if (music_singing_any()) stop_singing();
@@ -2061,6 +2085,11 @@ void mutation_stop_mouth()
 }
 
 
+/*!
+ * @brief ÆÍÁ³ÊѰۤΥ쥤¥·¥ã¥ë¸ú²Ì¼ÂÁõ
+ * @return È¯Æ°¤µ¤»¤ëÆÍÁ³ÊѰۥ쥤¥·¥ã¥ë¤ÎID
+ * @return ¥ì¥¤¥·¥ã¥ë¤ò¼Â¹Ô¤·¤¿¾ì¹çTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¾ì¹çFALSE¤òÊÖ¤¹
+ */
 bool mutation_power_aux(u32b power)
 {
        int     dir = 0;