From 3a25557d3348c93215ef173930df782ff329b125 Mon Sep 17 00:00:00 2001
From: deskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Date: Mon, 23 Dec 2013 12:37:05 +0000
Subject: [PATCH] Add Doxygen comment to artifact.c.

---
 src/artifact.c | 49 ++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 42 insertions(+), 7 deletions(-)

diff --git a/src/artifact.c b/src/artifact.c
index f2e838c36..35e1a69e8 100644
--- a/src/artifact.c
+++ b/src/artifact.c
@@ -14,8 +14,8 @@
 
 
 /* Chance of using syllables to form the name instead of the "template" files */
-#define SINDARIN_NAME   10 /*!< ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ë¥·¥ó¥À¥ê¥óÌäò¤Ä¤±¤ë¾ò·ïʬ´ô */
-#define TABLE_NAME      20 /*!< ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ë´Á»úÌäò¤Ä¤±¤ë¾ò·ïʬ´ô */
+#define SINDARIN_NAME   10 /*!< ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ë¥·¥ó¥À¥ê¥óÌäò¤Ä¤±¤ë³ÎΨ */
+#define TABLE_NAME      20 /*!< ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ë´Á»úÌäò¤Ä¤±¤ë³ÎΨ(Àµ³Î¤Ë¤Ï TABLE_NAME - SINDARIN_NAME %)¤È¤Ê¤ë */
 #define A_CURSED        13 /*!< 1/n¤Î³ÎΨ¤ÇÀ¸À®¤Î´¬Êª°Ê³°¤Î¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬¼ö¤¤¤Ä¤­¤Ë¤Ê¤ë¡£ */
 #define WEIRD_LUCK      12 /*!< 1/n¤Î³ÎΨ¤Çrandom_resistance()¤Î½èÍýÃæ¥Ð¥¤¥¢¥¹³°¤ÎÂÑÀ­¤¬¤Ä¤­¡¢create_artifact¤Ç4¤òĶ¤¨¤ëpval¤¬µö²Ä¤µ¤ì¤ë¡£*/
 #define BIAS_LUCK       20 /*!< 1/n¤Î³ÎΨ¤Çrandom_resistance()¤ÇÉղ乤븵ÁÇÂÑÀ­¤¬Ìȱ֤ˤʤë */
