OSDN Git Service

Add Doxygen comment to flavor.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 3 Jan 2014 14:27:47 +0000 (14:27 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Fri, 3 Jan 2014 14:27:47 +0000 (14:27 +0000)
src/flavor.c

index 75d7fc1..30d3abf 100644 (file)
@@ -549,7 +549,7 @@ char *object_desc_kosuu(char *t, object_type *o_ptr)
 /*!
  * @brief ÂоÝʸ»úÇÛÎó¤ËÉä¹æ¤¢¤êÀ°¿ôÃͤò¥³¥Ô¡¼¤¹¤ë¡£
  * @param t ÊÝ´ÉÀèʸ»úÎó¥Ý¥¤¥ó¥¿
- * @param n ¥³¥Ô¡¼¤·¤¿¤¤¿ôÃÍ
+ * @param v ¥³¥Ô¡¼¤·¤¿¤¤¿ôÃÍ
  * @return ¤Ê¤·
  * @details
  * Print an signed number "v" into a string "t", as if by
@@ -961,11 +961,20 @@ static flag_insc_table flag_insc_sust[] =
 };
 #endif
 
-/* Simple macro for get_inscription() */
+/* ¥ª¥Ö¥¸¥§¥¯¥È¥Õ¥é¥°¤òÄɲ乤뤿¤á¤Î´Ê°×¤Ê¥Þ¥¯¥í / Simple macro for get_inscription() */
 #define ADD_INSC(STR) (void)(ptr = object_desc_str(ptr, (STR)))
 
-/*
- *  Helper function for get_inscription()
+/*!
+ * @brief get_inscription¤Î¥µ¥Ö¥»¥Ã¥È¤È¤·¤Æ¥ª¥Ö¥¸¥§¥¯¥È¤ÎÆÃÀ­¥Õ¥é¥°¤òÊÖ¤¹ / Helper function for get_inscription()
+ * @param fi_ptr »²¾È¤¹¤ëÆÃÀ­É½¼¨µ­¹æ¥Æ¡¼¥Ö¥ë
+ * @param flgs Âбþ¤¹¤ë¥ª¥Ö¥¸¥§¥¯¥È¤Î¥Õ¥é¥°Ê¸»úÎó
+ * @param kanji TRUE¤Ê¤é¤Ð´Á»úµ­½Ò/FALSE¤Ê¤é¤Ð±Ñ¸ìµ­½Ò
+ * @param ptr ¥Õ¥é¥°·²¤òÊݴɤ¹¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿
+ * @return ¥Õ¥é¥°·²¤òÊݴɤ¹¤ëʸ»úÎ󻲾ȥݥ¤¥ó¥¿(ptr¤ÈƱ¤¸)
+ * @details
+ * Print an signed number "v" into a string "t", as if by
+ * sprintf(t, "%+d", n), and return a pointer to the terminator.
+ * Note that we always print a sign, either "+" or "-".
  */
 static char *inscribe_flags_aux(flag_insc_table *fi_ptr, u32b flgs[TR_FLAG_SIZE], bool kanji, char *ptr)
 {