Add Doxygen comment to flavor.c.

diff --git a/src/flavor.c b/src/flavor.c
index 30d3abf..0f3a689 100644 (file)
--- a/src/flavor.c
+++ b/src/flavor.c
@@ -998,8 +998,11 @@ static char *inscribe_flags_aux(flag_insc_table *fi_ptr, u32b flgs[TR_FLAG_SIZE]
 }
 
 
-/*
- *  Special variation of have_flag for auto-inscription
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤ÎÆÃÀ­É½¼¨µ­¹æ¥Æ¡¼¥Ö¥ë1¤Ä¤Ë½¾¤¤¥ª¥Ö¥¸¥§¥¯¥È¤ÎÆÃÀ­¥Õ¥é¥°ÇÛÎó¤Ë1¤Ä¤Ç¤â³ºÅö¤ÎÆÃÀ­¤¬¤¢¤ë¤«¤òÊÖ¤¹ / Special variation of have_flag for auto-inscription
+ * @param fi_ptr »²¾È¤¹¤ëÆÃÀ­É½¼¨µ­¹æ¥Æ¡¼¥Ö¥ë
+ * @param flgs Âбþ¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¥Õ¥é¥°Ê¸»úÎó
+ * @return 1¤Ä¤Ç¤â³ºÅö¤ÎÆÃÀ­¤¬¤¢¤Ã¤¿¤éTRUE¤òÊÖ¤¹¡£
  */
 static bool have_flag_of(flag_insc_table *fi_ptr, u32b flgs[TR_FLAG_SIZE])
 {
@@ -1014,6 +1017,14 @@ static bool have_flag_of(flag_insc_table *fi_ptr, u32b flgs[TR_FLAG_SIZE])
        return (FALSE);
 }
 
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È̾¤ÎÆÃÀ­Ã»½Ìɽµ­¤ò¤Þ¤È¤á¤ÆÄ󼨤¹¤ë¡£
+ * @param ptr ÆÃÀ­Ã»½Ìɽµ­¤ò³ÊǼ¤¹¤ëʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @param o_ptr ÆÃÀ­Ã»½Ìɽµ­¤òÆÀ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @param kanji TRUE¤Ê¤é¤Ð´Á»úɽµ­ / FALSE¤Ê¤é±Ñ¸ìɽµ­
+ * @param all TRUE¤Ê¤é¤Ð¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¾å¤ÇÌÀ¤é¤«¤Ê¥Õ¥é¥°¤Ï¾Êά¤¹¤ë
+ * @return ptr¤ÈƱ¤¸¥¢¥É¥ì¥¹
+ */
 static char *get_ability_abbreviation(char *ptr, object_type *o_ptr, bool kanji, bool all)
 {
        char *prev_ptr = ptr;
@@ -1161,8 +1172,11 @@ static char *get_ability_abbreviation(char *ptr, object_type *o_ptr, bool kanji,
 }
 
 
-/*
- *  Get object inscription with auto inscription of object flags.
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È̾¤ÎÆÃÀ­Ã»½Ìɽµ­¡Ü¹ï¤ßÆâÍƤòÄ󼨤¹¤ë¡£ / Get object inscription with auto inscription of object flags.
+ * @param buff ÆÃÀ­Ã»½Ìɽµ­¤ò³ÊǼ¤¹¤ëʸ»úÎó¥Ý¥¤¥ó¥¿
+ * @param o_ptr ÆÃÀ­Ã»½Ìɽµ­¤òÆÀ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void get_inscription(char *buff, object_type *o_ptr)
 {
@@ -1236,6 +1250,11 @@ static void get_inscription(char *buff, object_type *o_ptr)
        *ptr = '\0';
 }
 
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¥¯¥¨¥¹¥È¤ÎãÀ®ÌÜŪ¤«Èݤ«¤òÊÖ¤¹¡£
+ * @param o_ptr ÆÃÀ­Ã»½Ìɽµ­¤òÆÀ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¸½ºß¥¯¥¨¥¹¥ÈãÀ®ÌÜŪ¤Î¥¢¥¤¥Æ¥à¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
+ */
 bool object_is_quest_target(object_type *o_ptr)
 {
        if (p_ptr->inside_quest)
@@ -1257,51 +1276,53 @@ bool object_is_quest_target(object_type *o_ptr)
 }
 
 
-/*
- * Creates a description of the item "o_ptr", and stores it in "out_val".
- *
- * One can choose the "verbosity" of the description, including whether
- * or not the "number" of items should be described, and how much detail
- * should be used when describing the item.
- *
- * The given "buf" must be MAX_NLEN chars long to hold the longest possible
- * description, which can get pretty long, including incriptions, such as:
- * "no more Maces of Disruption (Defender) (+10,+10) [+5] (+3 to stealth)".
- * Note that the inscription will be clipped to keep the total description
- * under MAX_NLEN-1 chars (plus a terminator).
- *
- * Note the use of "object_desc_num()" and "object_desc_int()" as hyper-efficient,
- * portable, versions of some common "sprintf()" commands.
- *
- * Note that all ego-items (when known) append an "Ego-Item Name", unless
- * the item is also an artifact, which should NEVER happen.
- *
- * Note that all artifacts (when known) append an "Artifact Name", so we
- * have special processing for "Specials" (artifact Lites, Rings, Amulets).
- * The "Specials" never use "modifiers" if they are "known", since they
- * have special "descriptions", such as "The Necklace of the Dwarves".
- *
- * Special Lite's use the "k_info" base-name (Phial, Star, or Arkenstone),
- * plus the artifact name, just like any other artifact, if known.
- *
- * Special Ring's and Amulet's, if not "aware", use the same code as normal
- * rings and amulets, and if "aware", use the "k_info" base-name (Ring or
- * Amulet or Necklace).  They will NEVER "append" the "k_info" name.  But,
- * they will append the artifact name, just like any artifact, if known.
- *
- * Hack -- Display "The One Ring" as "a Plain Gold Ring" until aware.
- *
- * Mode:
- *   OD_NAME_ONLY        : The Cloak of Death
- *   OD_NAME_AND_ENCHANT : The Cloak of Death [1,+3]
- *   OD_OMIT_INSCRIPTION : The Cloak of Death [1,+3] (+2 to Stealth)
- *   0                   : The Cloak of Death [1,+3] (+2 to Stealth) {nifty}
- *
- *   OD_OMIT_PREFIX      : Forbidden numeric prefix
- *   OD_NO_PLURAL        : Forbidden use of plural 
- *   OD_STORE            : Assume to be aware and known
- *   OD_NO_FLAVOR        : Allow to hidden flavor
- *   OD_FORCE_FLAVOR     : Get un-shuffled flavor name
+/*!
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤Î³Æɽµ­¤òÊÖ¤¹¥á¥¤¥ó´Ø¿ô / Creates a description of the item "o_ptr", and stores it in "out_val".
+ * @param o_ptr ÆÃÀ­Ã»½Ìɽµ­¤òÆÀ¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¸½ºß¥¯¥¨¥¹¥ÈãÀ®ÌÜŪ¤Î¥¢¥¤¥Æ¥à¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
+ * @details
+ * One can choose the "verbosity" of the description, including whether\n
+ * or not the "number" of items should be described, and how much detail\n
+ * should be used when describing the item.\n
+ *\n
+ * The given "buf" must be MAX_NLEN chars long to hold the longest possible\n
+ * description, which can get pretty long, including incriptions, such as:\n
+ * "no more Maces of Disruption (Defender) (+10,+10) [+5] (+3 to stealth)".\n
+ * Note that the inscription will be clipped to keep the total description\n
+ * under MAX_NLEN-1 chars (plus a terminator).\n
+ *\n
+ * Note the use of "object_desc_num()" and "object_desc_int()" as hyper-efficient,\n
+ * portable, versions of some common "sprintf()" commands.\n
+ *\n
+ * Note that all ego-items (when known) append an "Ego-Item Name", unless\n
+ * the item is also an artifact, which should NEVER happen.\n
+ *\n
+ * Note that all artifacts (when known) append an "Artifact Name", so we\n
+ * have special processing for "Specials" (artifact Lites, Rings, Amulets).\n
+ * The "Specials" never use "modifiers" if they are "known", since they\n
+ * have special "descriptions", such as "The Necklace of the Dwarves".\n
+ *\n
+ * Special Lite's use the "k_info" base-name (Phial, Star, or Arkenstone),\n
+ * plus the artifact name, just like any other artifact, if known.\n
+ *\n
+ * Special Ring's and Amulet's, if not "aware", use the same code as normal\n
+ * rings and amulets, and if "aware", use the "k_info" base-name (Ring or\n
+ * Amulet or Necklace).  They will NEVER "append" the "k_info" name.  But,\n
+ * they will append the artifact name, just like any artifact, if known.\n
+ *\n
+ * Hack -- Display "The One Ring" as "a Plain Gold Ring" until aware.\n
+ *\n
+ * Mode:\n
+ *   OD_NAME_ONLY        : The Cloak of Death\n
+ *   OD_NAME_AND_ENCHANT : The Cloak of Death [1,+3]\n
+ *   OD_OMIT_INSCRIPTION : The Cloak of Death [1,+3] (+2 to Stealth)\n
+ *   0                   : The Cloak of Death [1,+3] (+2 to Stealth) {nifty}\n
+ *\n
+ *   OD_OMIT_PREFIX      : Forbidden numeric prefix\n
+ *   OD_NO_PLURAL        : Forbidden use of plural \n
+ *   OD_STORE            : Assume to be aware and known\n
+ *   OD_NO_FLAVOR        : Allow to hidden flavor\n
+ *   OD_FORCE_FLAVOR     : Get un-shuffled flavor name\n
  */
 void object_desc(char *buf, object_type *o_ptr, u32b mode)
 {