Add Doxygen comment to do-spell.c.

diff --git a/src/do-spell.c b/src/do-spell.c
index e710de9..a8f1112 100644 (file)
--- a/src/do-spell.c
+++ b/src/do-spell.c
@@ -1,12 +1,22 @@
-/* File: do-spell.c */
-
-/* Purpose: Do everything for each spell */
+/*!
+    @file do-spell.c
+    @brief ËâË¡¤Î¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹¤Èȯư / Purpose: Do everything for each spell
+    @date 2013/12/31
+    @author
+    2013 Deskull rearranged comment for Doxygen.
+ */
 
 #include "angband.h"
 
 
-/*
- * Generate dice info string such as "foo 2d10"
+/*!
+ * @brief
+ * ËâË¡¤Î¸ú²Ì¤ò¡Ö¥­¥ã¥×¥·¥ç¥ó:¥À¥¤¥¹¡ÜÄê¿ôÃ͡פΥե©¡¼¥Þ¥Ã¥È¤Ç½ÐÎϤ¹¤ë / Generate dice info string such as "foo 2d10"
+ * @param str ¥­¥ã¥×¥·¥ç¥ó
+ * @param dice ¥À¥¤¥¹¿ô
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @param base ¸ÇÄêÃÍ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_string_dice(cptr str, int dice, int sides, int base)
 {
@@ -24,8 +34,12 @@ static cptr info_string_dice(cptr str, int dice, int sides, int base)
 }
 
 
-/*
- * Generate damage-dice info string such as "dam 2d10"
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë¥À¥á¡¼¥¸¤ò½ÐÎϤ¹¤ë / Generate damage-dice info string such as "dam 2d10"
+ * @param dice ¥À¥¤¥¹¿ô
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @param base ¸ÇÄêÃÍ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_damage(int dice, int sides, int base)
 {
@@ -36,9 +50,11 @@ static cptr info_damage(int dice, int sides, int base)
 #endif
 }
 
-
-/*
- * Generate duration info string such as "dur 20+1d20"
+/*!
+ * @brief ËâË¡¤Î¸ú²Ì»þ´Ö¤ò½ÐÎϤ¹¤ë / Generate duration info string such as "dur 20+1d20"
+ * @param base ¸ÇÄêÃÍ
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_duration(int base, int sides)
 {
@@ -49,9 +65,10 @@ static cptr info_duration(int base, int sides)
 #endif
 }
 
-
-/*
- * Generate range info string such as "range 5"
+/*!
+ * @brief ËâË¡¤Î¸ú²ÌÈϰϤò½ÐÎϤ¹¤ë / Generate range info string such as "range 5"
+ * @param range ¸ú²ÌÈÏ°Ï
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_range(int range)
 {
@@ -62,9 +79,12 @@ static cptr info_range(int range)
 #endif
 }
 
-
-/*
- * Generate heal info string such as "heal 2d8"
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë²óÉüÎ̤ò½ÐÎϤ¹¤ë / Generate heal info string such as "heal 2d8"
+ * @param dice ¥À¥¤¥¹¿ô
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @param base ¸ÇÄêÃÍ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_heal(int dice, int sides, int base)
 {
@@ -75,9 +95,11 @@ static cptr info_heal(int dice, int sides, int base)
 #endif
 }
 
-
-/*
- * Generate delay info string such as "delay 15+1d15"
+/*!
+ * @brief ËâË¡¸ú²Ìȯư¤Þ¤Ç¤ÎÃٱ䥿¡¼¥ó¤ò½ÐÎϤ¹¤ë / Generate delay info string such as "delay 15+1d15"
+ * @param base ¸ÇÄêÃÍ
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_delay(int base, int sides)
 {
@@ -89,8 +111,10 @@ static cptr info_delay(int base, int sides)
 }
 
 
-/*
- * Generate multiple-damage info string such as "dam 25 each"
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë¥À¥á¡¼¥¸¤ò½ÐÎϤ¹¤ë(¸ÇÄêÃÍ¡õÊ£¿ô²ó½èÍý) / Generate multiple-damage info string such as "dam 25 each"
+ * @param dam ¸ÇÄêÃÍ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_multi_damage(int dam)
 {
@@ -102,8 +126,11 @@ static cptr info_multi_damage(int dam)
 }
 
 
-/*
- * Generate multiple-damage-dice info string such as "dam 5d2 each"
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë¥À¥á¡¼¥¸¤ò½ÐÎϤ¹¤ë(¥À¥¤¥¹¤Î¤ß¡õÊ£¿ô²ó½èÍý) / Generate multiple-damage-dice info string such as "dam 5d2 each"
+ * @param dice ¥À¥¤¥¹¿ô
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_multi_damage_dice(int dice, int sides)
 {
@@ -114,9 +141,10 @@ static cptr info_multi_damage_dice(int dice, int sides)
 #endif
 }
 
-
-/*
- * Generate power info string such as "power 100"
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë°ìÈÌŪ¤Ê¸úÎÏÃͤò½ÐÎϤ¹¤ë¡Ê¸ÇÄêÃÍ¡Ë / Generate power info string such as "power 100"
+ * @param power ¸ÇÄêÃÍ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_power(int power)
 {
@@ -128,6 +156,12 @@ static cptr info_power(int power)
 }
 
 
+/*!
+ * @brief ËâË¡¤Ë¤è¤ë°ìÈÌŪ¤Ê¸úÎÏÃͤò½ÐÎϤ¹¤ë¡Ê¥À¥¤¥¹ÃÍ¡Ë / Generate power info string such as "power 100"
+ * @param dice ¥À¥¤¥¹¿ô
+ * @param sides ¥À¥¤¥¹ÌÜ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
+ */
 /*
  * Generate power info string such as "power 1d100"
  */
@@ -141,8 +175,10 @@ static cptr info_power_dice(int dice, int sides)
 }
 
 
-/*
- * Generate radius info string such as "rad 100"
+/*!
+ * @brief ËâË¡¤Î¸ú²ÌȾ·Â¤ò½ÐÎϤ¹¤ë / Generate radius info string such as "rad 100"
+ * @param rad ¸ú²ÌȾ·Â
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_radius(int rad)
 {
@@ -154,8 +190,10 @@ static cptr info_radius(int rad)
 }
 
 
-/*
- * Generate weight info string such as "max wgt 15"
+/*!
+ * @brief ËâË¡¸ú²Ì¤Î¸Â³¦½ÅÎ̤ò½ÐÎϤ¹¤ë / Generate weight info string such as "max wgt 15"
+ * @param weight ºÇÂç½ÅÎÌ
+ * @return ¥Õ¥©¡¼¥Þ¥Ã¥È¤Ë½¾¤¤À°·Á¤µ¤ì¤¿Ê¸»úÎó
  */
 static cptr info_weight(int weight)
 {