OSDN Git Service

Add Doxygen comment to cmd5.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 25 Jan 2014 12:26:10 +0000 (12:26 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Sat, 25 Jan 2014 12:26:10 +0000 (12:26 +0000)
src/cmd5.c

index d4c4318..5f084fd 100644 (file)
 
 #include "angband.h"
 
+/*!
+ * @brief ÎΰèËâË¡¤Ë±þ¤¸¤Æµ»Ç½¤Î̾¾Î¤òÊÖ¤¹¡£
+ * @param tval ËâË¡½ñ¤Îtval
+ * @return ÎΰèËâË¡¤Îµ»Ç½Ì¾¾Î¤òÊݴɤ·¤¿Ê¸»úÎó¥Ý¥¤¥ó¥¿
+ */
 cptr spell_category_name(int tval)
 {
        switch (tval)
@@ -39,19 +44,27 @@ 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¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
+ * @param prompt ËâË¡¤òÍøÍѤ¹¤ëºÝ¤ÎÆ°»ìɽµ­
+ * @param sval ËâÆ»½ñ¤Îsval
+ * @param learned ±ÜÍ÷/»ÈÍÑÁªÂò¤Ê¤é¤ÐTRUE¡¢³Ø½¬½èÍý¤Ê¤éFALSE
+ * @param use_realm ËâË¡ÎΰèID
+ * @return
+ * <pre>
  * If a valid spell is chosen, saves it in '*sn' and returns TRUE
  * If the user hits escape, returns FALSE, and set '*sn' to -1
  * If there are no legal choices, returns FALSE, and sets '*sn' to -2
  *
  * The "prompt" should be "cast", "recite", or "study"
  * The "known" should be TRUE for cast/pray, FALSE for study
+ * </pre>
  */
-
-bool select_the_force = FALSE;
-
 static int get_spell(int *sn, cptr prompt, int sval, bool learned, int use_realm)
 {
        int         i;
@@ -334,7 +347,11 @@ static int get_spell(int *sn, cptr prompt, int sval, bool learned, int use_realm
        return TRUE;
 }
 
-
+/*
+ * @brief ¥ª¥Ö¥¸¥§¥¯¥È¤¬¥×¥ì¥¤¥ä¡¼¤¬»ÈÍѲÄǽ¤ÊËâÆ»½ñ¤«¤É¤¦¤«¤òȽÄꤹ¤ë
+ * @param È½Äꤷ¤¿¤¤¥ª¥Ö²ñ¥¸¥§¥¯¥È¤Î¹½Â¤Âλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ³Ø½¬¤Ç¤­¤ëËâÆ»½ñ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 static bool item_tester_learn_spell(object_type *o_ptr)
 {
        s32b choices = realm_choices2[p_ptr->pclass];
@@ -359,7 +376,10 @@ static bool item_tester_learn_spell(object_type *o_ptr)
        return (FALSE);
 }
 
-
+/*
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬ËâÆ»½ñ¤ò°ìºý¤â»ý¤Ã¤Æ¤¤¤Ê¤¤¤«¤òȽÄꤹ¤ë
+ * @return ËâÆ»½ñ¤ò°ìºý¤â»ý¤Ã¤Æ¤¤¤Ê¤¤¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 static bool player_has_no_spellbooks(void)
 {
        int         i;