Add Doxygen comment to cmd5.c.

diff --git a/src/cmd5.c b/src/cmd5.c
index 5f084fd..41a716f 100644 (file)
--- a/src/cmd5.c
+++ b/src/cmd5.c
@@ -47,7 +47,7 @@ cptr spell_category_name(int tval)
 
 bool select_the_force = FALSE;
 
-/*
+/*!
  * @brief ÎΰèËâË¡¤Î±ÜÍ÷¡¢³Ø½¬¡¢»ÈÍÑÁªÂò¤¹¤ë¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹½èÍý
  * Allow user to choose a spell/prayer from the given book.
  * @param sn ÁªÂò¤·¤¿ËâË¡ID¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
@@ -347,7 +347,7 @@ static int get_spell(int *sn, cptr prompt, int sval, bool learned, int use_realm
        return TRUE;
 }
 
-/*
+/*!
  * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¥×¥ì¥¤¥ä¡¼¤¬»ÈÍѲÄǽ¤ÊËâÆ»½ñ¤«¤É¤¦¤«¤òȽÄꤹ¤ë
  * @param ȽÄꤷ¤¿¤¤¥ª¥Ö²ñ¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
  * @return ³Ø½¬¤Ç¤­¤ëËâÆ»½ñ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
@@ -376,7 +376,7 @@ static bool item_tester_learn_spell(object_type *o_ptr)
        return (FALSE);
 }
 
-/*
+/*!
  * @brief ¥×¥ì¥¤¥ä¡¼¤¬ËâÆ»½ñ¤ò°ìºý¤â»ý¤Ã¤Æ¤¤¤Ê¤¤¤«¤òȽÄꤹ¤ë
  * @return ËâÆ»½ñ¤ò°ìºý¤â»ý¤Ã¤Æ¤¤¤Ê¤¤¤Ê¤éTRUE¤òÊÖ¤¹
  */
@@ -400,7 +400,11 @@ static bool player_has_no_spellbooks(void)
        return TRUE;
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶È¤¬Îýµ¤½Ñ»Õ¤Î»þ¡¢ÎΰèËâË¡¤ÈÎýµ¤½Ñ¤òÀڤ괹¤¨¤ë½èÍý¤Î¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹
+ * @param browse_only ËâË¡¤Èµ»Ç½¤Î±ÜÍ÷¤ò¹Ô¤¦¤Ê¤é¤ÐTRUE
+ * @return ËâÆ»½ñ¤ò°ìºý¤â»ý¤Ã¤Æ¤¤¤Ê¤¤¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 static void confirm_use_force(bool browse_only)
 {
        int  item;
@@ -453,13 +457,17 @@ static void confirm_use_force(bool browse_only)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎËâË¡¤Èµ»Ç½¤ò±ÜÍ÷¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Peruse the spells/prayers in a book
- *
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * Note that *all* spells in the book are listed
  *
  * Note that browsing is allowed while confused or blind,
  * and in the dark, primarily to allow browsing in stores.
+ * </pre>
  */
 void do_cmd_browse(void)
 {
@@ -630,7 +638,11 @@ void do_cmd_browse(void)
        screen_load();
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÂèÆóËâË¡Îΰè¤òÊѹ¹¤¹¤ë /
+ * @param Êѹ¹Àè¤ÎËâË¡ÎΰèID
+ * @return ¤Ê¤·
+ */
 static void change_realm2(int next_realm)
 {
        int i, j = 0;
@@ -670,8 +682,10 @@ static void change_realm2(int next_realm)
 }
 
 
-/*
+/*!
+ * @brief ËâË¡¤ò³Ø½¬¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Study a book to gain a new spell/prayer
+ * @return ¤Ê¤·
  */
 void do_cmd_study(void)
 {
@@ -1107,8 +1121,10 @@ static void wild_magic(int spell)
 }
 
 
-/*
+/*!
+ * @brief ËâË¡¤ò±Ó¾§¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó /
  * Cast a spell
+ * @return ¤Ê¤·
  */
 void do_cmd_cast(void)
 {
@@ -1644,7 +1660,14 @@ msg_print("
        p_ptr->window |= (PW_SPELL);
 }
 
-
+/*!
+ * @brief ¥Ú¥Ã¥È¤Ë¤Ê¤Ã¤Æ¤¤¤ë¥â¥ó¥¹¥¿¡¼¤ò¥½¡¼¥È¤¹¤ë¤¿¤á¤ÎÈæ³Ó½èÍý
+ * @param u ¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤ÂÎÇÛÎó
+ * @param v ̤»ÈÍÑ
+ * @param a Èæ³ÓÂоݤΥâ¥ó¥¹¥¿¡¼ID1
+ * @param b Èæ³ÓÂоݤΥâ¥ó¥¹¥¿¡¼ID2
+ * @return 2ÈÖÌܤ¬Âç¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 static bool ang_sort_comp_pet_dismiss(vptr u, vptr v, int a, int b)
 {
        u16b *who = (u16b*)(u);
@@ -1681,6 +1704,12 @@ static bool ang_sort_comp_pet_dismiss(vptr u, vptr v, int a, int b)
        return w1 <= w2;
 }
 
+/*!
+ * @brief ¥Ú¥Ã¥È¤ÎÁ±°­Â°À­¤Ë±þ¤¸¤¿°Ý»ý¥³¥¹¥È¤ÎÅÓÃæ·×»»½èÍý
+ * @param m_ptr ·×»»´ð½à¤È¤Ê¤ë¥â¥ó¥¹¥¿¡¼¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @param inc m_ptr¤Ç»ØÄꤷ¤¿¥â¥ó¥¹¥¿¡¼¤ò°Ý»ý¥³¥¹¥È·×»»¤Ë²Ã¤¨¤ë¤Ê¤éTRUE¡¢³°¤¹¤Ê¤éFALSE¤ò»ØÄê
+ * @return ¤Ê¤·
+ */
 void check_pets_num_and_align(monster_type *m_ptr, bool inc)
 {
        s32b old_friend_align = friend_align;
@@ -1702,6 +1731,10 @@ void check_pets_num_and_align(monster_type *m_ptr, bool inc)
        if (old_friend_align != friend_align) p_ptr->update |= (PU_BONUS);
 }
 
+/*!
+ * @brief ¥Ú¥Ã¥È¤Î°Ý»ý¥³¥¹¥È·×»»
+ * @return °Ý»ý¥³¥¹¥È(%)
+ */
 int calculate_upkeep(void)
 {
        s32b old_friend_align = friend_align;