Add Doxygen comment to avatar.c.

diff --git a/src/avatar.c b/src/avatar.c
index fdbd01b..7b0ab0a 100644 (file)
--- a/src/avatar.c
+++ b/src/avatar.c
@@ -1,28 +1,24 @@
-/* File: avatar.c */
-
-/*
- * Purpose: Enable an Ultima IV style "avatar" game where you try to
- * achieve perfection in various virtues.
- *
- * Topi Ylinen 1998
- * f1toyl@uta.fi
- * topi.ylinen@noodi.fi
- *
- */
+/*!
+    @file avater.c
+    @brief ¥¦¥ë¥Æ¥£¥Þ£´¤ò»²¹Í¤Ë¤·¤¿ÆÁ¤Î¥·¥¹¥Æ¥à¤Î¼ÂÁõ / Enable an Ultima IV style "avatar" game where you try to achieve perfection in various virtues.
+    @date 2013/12/23
+    @author
+    Topi Ylinen 1998\n
+    f1toyl@uta.fi\n
+    topi.ylinen@noodi.fi\n
+    \n
+    Copyright (c) 1989 James E. Wilson, Christopher J. Stuart
+    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.
+*/
 
-/*
- * Copyright (c) 1989 James E. Wilson, Christopher J. Stuart
- *
- * 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.
- */
 
 #include "angband.h"
 
-
-/* The names of the virtues */
-
+/*!
+ * ÆÁ¤Î̾¾Î / The names of the virtues
+ */
 cptr virtue[MAX_VIRTUE] =
 {
 #ifdef JP
@@ -189,8 +185,13 @@ static s16b get_realm_virtues(byte realm)
        return 0;
 }
 
-/* Select virtues & reset values for a new character */
 
+/*!
+ * @brief ºîÀ®Ãæ¤Î¥×¥ì¥¤¥ä¡¼¥­¥ã¥é¥¯¥¿¡¼¤ËÆÁ8¼ïÎà¤òÍ¿¤¨¤ë¡£ / Select virtues & reset values for a new character
+ * @details ¿¦¶È¤Ë±þ¤¸¤Æ1¡Á4¼ï¤¬¸ÇÄê¡¢¼ï²¤Ë±þ¤¸¤Æ1¼ïÎबͿ¤¨¤é¤ì¡¢¸å¤Ï½ÅÊ£¤Ê¤¯¥é¥ó¥À¥à¤ËÁªÂò¤µ¤ì¤ë¡£
+ * @param ¤Ê¤·
+ * @return ¤Ê¤·
+ */
 void get_virtues(void)
 {
        int i = 0, j = 0;