@@ -922,7 +922,15 @@ static void random_resistance(object_type * o_ptr)
 }
 
 
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®Ãæ¡¢ÂоݤΥª¥Ö¥¸¥§¥¯¥È¤Ë¤½¤Î¾ÆÃÀ­¤òÉղ乤롣/ Add one misc flag on generation of randam artifact.
+ * @details Í¥ÀèŪ¤ËÉղ䵤ì¤ëÂÑÀ­¤¬¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¥Ð¥¤¥¢¥¹¤Ë°Í¸¤·¤Æ¸ºß¤¹¤ë¡£
+ * ¸¶Â§Åª¸õÊä¤Ï³Æ¼ïǽÎÏ°Ý»ý¡¢±Êµ×¸÷¸»+1¡¢ËãáãÃΤ餺¡¢À¸Ì¿ÎÏ°Ý»ý¡¢ÉâÍ·¡¢Æ©ÌÀ»ë¡¢µÞ²óÉü¡¢Ãپò½¡¢
+ * Íð¥Æ¥ì¥Ý¡¼¥È¡¢È¿ËâË¡¡¢È¿¥Æ¥ì¥Ý¡¼¥È¡¢·Ù¹ð¡¢¥Æ¥ì¥Ñ¥·¡¼¡¢³Æ¼ïESP¡¢°ìÉôÁõÈ÷¤Ë»¦Ù¤½¤Àµ¡£
+ * @attension ¥ª¥Ö¥¸¥§¥¯¥È¤Îtval¡¢sval¤Ë°Í¸¤·¤¿¥Ï¡¼¥É¥³¡¼¥Ç¥£¥ó¥°½èÍý¤¬¤¢¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void random_misc(object_type * o_ptr)
 {
 	switch (artifact_bias)
@@ -1186,7 +1194,16 @@ static void random_misc(object_type * o_ptr)
 	}
 }
 
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®Ãæ¡¢ÂоݤΥª¥Ö¥¸¥§¥¯¥È¤Ë¥¹¥ì¥¤¸ú²Ì¤òÉղ乤롣/ Add one slaying on generation of randam artifact.
+ * @details Í¥ÀèŪ¤ËÉղ䵤ì¤ëÂÑÀ­¤¬¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¥Ð¥¤¥¢¥¹¤Ë°Í¸¤·¤Æ¸ºß¤¹¤ë¡£
+ * ¸¶Â§Åª¸õÊä¤Ï¶¯Îϼ͡¢¹â®¼Í¡¢º®ÆÙ¸ú²Ì¡¢µÛ·ì¸ú²Ì¡¢½ËÊ¡¡¢ÅêÚ³¤·¤ä¤¹¤¤¡¢¾Æ´þ¡¢Åà·ë¡¢ÅÅ·â¡¢Íϲò¡¢ÆÇ»¦¡¢
+ * ưʪ¥¹¥ì¥¤¡¢¼Ù°­¥¹¥ì¥¤¡¢°­Ë⥹¥ì¥¤¡¢ÉԻॹ¥ì¥¤¡¢¥ª¡¼¥¯¥¹¥ì¥¤¡¢¥È¥í¥ë¥¹¥ì¥¤¡¢µð¿Í¥¹¥ì¥¤¡¢¥É¥é¥´¥ó¥¹¥ì¥¤¡¢
+ * *¥É¥é¥´¥ó¥¹¥ì¥¤*¡¢¿Í´Ö¥¹¥ì¥¤¡¢ÀÚ¤ìÌ£¡¢ÃÏ¿Ì¡¢ÍýÎÏ¡£
+ * @attension ¥ª¥Ö¥¸¥§¥¯¥È¤Îtval¡¢sval¤Ë°Í¸¤·¤¿¥Ï¡¼¥É¥³¡¼¥Ç¥£¥ó¥°½èÍý¤¬¤¢¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void random_slay(object_type *o_ptr)
 {
 	if (o_ptr->tval == TV_BOW)
@@ -1441,7 +1458,12 @@ static void random_slay(object_type *o_ptr)
 	}
 }
 
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®Ãæ¡¢ÂоݤΥª¥Ö¥¸¥§¥¯¥È¤Ë¥Ð¥¤¥¢¥¹¤Ë°Í¸¤·¤¿È¯Æ°¤òÍ¿¤¨¤ë¡£/ Add one activaton of randam artifact depend on bias.
+ * @details ¥Ð¥¤¥¢¥¹¤¬Ìµ¤¤¾ì¹ç¡¢°ìÉô¤Î¥Ð¥¤¥¢¥¹¤Î³ÎΨ¤Ë¤è¤Ã¤Æ¤Ï one_ability() ¤Ë½èÍý¤¬°Ü¹Ô¤¹¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 static void give_activation_power(object_type *o_ptr)
 {
 	int type = 0, chance = 0;
@@ -1621,7 +1643,14 @@ static void give_activation_power(object_type *o_ptr)
 	o_ptr->timeout = 0;
 }
 
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®Ãæ¡¢ÂоݤΥª¥Ö¥¸¥§¥¯¥È¤Ë̾Á°¤òÍ¿¤¨¤ë¡£/ Set name of randomartifact.
+ * @details ³ÎΨ¤Ë¤è¤Ã¤Æ¡¢¥·¥ó¥À¥ê¥óÌᢴÁ»úÌᢸÇÄê̾¤Î¤¤¤º¤ì¤«°ì¤Ä¤¬Í¿¤¨¤é¤ì¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @param armour ÂоݤΥª¥Ö¥¸¥§¥¯¥È¤¬Ëɶñ¤¬Èݤ«
+ * @param power Ìäδð½à¤È¤Ê¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î²ÁÃÍ¥ì¥Ù¥ë(0=¼ö¤¤¡¢1=Äã°Ì¡¢2=Ãæ°Ì¡¢3°Ê¾å=¹â°Ì)
+ * @return ¤Ê¤·
+ */
 static void get_random_name(char *return_name, bool armour, int power)
 {
 	int prob = randint1(100);
@@ -1712,7 +1741,13 @@ static void get_random_name(char *return_name, bool armour, int power)
 	}
 }
 
-
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
+ * @details ´û¤ËÀ¸À®¤¬ºÑ¤ó¤Ç¤¤¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤ÂΤò¡¢¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤È¤·¤Æ¶¯²½¤¹¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @param a_scroll ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®¤Î´¬Êª¾å¤Î½èÍý¡£¼ö¤¤¤Î¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬À¸À®Âоݳ°¤È¤Ê¤ë¡£
+ * @return ¾ï¤ËTRUE(1)¤òÊÖ¤¹
+ */
 bool create_artifact(object_type *o_ptr, bool a_scroll)
 {
 	char    new_name[1024];
-- 
2.11.0