Add Doxygen comment to artifact.c.

[hengband/hengband.git] / src / artifact.c

diff --git a/src/artifact.c b/src/artifact.c
index a461489..9f81dcc 100644 (file)
--- a/src/artifact.c
+++ b/src/artifact.c
@@ -36,9 +36,10 @@ static int artifact_bias;
 
 
 /*!
- * ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˥é¥ó¥À¥à¤ÊǽÎÏ°Ý»ý¤ò°ì¤ÄÉղ乤롣 / Choose one random sustain
- *  @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
- *  @return ¤Ê¤·
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˥é¥ó¥À¥à¤ÊǽÎÏ°Ý»ý¤ò°ì¤ÄÉղ乤롣/ Choose one random sustain
+ * @details ½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_sustain(object_type *o_ptr)
 {
@@ -54,8 +55,11 @@ void one_sustain(object_type *o_ptr)
 }
 
 
-/*
- * Choose one random high resistance
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˥é¥ó¥À¥à¤Ê¾å°ÌÂÑÀ­¤ò°ì¤ÄÉղ乤롣/ Choose one random high resistance
+ * @details ½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£¸õÊä¤ÏÆÇ¡¢Á®¸÷¡¢°Å¹õ¡¢ÇËÊÒ¡¢ÌÕÌÜ¡¢º®Íð¡¢ÃϹö¡¢°ø²Ìº®Íð¡¢¥«¥ª¥¹¡¢Îô²½¡¢¶²ÉݤΤ¤¤º¤ì¤«¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_high_resistance(object_type *o_ptr)
 {
@@ -76,9 +80,13 @@ void one_high_resistance(object_type *o_ptr)
        }
 }
 
-
-/*
- * Choose one random high resistance ( except poison and disenchantment )
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˲¦¼Ô¤Î»ØÎظþ¤±¤Î¾å°ÌÂÑÀ­¤ò°ì¤ÄÉղ乤롣/ Choose one random high resistance
+ * @details ¸õÊä¤ÏÁ®¸÷¡¢°Å¹õ¡¢ÇËÊÒ¡¢ÌÕÌÜ¡¢º®Íð¡¢ÃϹö¡¢°ø²Ìº®Íð¡¢¥«¥ª¥¹¡¢¶²ÉݤǤ¢¤ê
+ * ²¦¼Ô¤Î»ØÎؤˤ¢¤é¤«¤¸¤á¤Ä¤¤¤Æ¤¤¤ëÂÑÀ­¤òone_high_resistance()¤«¤é½ü³°¤·¤¿¤â¤Î¤Ç¤¢¤ë¡£
+ * ¥é¥ó¥À¥àÉղ佤Τâ¤Î¤Ë½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_lordly_high_resistance(object_type *o_ptr)
 {
@@ -97,9 +105,11 @@ void one_lordly_high_resistance(object_type *o_ptr)
        }
 }
 
-
-/*
- * Choose one random element resistance
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˸µÁÇÂÑÀ­¤ò°ì¤ÄÉղ乤롣/ Choose one random element resistance
+ * @details ¸õÊä¤Ï²Ð±ê¡¢Î䵤¡¢ÅÅ·â¡¢»À¤Î¤¤¤º¤ì¤«¤Ç¤¢¤ê¡¢½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_ele_resistance(object_type *o_ptr)
 {
@@ -112,9 +122,11 @@ void one_ele_resistance(object_type *o_ptr)
        }
 }
 
-
-/*
- * Choose one random element or poison resistance
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˥ɥ饴¥óÁõÈ÷¸þ¤±¸µÁÇÂÑÀ­¤ò°ì¤ÄÉղ乤롣/ Choose one random element or poison resistance
+ * @details ¸õÊä¤Ï1/7¤Î³ÎΨ¤ÇÆÇ¡¢6/7¤Î³ÎΨ¤Ç²Ð±ê¡¢Î䵤¡¢ÅÅ·â¡¢»À¤Î¤¤¤º¤ì¤«(one_ele_resistance()¤Î¥³¡¼¥ë)¤Ç¤¢¤ê¡¢½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_dragon_ele_resistance(object_type *o_ptr)
 {
@@ -128,9 +140,12 @@ void one_dragon_ele_resistance(object_type *o_ptr)
        }
 }
 
-
-/*
- * Choose one lower rank esp
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤ˼夤ESP¤ò°ì¤ÄÉղ乤롣/ Choose one lower rank esp
+ * @details ¸õÊä¤Ïưʪ¡¢¥¢¥ó¥Ç¥Ã¥É¡¢°­Ëâ¡¢¥ª¡¼¥¯¡¢¥È¥í¥ë¡¢µð¿Í¡¢
+ * ¥É¥é¥´¥ó¡¢¿Í´Ö¡¢Á±ÎÉ¡¢¥æ¥Ë¡¼¥¯ESP¤Î¤¤¤º¤ì¤«¤Ç¤¢¤ê¡¢½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_low_esp(object_type *o_ptr)
 {
@@ -150,9 +165,12 @@ void one_low_esp(object_type *o_ptr)
 }
 
 
-
-/*
- * Choose one random resistance
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤËÂÑÀ­¤ò°ì¤ÄÉղ乤롣/ Choose one random resistance
+ * @details 1/3¤Ç¸µÁÇÂÑÀ­(one_ele_resistance())¡¢2/3¤Ç¾å°ÌÂÑÀ­(one_high_resistance)
+ * ¤ò¥³¡¼¥ë¤¹¤ë¡£½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_resistance(object_type *o_ptr)
 {
@@ -167,15 +185,19 @@ void one_resistance(object_type *o_ptr)
 }
 
 
-/*
- * Choose one random ability
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤËǽÎϤò°ì¤ÄÉղ乤롣/ Choose one random ability
+ * @details ¸õÊä¤ÏÉâÍ·¡¢±Êµ×¸÷¸»+1¡¢Æ©ÌÀ»ë¡¢·Ù¹ð¡¢Ãپò½¡¢µÞ²óÉü¡¢ËãáãÃΤ餺¡¢À¸Ì¿ÎÏ°Ý»ý¤Î¤¤¤º¤ì¤«¡£
+ * ½ÅÊ£¤ÎÍ޻ߤϤʤ¤¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_ability(object_type *o_ptr)
 {
        switch (randint0(10))
        {
-       case 0: add_flag(o_ptr->art_flags, TR_LEVITATION);     break;
-       case 1: add_flag(o_ptr->art_flags, TR_LITE_1);        break;
+       case 0: add_flag(o_ptr->art_flags, TR_LEVITATION);  break;
+       case 1: add_flag(o_ptr->art_flags, TR_LITE_1);      break;
        case 2: add_flag(o_ptr->art_flags, TR_SEE_INVIS);   break;
        case 3: add_flag(o_ptr->art_flags, TR_WARNING);     break;
        case 4: add_flag(o_ptr->art_flags, TR_SLOW_DIGEST); break;
@@ -189,8 +211,12 @@ void one_ability(object_type *o_ptr)
        }
 }
 
-/*
- * Choose one random activation
+/*!
+ * @brief ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤËȯư¤ò°ì¤ÄÉղ乤롣/ Choose one random activation
+ * @details ¸õÊä¿¿ô¡£¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Î¥Ð¥¤¥¢¥¹¤Ë¤Ï°ìÀڰ͸¤»¤º¡¢
+ * while¥ë¡¼¥×¤Ë¤è¤ë¹½Â¤¤ÇǽÎÏŪ¤Ë¶¯ÎϤʤâ¤Î¤Û¤É³ÎΨ¤òÍî¤È¤·¤Æ¤¤¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
  */
 void one_activation(object_type *o_ptr)
 {
@@ -306,6 +332,15 @@ void one_activation(object_type *o_ptr)
        o_ptr->timeout = 0;
 }
 
