Add Doxygen comment to artifact.c.

diff --git a/src/artifact.c b/src/artifact.c
index 7439250..6eb7396 100644 (file)
--- a/src/artifact.c
+++ b/src/artifact.c
@@ -3854,7 +3854,12 @@ bool activate_random_artifact(object_type *o_ptr)
        return TRUE;
 }
 
-
+/*!
+ * @brief ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¡Ø¥Ö¥é¥Ã¥Ç¥£¥à¡¼¥ó¡Ù¤ÎÆÃÀ­¤òÊѹ¹¤¹¤ë¡£
+ * @details ¥¹¥ì¥¤2d2¼ï¡¢µÚ¤Óone_resistance()¤Ë¤è¤ëÂÑÀ­1d2¼ï¡¢pval2¼ï¤òÆÀ¤ë¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΡʥ֥é¥Ã¥Ç¥£¥à¡¼¥ó¡Ë¤Î¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void get_bloody_moon_flags(object_type *o_ptr)
 {
        int dummy, i;
@@ -3883,7 +3888,17 @@ void get_bloody_moon_flags(object_type *o_ptr)
        }
 }
 
-
+/*!
+ * @brief ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥ÈÀ¸À®»þ¤ÎÆÃÊ̤ʥϡ¼¥É¥³¡¼¥Ç¥£¥ó¥°½èÍý¤ò¹Ô¤¦¡£.
+ * @details random_artifact_resistance()¤È¤¢¤ë¤¬¼ÂºÝ¤Ï¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ç¤¢¤ë¡£
+ * Âоݤ϶²Éݤβ¾ÌÌ¡¢Â¼Àµ¡¢¥í¥Ó¥ó¥È¥ó¤Î¥Ï¡¼¥×¡¢Î¶Áè¸×ò¬¡¢¥Ö¥é¥Ã¥Ç¥£¥à¡¼¥ó¡¢±©°á¡¢Å·½÷¤Î±©°á¡¢¥ß¥ê¥à¡¢
+ * ¤½¤Î¾ÄɲÃÂÑÀ­¡¢ÆÃÀ­ÄɲýèÍý¡£
+ * @attension ¥×¥ì¥¤¥ä¡¼¤Î³Æ¼ï¥¹¥Æ¡¼¥¿¥¹¤Ë°Í¸¤·¤¿½èÍý¤¬¤¢¤ë¡£
+ * @todo ÀÞ¤ò¸«¤Æ´Ø¿ô̾¤òÊѹ¹¤¹¤ë¤³¤È¡£
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @param a_ptr À¸À®¤¹¤ë¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¤Ê¤·
+ */
 void random_artifact_resistance(object_type * o_ptr, artifact_type *a_ptr)
 {
        bool give_resistance = FALSE, give_power = FALSE;
@@ -3977,8 +3992,17 @@ void random_artifact_resistance(object_type * o_ptr, artifact_type *a_ptr)
 }
 
 
-/*
- * Create the artifact of the specified number
+/*!
+ * @brief ¥Õ¥í¥¢¤Î»ØÄꤵ¤ì¤¿°ÌÃ֤˸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤òÀ¸À®¤¹¤ë¡£ / Create the artifact of the specified number
+ * @details ¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¹½Â¤ÂΤ«¤é´ðËÜ¥¹¥Æ¡¼¥¿¥¹¤ò¥³¥Ô¡¼¤·¤¿¸å¡¢½êÄê¤ÎºÂɸ¤Çdrop_item()¤ÇÍî¤È¤¹¡£
+ * @param a_idx À¸À®¤¹¤ë¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¹½Â¤ÂΤÎID
+ * @param y ¥¢¥¤¥Æ¥à¤òÍî¤È¤¹ÃÏÅÀ¤ÎyºÂɸ
+ * @param x ¥¢¥¤¥Æ¥à¤òÍî¤È¤¹ÃÏÅÀ¤ÎxºÂɸ
+ * @return À¸À®¤¬À®¸ù¤·¤¿¤«Èݤ«¡¢¼ºÇÔ¤ÏID¤ÎÉÔÁ´¡¢¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤ÎÉÔÁ´¡¢drop_item()¤Î¼ºÇÔ»þ¤Ëµ¯¤³¤ë¡£
+ * @attention ¤³¤Î½èÍý¤Ïdrop_near()Æâ¤ÇÉáÄ̤θÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬½Å¤Ê¤é¤Ê¤¤À­¼Á¤Ë°Í¸¤¹¤ë.
+ * ²¾¤Ë2¸Ä°Ê¾å¸ºß²Äǽ¤«¤ÄÁõÈ÷Éʰʳ°¤Î¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬ºîÀ®¤µ¤ì¤ì¤Ð
+ * drop_near()´Ø¿ô¤ÎÊÖ¤êÃͤϿ®ÍѤǤ­¤Ê¤¯¤Ê¤ë.
+
  */
 bool create_named_art(int a_idx, int y, int x)
 {
@@ -4026,12 +4050,6 @@ bool create_named_art(int a_idx, int y, int x)
 
        random_artifact_resistance(q_ptr, a_ptr);
 
-       /*
-        * drop_near()Æâ¤ÇÉáÄ̤θÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬½Å¤Ê¤é¤Ê¤¤À­¼Á¤Ë°Í¸¤¹¤ë.
-        * ²¾¤Ë2¸Ä°Ê¾å¸ºß²Äǽ¤«¤ÄÁõÈ÷Éʰʳ°¤Î¸ÇÄꥢ¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤¬ºîÀ®¤µ¤ì¤ì¤Ð
-        * ¤³¤Î´Ø¿ô¤ÎÊÖ¤êÃͤϿ®ÍѤǤ­¤Ê¤¯¤Ê¤ë.
-        */
-
        /* Drop the artifact from heaven */
        return drop_near(q_ptr, -1, y, x) ? TRUE : FALSE;
 }