Add Doxygen comment to bldg.c.

diff --git a/src/avatar.c b/src/avatar.c
index 8ec082a..dcc7917 100644 (file)
--- a/src/avatar.c
+++ b/src/avatar.c
@@ -114,7 +114,7 @@ int virtue_number(int type)
 /*!
  * @brief ¥×¥ì¥¤¥ä¡¼¤Î¿¦¶È¤ä¼ï²¤Ë°Í¸¤·¤Ê¤¤¥é¥ó¥À¥à¤ÊÆÁ¤ò¼èÆÀ¤¹¤ë / Aux function
  * @param which ³Îǧ¤·¤¿¤¤ÆÁ¤ÎID
- * @return ÅÐÏ¿¤·¤¿¤¤ÆÁ¤Î¥¹¥í¥Ã¥ÈID(0¡Á7)¡£
+ * @return ¤Ê¤·
  */
 static void get_random_virtue(int which)
 {

diff --git a/src/bldg.c b/src/bldg.c
index 7afeadc..11829a9 100644 (file)
--- a/src/bldg.c
+++ b/src/bldg.c
@@ -1,21 +1,32 @@
-/* File: bldg.c */
-
-/*
- * Purpose: Building commands
- * Created by Ken Wigle for Kangband - a variant of Angband 2.8.3
- * -KMW-
- *
- * Rewritten for Kangband 2.8.3i using Kamband's version of
- * bldg.c as written by Ivan Tkatchev
- *
- * Changed for ZAngband by Robert Ruehlmann
- */
+/*!
+    @file bldg.c
+    @brief Ä®¤Î»ÜÀß½èÍý / Building commands
+    @date 2013/12/23
+    @author
+    Created by Ken Wigle for Kangband - a variant of Angband 2.8.3\n
+    -KMW-\n
+    \n
+    Rewritten for Kangband 2.8.3i using Kamband's version of\n
+    bldg.c as written by Ivan Tkatchev\n
+    \n
+    Changed for ZAngband by Robert Ruehlmann\n
+*/
 
 #include "angband.h"
 
-/* hack as in leave_store in store.c */
+
+/*!
+ * ¥ë¡¼¥×Ãæ¤Ç / hack as in leave_store in store.c
+ */
 static bool leave_bldg = FALSE;
 
+/*!
+ * @brief »ÜÀßËè¤ËÀßÄꤵ¤ì¤¿¼ï²¡¢¿¦¶È¡¢ËâË¡Îΰè¥Õ¥é¥°¤¬¥×¥ì¥¤¥ä¡¼¤È°ìÃפ¹¤ë¤«¤òȽÄꤹ¤ë¡£
+ * @details ³Æ¼ï¥®¥ë¥É¤ä»û±¡¤Ê¤É¡¢ÆÃÄê¤Î¿¦¶È¤Ê¤é¤ÐÍ¥¶øÁ¼ÃÖ¤òÆÀ¤é¤ì¤ë»ÜÀß¡¢
+ * ¤¢¤ë¤¤¤Ï¿©Æ²¤Ê¤ÉÆÃÄê¤Î¼ï²¤Ç¤ÏÍøÍѤǤ­¤Ê¤¤»ÜÀߤÎȽÄê½èÍý¤ò¹Ô¤¦¡£
+ * @param bldg »ÜÀß¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¼ï²¡¢¿¦¶È¡¢ËâË¡Îΰè¤Î¤¤¤º¤ì¤«¤¬°ìÃפ·¤Æ¤¤¤ë¤«¤ÎÀ§Èó¡£
+ */
 static bool is_owner(building_type *bldg)
 {
        if (bldg->member_class[p_ptr->pclass] == BUILDING_OWNER)
@@ -37,7 +48,15 @@ static bool is_owner(building_type *bldg)
        return (FALSE);
 }
 
-
+/*!
+ * @brief »ÜÀßËè¤ËÀßÄꤵ¤ì¤¿¼ï²¡¢¿¦¶È¡¢ËâË¡Îΰè¥Õ¥é¥°¤¬¥×¥ì¥¤¥ä¡¼¤È°ìÃפ¹¤ë¤«¤òȽÄꤹ¤ë¡£
+ ¡Ê¥¹¥Ú¥ë¥Þ¥¹¥¿¡¼¤ÎÆÃÊÌȽÄê¤Ä¤­¡Ë
+ * @details ³Æ¼ï¥®¥ë¥É¤ä»û±¡¤Ê¤É¡¢ÆÃÄê¤Î¿¦¶È¤Ê¤é¤ÐÍ¥¶øÁ¼ÃÖ¤òÆÀ¤é¤ì¤ë»ÜÀß¡¢
+ * ¤¢¤ë¤¤¤Ï¿©Æ²¤Ê¤ÉÆÃÄê¤Î¼ï²¤Ç¤ÏÍøÍѤǤ­¤Ê¤¤»ÜÀߤÎȽÄê½èÍý¤ò¹Ô¤¦¡£
+ * @param bldg »ÜÀß¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¼ï²¡¢¿¦¶È¡¢ËâË¡Îΰè¤Î¤¤¤º¤ì¤«¤¬°ìÃפ·¤Æ¤¤¤ë¤«¤ÎÀ§Èó¡£
+ * @todo is_owner()¤È¤Î¼Â¼ÁŪ¤Ê¿½Å¼ÂÁõ¤Ê¤Î¤Ç¡¢¥ê¥Õ¥¡¥¯¥¿¥ê¥ó¥°¤ò¹Ô¤¦¤Ù¤­¤Ç¤¢¤ë¡£
+ */
 static bool is_member(building_type *bldg)
 {
        if (bldg->member_class[p_ptr->pclass])
@@ -70,9 +89,12 @@ static bool is_member(building_type *bldg)
        return (FALSE);
 }
 
-
-/*
- * Clear the building information
+/*!
+ * @brief ¥³¥ó¥½¡¼¥ë¤Ëɽ¼¨¤µ¤ì¤¿»ÜÀߤ˴ؤ¹¤ë¾ðÊó¤ò¾Ãµî¤¹¤ë / Clear the building information
+ * @details ¾Ãµî¤Ï¹ÔËè¤Ë¥Ì¥ëʸ»úÎó¤Ç¹Ô¤ï¤ì¤ë¡£
+ * @param min_row ³«»Ï¹ÔÈÖ¹æ
+ * @param max_row ËöÈø¹ÔÈÖ¹æ
+ * @return ¤Ê¤·
  */
 static void clear_bldg(int min_row, int max_row)
 {
@@ -82,6 +104,11 @@ static void clear_bldg(int min_row, int max_row)
                prt("", i, 0);
 }
 
+/*!
+ * @brief ½ê»ý¶â¤òɽ¼¨¤¹¤ë¡£
+ * @param ¤Ê¤·
+ * @return ¤Ê¤·
+ */
 static void building_prt_gold(void)
 {
        char tmp_str[80];
@@ -97,9 +124,10 @@ prt("
        prt(tmp_str, 23, 68);
 }
 
-
-/*
- * Display a building.
+/*!
+ * @brief »ÜÀߤΥµ¡¼¥Ó¥¹°ìÍ÷¤òɽ¼¨¤¹¤ë / Display a building.
+ * @param bldg »ÜÀß¹½Â¤ÂΤλ²¾È¥Ý¥¤¥ó¥¿
+ * @return ¤Ê¤·
  */
 static void show_building(building_type* bldg)
 {
@@ -227,9 +255,10 @@ prt(" ESC) 
 
 }
 
-
-/*
- * arena commands
+/*!
+ * @brief Æ®µ»¾ì¤ËÆþ¤ë¥³¥Þ¥ó¥É¤Î½èÍý / arena commands
+ * @param cmd Æ®µ»¾ì½èÍý¤ÎID
+ * @return ¤Ê¤·
  */
 static void arena_comm(int cmd)
 {
@@ -389,9 +418,12 @@ msg_format("%s 
        }
 }
 
-
-/*
- * display fruit for dice slots
+/*!
+ * @brief ¥«¥¸¥Î¤Î¥¹¥í¥Ã¥È¥·¥ó¥Ü¥ë¤òɽ¼¨¤¹¤ë / display fruit for dice slots
+ * @param row ¥·¥ó¥Ü¥ë¤òɽ¼¨¤¹¤ë¹Ô¤Î¾åü
+ * @param col ¥·¥ó¥Ü¥ë¤òɽ¼¨¤¹¤ë¹Ô¤Îº¸Ã¼
+ * @param fruit ɽ¼¨¤¹¤ë¥·¥ó¥Ü¥ëID
+ * @return ¤Ê¤·
  */
 static void display_fruit(int row, int col, int fruit)
 {