Add Doxygen comment to avatar.c.

diff --git a/src/avatar.c b/src/avatar.c
index 7b0ab0a..8ec082a 100644 (file)
--- a/src/avatar.c
+++ b/src/avatar.c
@@ -1,5 +1,5 @@
 /*!
-    @file avater.c
+    @file avatar.c
     @brief ¥¦¥ë¥Æ¥£¥Þ£´¤ò»²¹Í¤Ë¤·¤¿ÆÁ¤Î¥·¥¹¥Æ¥à¤Î¼ÂÁõ / Enable an Ultima IV style "avatar" game where you try to achieve perfection in various virtues.
     @date 2013/12/23
     @author
@@ -62,7 +62,15 @@ cptr virtue[MAX_VIRTUE] =
 #endif
 };
 
-
+/*!
+ * @brief ³ºÅö¤ÎÆÁ¤¬¥×¥ì¥¤¥ä¡¼¤Ë»ØÄꤵ¤ì¤Æ¤¤¤ë¤«Èݤ«¤Ë±þ¤¸¤Ä¤Ä¡¢Âç¾®¤òÈæ³Ó¤¹¤ë¡£
+ * @details ÆÁ¤¬¤Ê¤¤¾ì¹ç¤ÏÃÍ0¤È¤·¤ÆÈæ³Ó¤¹¤ë¡£
+ * @param type Èæ³Ó¤·¤¿¤¤ÆÁ¤ÎID
+ * @param num Èæ³Ó´ð½àÃÍ
+ * @param tekitou VIRTUE_LARGE = ´ð½àÃͤè¤êÂ礭¤¤¤« / VIRTUE_SMALL = ´ð½àÃͤè¤ê¾®¤µ¤¤¤«
+ * @return Èæ³Ó¤Î¿¿µ¶ÃͤòÊÖ¤¹
+ * @todo °ú¿ô̾¤òľ¤·¤Æ¤ª¤¯
+ */
 bool compare_virtue(int type, int num, int tekitou)
 {
        int vir;
@@ -84,9 +92,11 @@ bool compare_virtue(int type, int num, int tekitou)
        return FALSE;
 }
 
-
-/* Aux function */
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î»ØÄê¤ÎÆÁ¤¬²¿ÈÖÌܤΥ¹¥í¥Ã¥È¤ËÅÐÏ¿¤µ¤ì¤Æ¤¤¤ë¤«¤òÊÖ¤¹¡£ / Aux function
+ * @param type ³Îǧ¤·¤¿¤¤ÆÁ¤ÎID
+ * @return ¥¹¥í¥Ã¥È¤¬¤¢¤ë¤Ê¤é¤Ð¥¹¥í¥Ã¥È¤ÎID(0¡Á7)+1¡¢¤Ê¤¤¾ì¹ç¤Ï0¤òÊÖ¤¹¡£
+ */
 int virtue_number(int type)
 {
        int i;
@@ -101,8 +111,11 @@ int virtue_number(int type)
        return 0;
 }
 
-/* Aux function */
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶È¤ä¼ï²¤Ë°Í¸¤·¤Ê¤¤¥é¥ó¥À¥à¤ÊÆÁ¤ò¼èÆÀ¤¹¤ë / Aux function
+ * @param which ³Îǧ¤·¤¿¤¤ÆÁ¤ÎID
+ * @return ÅÐÏ¿¤·¤¿¤¤ÆÁ¤Î¥¹¥í¥Ã¥ÈID(0¡Á7)¡£
+ */
 static void get_random_virtue(int which)
 {
        int type = 0;
@@ -146,6 +159,11 @@ static void get_random_virtue(int which)
        p_ptr->vir_types[which] = type;
 }
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÁª¤ó¤ÀËâË¡Îΰè¤Ë±þ¤¸¤ÆÂбþ¤¹¤ëÆÁ¤òÊÖ¤¹¡£
+ * @param realm ËâË¡Îΰè¤ÎID
+ * @return Âбþ¤¹¤ëÆÁ¤ÎID
+ */
 static s16b get_realm_virtues(byte realm)
 {
        switch (realm)
@@ -396,6 +414,13 @@ void get_virtues(void)
        }
 }
 
+/*!
+ * @brief Âбþ¤¹¤ëÆÁ¤ò¥×¥ì¥¤¥ä¡¼¤¬¥¹¥í¥Ã¥È¤ËÅÐÏ¿¤·¤Æ¤¤¤ë¾ì¹ç¤Ë²Ã¸º¤ò¹Ô¤¦¡£
+ * @detail ÈϰϤÏ-125¡Á125¡¢´ðËÜŪ¤ËÀäÂÐÃͤ¬Â礭¤¤¤Û¤ÉÀäÂÐÃͤ¬¾å¤¬¤ê¿É¤¯¤Ê¤ë¡£
+ * @param virtue ÆÁ¤ÎID
+ * @param amount ²Ã¸ºÎÌ
+ * @return ¤Ê¤·
+ */
 void chg_virtue(int virtue, int amount)
 {
        int i = 0;
@@ -454,6 +479,12 @@ void chg_virtue(int virtue, int amount)
        }
 }
 
+/*!
+ * @brief Âбþ¤¹¤ëÆÁ¤ò¥×¥ì¥¤¥ä¡¼¤¬¥¹¥í¥Ã¥È¤ËÅÐÏ¿¤·¤Æ¤¤¤ë¾ì¹ç¤Ë¸ÇÄêÃͤò¥»¥Ã¥È¤¹¤ë¡£
+ * @param virtue ÆÁ¤ÎID
+ * @param amount ¥»¥Ã¥È¤·¤¿¤¤ÃÍ¡£
+ * @return ¤Ê¤·
+ */
 void set_virtue(int virtue, int amount)
 {
        int i = 0;
@@ -468,6 +499,11 @@ void set_virtue(int virtue, int amount)
        }
 }
 
+/*!
+ * @brief ÆÁ¤Î¥À¥ó¥×ɽ¼¨¤ò¹Ô¤¦¡£
+ * @param OutFile ¥Õ¥¡¥¤¥ë¥Ý¥¤¥ó¥¿¡£
+ * @return ¤Ê¤·
+ */
 void dump_virtues(FILE *OutFile)
 {
        int v_nr = 0;