OSDN Git Service

Fix Doxygen warning in object2.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sun, 12 Jan 2014 05:15:04 +0000 (05:15 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sun, 12 Jan 2014 05:15:04 +0000 (05:15 +0000)
src/object2.c

index 6c17442..ff294ee 100644 (file)
@@ -1474,21 +1474,21 @@ bool can_player_destroy_object(object_type *o_ptr)
 }
 
 
-/*
+/*!
+ * @brief ËâË¡ËÀ¤ä¥í¥Ã¥É¤Î¥¹¥í¥Ã¥Èʬ³ä»þ¤Ë»ÈÍѲó¿ô¤òʬÇÛ¤¹¤ë /
  * Distribute charges of rods or wands.
- *
- * o_ptr = source item
- * q_ptr = target item, must be of the same type as o_ptr
- * amt   = number of items that are transfered
+ * @param o_ptr Ê¬³ä¸µ¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿ source item
+ * @param q_ptr Ê¬³äÀ襪¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿ target item, must be of the same type as o_ptr
+ * @param amt Ê¬³ä¤·¤¿¤¤²ó¿ôÎÌ number of items that are transfered
+ * @return ¤Ê¤·
+ * @details
+ * Hack -- If rods or wands are dropped, the total maximum timeout or\n
+ * charges need to be allocated between the two stacks.  If all the items\n
+ * are being dropped, it makes for a neater message to leave the original\n
+ * stack's pval alone. -LM-\n
  */
 void distribute_charges(object_type *o_ptr, object_type *q_ptr, int amt)
 {
-       /*
-        * Hack -- If rods or wands are dropped, the total maximum timeout or
-        * charges need to be allocated between the two stacks.  If all the items
-        * are being dropped, it makes for a neater message to leave the original
-        * stack's pval alone. -LM-
-        */
        if ((o_ptr->tval == TV_WAND) || (o_ptr->tval == TV_ROD))
        {
                q_ptr->pval = o_ptr->pval * amt / o_ptr->number;
@@ -1510,13 +1510,18 @@ void distribute_charges(object_type *o_ptr, object_type *q_ptr, int amt)
        }
 }
 
+/*!
+ * @brief ËâË¡ËÀ¤ä¥í¥Ã¥É¤Î»ÈÍѲó¿ô¤ò¸º¤é¤¹ /
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿ source item
+ * @param amt ¸º¤é¤·¤¿¤¤²ó¿ôÎÌ number of items that are transfered
+ * @return ¤Ê¤·
+ * @details
+ * Hack -- If rods or wand are destroyed, the total maximum timeout or\n
+ * charges of the stack needs to be reduced, unless all the items are\n
+ * being destroyed. -LM-\n
+ */
 void reduce_charges(object_type *o_ptr, int amt)
 {
-       /*
-        * Hack -- If rods or wand are destroyed, the total maximum timeout or
-        * charges of the stack needs to be reduced, unless all the items are
-        * being destroyed. -LM-
-        */
        if (((o_ptr->tval == TV_WAND) || (o_ptr->tval == TV_ROD)) &&
                (amt < o_ptr->number))
        {
@@ -1524,7 +1529,6 @@ void reduce_charges(object_type *o_ptr, int amt)
        }
 }
 
-
 /*
  * Determine if an item can "absorb" a second item
  *
@@ -1553,8 +1557,11 @@ void reduce_charges(object_type *o_ptr, int amt)
 
 
 /*
- *  Determine if an item can partly absorb a second item.
- *  Return maximum number of stack.
+ * @brief Î¾¥ª¥Ö¥¸¥§¥¯¥È¤ò¥¹¥í¥Ã¥È¤Ë½Å¤Í¹ç¤ï¤»²Äǽ¤ÊºÇÂç¿ô¤òÊÖ¤¹¡£
+ * Determine if an item can partly absorb a second item. Return maximum number of stack.
+ * @param o_ptr ¸¡¾Ú¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿1
+ * @param j_ptr ¸¡¾Ú¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿2
+ * @return ½Å¤Í¹ç¤ï¤»²Äǽ¤Ê¥¢¥¤¥Æ¥à¿ô
  */
 int object_similar_part(object_type *o_ptr, object_type *j_ptr)
 {
@@ -1757,7 +1764,11 @@ int object_similar_part(object_type *o_ptr, object_type *j_ptr)
 }
 
 /*
- *  Determine if an item can absorb a second item.
+ * @brief Î¾¥ª¥Ö¥¸¥§¥¯¥È¤¬¥¹¥í¥Ã¥È¤Ë½Å¤Í¤ë¤³¤È¤¬¤Ç¤­¤ë¤«¤É¤¦¤«¤òÊÖ¤¹¡£
+ * Determine if an item can absorb a second item.
+ * @param o_ptr ¸¡¾Ú¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿1
+ * @param j_ptr ¸¡¾Ú¤·¤¿¤¤¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿2
+ * @return ½Å¤Í¹ç¤ï¤»²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  */
 bool object_similar(object_type *o_ptr, object_type *j_ptr)
 {