OSDN Git Service

Fix Doxygen warning.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Wed, 8 Jan 2014 13:19:21 +0000 (13:19 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Wed, 8 Jan 2014 13:19:21 +0000 (13:19 +0000)
Add Doxygen comment to racial.c.

src/racial.c
src/rooms.c

index c129db9..4e0468b 100644 (file)
@@ -1,19 +1,22 @@
-/* File: racial.c */
-
-/*
- * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
- *
- * This software may be copied and distributed for educational, research,
- * and not for profit purposes provided that this copyright and statement
- * are included in all such copies.  Other copyrights may also apply.
+/*!
+ * @file racial.c
+ * @brief ¥ì¥¤¥·¥ã¥ë¤ÈÆÍÁ³ÊѰۤε»Ç½½èÍý / Racial powers (and mutations)
+ * @date 2014/01/08
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\n
+ * This software may be copied and distributed for educational, research,\n
+ * and not for profit purposes provided that this copyright and statement\n
+ * are included in all such copies.  Other copyrights may also apply.\n
+ * 2014 Deskull rearranged comment for Doxygen. \n
  */
 
-/* Purpose: Racial powers (and mutations) */
-
 #include "angband.h"
 
 /*
+ * @brief ÂоݤΥ¢¥¤¥Æ¥à¤¬Ìð¤ä¥¯¥í¥¹¥Ü¥¦¤ÎÌð¤ÎºàÎÁ¤Ë¤Ê¤ë¤«¤òÊÖ¤¹¡£/
  * Hook to determine if an object is contertible in an arrow/bolt
+ * @param o_ptr ¥ª¥Ö¥¸¥§¥¯¥È¤Î¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿¡£
+ * @return ºàÎÁ¤Ë¤Ç¤­¤ë¤Ê¤éTRUE¤òÊÖ¤¹
  */
 static bool item_tester_hook_convertible(object_type *o_ptr)
 {
@@ -24,10 +27,10 @@ static bool item_tester_hook_convertible(object_type *o_ptr)
        return (FALSE);
 }
 
-
 /*
- * do_cmd_cast calls this function if the player's class
- * is 'archer'.
+ * @brief ¥ì¥¤¥·¥ã¥ë¡ÖÃÆ/Ìð¤ÎÀ½Â¤¡×½èÍý / do_cmd_cast calls this function if the player's class is 'archer'.
+ * Hook to determine if an object is contertible in an arrow/bolt
+ * @return À½Â¤¤ò¼ÂºÝ¤Ë¹Ô¤Ã¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹
  */
 static bool do_cmd_archer(void)
 {
@@ -304,6 +307,10 @@ static bool do_cmd_archer(void)
        return TRUE;
 }
 
+/*
+ * @brief ËâÆ»¶ñ½Ñ»Õ¤ÎËâÎϼè¤ê¹þ¤ß½èÍý
+ * @return ¼è¤ê¹þ¤ß¤ò¼Â¹Ô¤·¤¿¤éTRUE¡¢¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹
+ */
 bool gain_magic(void)
 {
        int item;
@@ -430,7 +437,10 @@ s = "
        return TRUE;
 }
 
-
+/*
+ * @brief ËâË¡·Ï¥³¥Þ¥ó¥É¤ò¼Â¹Ô¤Ç¤­¤ë¤«¤ÎȽÄê¤òÊÖ¤¹
+ * @return ËâË¡·Ï¥³¥Þ¥ó¥É¤ò»ÈÍѲÄǽ¤Ê¤éTRUE¡¢ÉÔ²Äǽ¤Ê¤é¤ÐÍýͳ¤ò¥á¥Ã¥»¡¼¥¸É½¼¨¤·¤ÆFALSE¤òÊÖ¤¹¡£
+ */
 static bool can_do_cmd_cast(void)
 {
        if (dun_level && (d_info[dungeon_type].flags1 & DF1_NO_MAGIC))
@@ -465,7 +475,10 @@ static bool can_do_cmd_cast(void)
                return TRUE;
 }
 
-
+/*
+ * @brief ½¤¹ÔÁΤ齤¨ÀßÄê½èÍý
+ * @return ¹½¤¨¤òÊѲ½¤µ¤»¤¿¤éTRUE¡¢¹½¤¨ÉÔǽ¤«¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹¡£
+ */
 static bool choose_kamae(void)
 {
        char choice;
@@ -580,6 +593,10 @@ static bool choose_kamae(void)
        return TRUE;
 }
 
+/*
+ * @brief ·õ½Ñ²È¤Î·¿ÀßÄê½èÍý
+ * @return ·¿¤òÊѲ½¤µ¤»¤¿¤éTRUE¡¢·¿¤Î¹½¤¨ÉÔǽ¤«¥­¥ã¥ó¥»¥ë¤·¤¿¤éFALSE¤òÊÖ¤¹¡£
+ */
 static bool choose_kata(void)
 {
        char choice;
index 82ccd7c..24ecb45 100644 (file)
@@ -303,8 +303,8 @@ static void check_room_boundary(int x1, int y1, int x2, int y2)
  * @brief
  * find_space()¤ÎͽÈ÷½èÍý¤È¤·¤ÆÉô²°¤ÎÀ¸À®¤¬²Äǽ¤«¤òȽÄꤹ¤ë /
  * Helper function for find_space(). Is this a good location?
- * @param block_high ÈϰϤι⤵
- * @param block_wide ÈϰϤÎÉý
+ * @param blocks_high ÈϰϤι⤵
+ * @param blocks_wide ÈϰϤÎÉý
  * @param block_y ÈϰϤξåü
  * @param block_x ÈϰϤκ¸Ã¼
  * @return ¤Ê¤·
@@ -2451,13 +2451,13 @@ static bool build_type5(void)
  * The inside room in a monster pit appears as shown below, where the\n
  * actual monsters in each location depend on the type of the pit\n
  *\n
- *   #####################\n
- *   #0000000000000000000#\n
- *   #0112233455543322110#\n
- *   #0112233467643322110#\n
- *   #0112233455543322110#\n
- *   #0000000000000000000#\n
- *   #####################\n
+ *   XXXXXXXXXXXXXXXXXXXXX\n
+ *   X0000000000000000000X\n
+ *   X0112233455543322110X\n
+ *   X0112233467643322110X\n
+ *   X0112233455543322110X\n
+ *   X0000000000000000000X\n
+ *   XXXXXXXXXXXXXXXXXXXXX\n
  *\n
  * Note that the monsters in the pit are now chosen by using "get_mon_num()"\n
  * to request 16 "appropriate" monsters, sorting them by level, and using\n
@@ -5727,19 +5727,19 @@ static bool vault_aux_trapped_pit(int r_idx)
  * The trapped monster pit appears as shown below, where the actual\n
  * monsters in each location depend on the type of the pit\n
  *\n
- *  #########################\n
- *  #                       #\n
- *  ####################### #\n
- *  #####001123454321100### #\n
- *  ###0012234567654322100# #\n
- *  ####################### #\n
- *  #           ^           #\n
- *  # #######################\n
- *  # #0012234567654322100###\n
- *  # ###001123454321100#####\n
- *  # #######################\n
- *  #                       #\n
- *  #########################\n
+ *  XXXXXXXXXXXXXXXXXXXXXXXXX\n
+ *  X                       X\n
+ *  XXXXXXXXXXXXXXXXXXXXXXX X\n
+ *  XXXXX001123454321100XXX X\n
+ *  XXX0012234567654322100X X\n
+ *  XXXXXXXXXXXXXXXXXXXXXXX X\n
+ *  X           ^           X\n
+ *  X XXXXXXXXXXXXXXXXXXXXXXX\n
+ *  X X0012234567654322100XXX\n
+ *  X XXX001123454321100XXXXX\n
+ *  X XXXXXXXXXXXXXXXXXXXXXXX\n
+ *  X                       X\n
+ *  XXXXXXXXXXXXXXXXXXXXXXXXX\n
  *\n
  * Note that the monsters in the pit are now chosen by using "get_mon_num()"\n
  * to request 16 "appropriate" monsters, sorting them by level, and using\n