From: Deskull <desull@users.sourceforge.jp>
Date: Sun, 3 Aug 2014 13:09:11 +0000 (+0900)
Subject: Add Doxygen comments to funtions for uncurse spells in spells3.c.
X-Git-Tag: v2.2.0~192
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=14d65cfd6a70251cec2265bb77ba343e43025b60;p=hengband%2Fhengband.git

Add Doxygen comments to funtions for uncurse spells in spells3.c.
---

diff --git a/src/spells3.c b/src/spells3.c
index 727b8467a..2145f7f03 100644
--- a/src/spells3.c
+++ b/src/spells3.c
@@ -1889,9 +1889,11 @@ bool explosive_rune(void)
 }
 
 
-/*
+/*!
+ * @brief 自己分析の薬による全所持アイテム鑑定処理 /
  * Identify everything being carried.
  * Done by a potion of "self knowledge".
+ * @return なし
  */
 void identify_pack(void)
 {
@@ -1914,9 +1916,11 @@ void identify_pack(void)
 }
 
 
-/*
+/*!
+ * @brief 装備強化処理の失敗率定数（千分率） /
  * Used by the "enchant" function (chance of failure)
  * (modified for Zangband, we need better stuff there...) -- TY
+ * @return なし
  */
 static int enchant_table[16] =
 {
@@ -1927,15 +1931,20 @@ static int enchant_table[16] =
 };
 
 
-/*
+/*!
+ * @brief 装備の解呪処理 /
  * Removes curses from items in inventory
- *
+ * @param all 軽い呪いまでの解除ならば0
+ * @return 解呪されたアイテムの数
+ * @details
+ * <pre>
  * Note that Items which are "Perma-Cursed" (The One Ring,
  * The Crown of Morgoth) can NEVER be uncursed.
  *
  * Note that if "all" is FALSE, then Items which are
  * "Heavy-Cursed" (Mormegil, Calris, and Weapons of Morgul)
  * will not be uncursed.
+ * </pre>
  */
 static int remove_curse_aux(int all)
 {
@@ -1987,16 +1996,20 @@ static int remove_curse_aux(int all)
 }
 
 
-/*
+/*!
+ * @brief 装備の軽い呪い解呪処理 /
  * Remove most curses
+ * @return 解呪に成功した装備数
  */
 bool remove_curse(void)
 {
 	return (remove_curse_aux(FALSE));
 }
 
-/*
+/*!
+ * @brief 装備の重い呪い解呪処理 /
  * Remove all curses
+ * @return 解呪に成功した装備数
  */
 bool remove_all_curse(void)
 {