Add Doxygen comment to melee1.c.

diff --git a/src/melee1.c b/src/melee1.c
index 37449af..ac06b51 100644 (file)
--- a/src/melee1.c
+++ b/src/melee1.c
@@ -1,20 +1,26 @@
-/* File: melee1.c */
-
-/* Purpose: Monster attacks */
-
-/*
- * 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 melee1.c
+ * @brief ¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·â½èÍý / Monster attacks
+ * @date 2014/01/17
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\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
+ * @details
  */
 
 #include "angband.h"
 
 
-/*
- * Critical blow.  All hits that do 95% of total possible damage,
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼ÂÇ·â¤Î¥¯¥ê¥Æ¥£¥«¥ë¥é¥ó¥¯¤òÊÖ¤¹ /
+ * Critical blow. All hits that do 95% of total possible damage,
+ * @param dice ¥â¥ó¥¹¥¿¡¼ÂÇ·â¤Î¥À¥¤¥¹¿ô
+ * @param sides ¥â¥ó¥¹¥¿¡¼ÂÇ·â¤ÎºÇÂç¥À¥¤¥¹ÌÜ
+ * @param dam ¥×¥ì¥¤¥ä¡¼¤ËÍ¿¤¨¤¿¥À¥á¡¼¥¸
+ * @details
  * and which also do at least 20 damage, or, sometimes, N damage.
  * This is used only to determine "cuts" and "stuns".
  */
@@ -47,12 +53,14 @@ static int monster_critical(int dice, int sides, int dam)
        return (1 + max);
 }
 
-
-
-
-
-/*
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼ÂÇ·â¤ÎÌ¿Ãæ¤òȽÄꤹ¤ë /
  * Determine if a monster attack against the player succeeds.
+ * @param power ÂÇ·â°À­Ëè¤Î´ðËÜÌ¿ÃæÃÍ
+ * @param level ¥â¥ó¥¹¥¿¡¼¤Î¥ì¥Ù¥ë
+ * @param stun ¥â¥ó¥¹¥¿¡¼¤ÎÛ¯Û°ÃÍ
+ * @return TRUE¤Ê¤é¤ÐÌ¿ÃæȽÄê
+ * @details
  * Always miss 5% of the time, Always hit 5% of the time.
  * Otherwise, match monster power against player armor.
  */
@@ -84,9 +92,7 @@ static int check_hit(int power, int level, int stun)
 
 
 
-/*
- * Hack -- possible "insult" messages
- */
+/*! ¥â¥ó¥¹¥¿¡¼¤ÎÉî¿«¹Ô°Ù¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë / Hack -- possible "insult" messages */
 static cptr desc_insult[] =
 {
 #ifdef JP
@@ -116,10 +122,7 @@ static cptr desc_insult[] =
 };
 
 
-
-/*
- * Hack -- possible "insult" messages
- */
+/*! ¥Þ¥´¥Ã¥È¤Î¤Ü¤ä¤­¥á¥Ã¥»¡¼¥¸¥Æ¡¼¥Ö¥ë / Hack -- possible "insult" messages */
 static cptr desc_moan[] =
 {
 #ifdef JP
@@ -137,8 +140,10 @@ static cptr desc_moan[] =
 };
 
 
-/*
- * Attack the player via physical attacks.
+/*!
+ * @brief ¥â¥ó¥¹¥¿¡¼¤«¤é¥×¥ì¥¤¥ä¡¼¤Ø¤ÎÂÇ·â½èÍý / Attack the player via physical attacks.
+ * @param m_idx ÂÇ·â¤ò¹Ô¤¦¥â¥ó¥¹¥¿¡¼¤ÎID
+ * @return ¼ÂºÝ¤Ë¹¶·â½èÍý¤ò¹Ô¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹
  */
 bool make_attack_normal(int m_idx)
 {