OSDN Git Service

Fix Doxygen warning in obj_kind.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 10 Jan 2014 12:35:19 +0000 (12:35 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 10 Jan 2014 12:35:19 +0000 (12:35 +0000)
src/obj_kind.c

index c570150..9812c31 100644 (file)
@@ -296,8 +296,11 @@ bool object_refuse_enchant_weapon(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¶¯²½²ÄǽÉð´ï¤Ç¤¢¤ë¤«¤òÊÖ¤¹ /
  * Check if an object is weapon (including bows and ammo) and allows enchantment
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¶¯²½²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_allow_enchant_weapon(object_type *o_ptr)
 {
@@ -307,8 +310,11 @@ bool object_allow_enchant_weapon(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¶¯²½²Äǽ¤Ê¶áÀÜÉð´ï¤Ç¤¢¤ë¤«¤òÊÖ¤¹ /
  * Check if an object is melee weapon and allows enchantment
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¶¯²½²Äǽ¤Ê¶áÀÜÉð´ï¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_allow_enchant_melee_weapon(object_type *o_ptr)
 {
@@ -318,8 +324,11 @@ bool object_allow_enchant_melee_weapon(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬ÃÃÌê»Õ¤Î¥¨¥Ã¥»¥ó¥¹ÉղúѤߤ«¤òÊÖ¤¹ /
  * Check if an object is made by a smith's special ability
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¥¨¥Ã¥»¥ó¥¹ÉղúѤߤʤé¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_is_smith(object_type *o_ptr)
 {
@@ -328,9 +337,11 @@ bool object_is_smith(object_type *o_ptr)
        return FALSE;
 }
 
-
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤«¤òÊÖ¤¹ /
  * Check if an object is artifact
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_is_artifact(object_type *o_ptr)
 {
@@ -340,8 +351,11 @@ bool object_is_artifact(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤«¤òÊÖ¤¹ /
  * Check if an object is random artifact
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¥é¥ó¥À¥à¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_is_random_artifact(object_type *o_ptr)
 {
@@ -350,9 +364,11 @@ bool object_is_random_artifact(object_type *o_ptr)
        return FALSE;
 }
 
-
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬Ä̾ï¤Î¥¢¥¤¥Æ¥à(¥¢¡¼¥Æ¥£¥Õ¥¡¥¯¥È¡¢¥¨¥´¡¢ÃÃÌê»Õ¥¨¥Ã¥»¥ó¥¹Éղ䤤º¤ì¤Ç¤â¤Ê¤¤)¤«¤òÊÖ¤¹ /
  * Check if an object is neither artifact, ego, nor 'smith' object
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return Ä̾ï¤Î¥¢¥¤¥Æ¥à¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_is_nameless(object_type *o_ptr)
 {
@@ -363,8 +379,11 @@ bool object_is_nameless(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬Î¾¼ê»ý¤Á²Äǽ¤ÊÉð´ï¤«¤òÊÖ¤¹ /
  * Check if an object is melee weapon and allows wielding with two-hands
+ * @param o_ptr ÂоݤΥª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return Î¾¼ê»ý¤Á²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
  */
 bool object_allow_two_hands_wielding(object_type *o_ptr)
 {