OSDN Git Service

Add Doxygen comment to generate.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 6 Jan 2014 10:32:43 +0000 (10:32 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Mon, 6 Jan 2014 10:32:43 +0000 (10:32 +0000)
src/generate.c

index 133c648..0b1ba9d 100644 (file)
@@ -373,14 +373,15 @@ msg_print("
        }
 }
 
-
-/*
- * Count the number of "corridor" grids adjacent to the given grid.
- *
- * Note -- Assumes "in_bounds(y1, x1)"
- *
- * XXX XXX This routine currently only counts actual "empty floor"
- * grids which are not in rooms.  We might want to also count stairs,
+/*!
+ * @brief ÎÙÀÜ4¥Þ¥¹¤Ë¸ºß¤¹¤ëÄÌÏ©¤Î¿ô¤òÊÖ¤¹ / Count the number of "corridor" grids adjacent to the given grid.
+ * @param y1 ´ð½à¤È¤Ê¤ë¥Þ¥¹¤ÎYºÂɸ
+ * @param x1 ´ð½à¤È¤Ê¤ë¥Þ¥¹¤ÎXºÂɸ
+ * @return ÄÌÏ©¤Î¿ô
+ * @note Assumes "in_bounds(y1, x1)"
+ * @details
+ * XXX XXX This routine currently only counts actual "empty floor"\n
+ * grids which are not in rooms.  We might want to also count stairs,\n
  * open doors, closed doors, etc.
  */
 static int next_to_corr(int y1, int x1)
@@ -418,11 +419,15 @@ static int next_to_corr(int y1, int x1)
 }
 
 
-/*
- * Determine if the given location is "between" two walls,
- * and "next to" two corridor spaces.  XXX XXX XXX
- *
- * Assumes "in_bounds(y, x)"
+/*!
+ * @brief ¥É¥¢¤òÀßÃÖ²Äǽ¤ÊÃÏ·Á¤«¤òÊÖ¤¹ / Determine if the given location is "between" two walls, and "next to" two corridor spaces.
+ * @param y È½Äê¤ò¹Ô¤¤¤¿¤¤¥Þ¥¹¤ÎYºÂɸ
+ * @param x È½Äê¤ò¹Ô¤¤¤¿¤¤¥Þ¥¹¤ÎXºÂɸ
+ * @return ¥É¥¢¤òÀßÃÖ²Äǽ¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ * @note Assumes "in_bounds(y1, x1)"
+ * @details
+ * XXX XXX XXX\n
+ * Assumes "in_bounds(y, x)"\n
  */
 static bool possible_doorway(int y, int x)
 {
@@ -448,9 +453,11 @@ static bool possible_doorway(int y, int x)
        return (FALSE);
 }
 
-
-/*
- * Places door at y, x position if at least 2 walls found
+/*!
+ * @brief ¥É¥¢¤ÎÀßÃÖ¤ò»î¤ß¤ë / Places door at y, x position if at least 2 walls found
+ * @param y ÀßÃÖ¤ò¹Ô¤¤¤¿¤¤¥Þ¥¹¤ÎYºÂɸ
+ * @param x ÀßÃÖ¤ò¹Ô¤¤¤¿¤¤¥Þ¥¹¤ÎXºÂɸ
+ * @return ¤Ê¤·
  */
 static void try_door(int y, int x)
 {
@@ -472,7 +479,10 @@ static void try_door(int y, int x)
 }
 
 
-/* Place quest monsters */
+/*!
+ * @brief ¥¯¥¨¥¹¥È¤Ë´Ø¤ï¤ë¥â¥ó¥¹¥¿¡¼¤ÎÇÛÃÖ¤ò¹Ô¤¦ / Place quest monsters
+ * @return À®¸ù¤·¤¿¤Ê¤é¤ÐTRUE¤òÊÖ¤¹
+ */
 bool place_quest_monsters(void)
 {
        int i;