+/*!
+ * @brief ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®Ãæ¤Î¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤò¼ö¤¤¤Î¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ë¤¹¤ë·Ð²á½èÍý¡£/ generation process of cursed artifact.
+ * @details pval¡¢AC¡¢Ì¿Ãæ¡¢¥À¥á¡¼¥¸¤¬Àµ¤Î¾ì¹ç¡¢Éä¹æȿž¤Î¾å1d4¤À¤±°­²½¤µ¤»¡¢½Å¤¤¼ö¤¤¡¢¼ö¤¤¥Õ¥é¥°¤òɬ¤ºÉղá£
+ * ½ËÊ¡¤ò̵¸ú¡£³ÎΨ¤Ë±þ¤¸¤Æ¡¢±Ê±ó¤Î¼ö¤¤¡¢ÂÀ¸Å¤Î±åÇ°¡¢·Ð¸³Ã͵ۼý¡¢¼å¤¤¼ö¤¤¤Î·Ñ³ŪÉղᢶ¯¤¤¼ö¤¤¤Î·Ñ³ŪÉղá¢HPµÛ¼ý¤Î¼ö¤¤¡¢
+ * MPµÛ¼ý¤Î¼ö¤¤¡¢Íð¥Æ¥ì¥Ý¡¼¥È¡¢È¿¥Æ¥ì¥Ý¡¼¥È¡¢È¿ËâË¡¤ò¤Ä¤±¤ë¡£
+ * @attention ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶È°Í¸½èÍý¤¢¤ê¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂÎ
+ * @return ¤Ê¤·
+ */
 static void curse_artifact(object_type * o_ptr)
 {
        if (o_ptr->pval > 0) o_ptr->pval = 0 - (o_ptr->pval + randint1(4));