Add Doxygen comment to monster1.c.

diff --git a/src/monster1.c b/src/monster1.c
index 674a6c7..14141ff 100644 (file)
--- a/src/monster1.c
+++ b/src/monster1.c
@@ -1,15 +1,15 @@
-/* File: monster1.c */
-
-/*
+/*!
+ * @file monster1.c
+ * @brief ¥â¥ó¥¹¥¿¡¼¾ðÊó¤Îµ­½Ò / describe monsters (using monster memory)
+ * @date 2013/12/11
+ * @author
  * 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.
+ * 2014 Deskull rearranged comment for Doxygen.
  */
 
-/* Purpose: describe monsters (using monster memory) */
-
 #include "angband.h"
 
 
@@ -32,19 +32,19 @@ static cptr wd_his[3] =
 
 
 
-/*
- * Pluralizer.  Args(count, singular, plural)
+/*!
+ * ±Ñ¸ì¤ÎÊ£¿ô·Ïµ­½ÒÍÑ¥Þ¥¯¥í / Pluralizer.  Args(count, singular, plural)
  */
 #define plural(c,s,p) \
     (((c) == 1) ? (s) : (p))
 
 
 
-
-
-
-/*
- * Determine if the "armor" is known
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¤ÎAC¾ðÊó¤òÆÀ¤ë¤³¤È¤¬¤Ç¤­¤ë¤«¤òÊÖ¤¹ / Determine if the "armor" is known
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @return Ũ¤ÎAC¤òÃΤë¾ò·ï¤¬Ëþ¤¿¤µ¤ì¤Æ¤¤¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ * @details
  * The higher the level, the fewer kills needed.
  */
 static bool know_armour(int r_idx)
@@ -71,10 +71,17 @@ static bool know_armour(int r_idx)
 }
 
 
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·â°ÒÎϤòÃΤ뤳¤È¤¬¤Ç¤­¤ë¤«¤É¤¦¤«¤òÊÖ¤¹
  * Determine if the "damage" of the given attack is known
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @param i ³Îǧ¤·¤¿¤¤¹¶·â¼êÈÖ
+ * @return Ũ¤Î¥À¥á¡¼¥¸¥À¥¤¥¹¤òÃΤë¾ò·ï¤¬Ëþ¤¿¤µ¤ì¤Æ¤¤¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ * @details
+ * <pre>
  * the higher the level of the monster, the fewer the attacks you need,
  * the more damage an attack does, the more attacks you need
+ * </pre>
  */
 static bool know_damage(int r_idx, int i)
 {
@@ -117,9 +124,13 @@ static void hooked_roff(cptr str)
 }
 
 
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¤Î»×¤¤½Ð¾ðÊó¤òɽ¼¨¤¹¤ë
  * Hack -- display monster information using "hooked_roff()"
- *
+ * @param r_idx ¥â¥ó¥¹¥¿¡¼¤Î¼ï²ID
+ * @param mode ɽ¼¨¥ª¥×¥·¥ç¥ó
+ * @return ¤Ê¤·
+ * @details
  * This function should only be called with the cursor placed at the
  * left edge of the screen, on a cleared line, in which the recall is
  * to take place.  One extra blank line is left after the recall.