Add Doxygen comment to rooms.c.

diff --git a/src/rooms.c b/src/rooms.c
index e741c24..0abd872 100644 (file)
--- a/src/rooms.c
+++ b/src/rooms.c
@@ -380,6 +380,7 @@ static bool find_space_aux(int blocks_high, int blocks_wide, int block_y, int bl
  * @param x Éô²°¤ÎÀ¸À®¤¬²Äǽ¤ÊÃæ¿´XºÂɸ¤òÊÖ¤¹»²¾È¥Ý¥¤¥ó¥¿
  * @param height ³ÎÊݤ·¤¿¤¤Îΰè¤Î¹â¤µ
  * @param width ³ÎÊݤ·¤¿¤¤Îΰè¤ÎÉý
+ * @return ½êÄê¤ÎÈϰϤ¬³ÎÊݤǤ­¤¿¾ì¹çTRUE¤òÊÖ¤¹
  * @details
  * Find and allocate a free space in the dungeon large enough to hold\n
  * the room calling this function.\n
@@ -509,8 +510,9 @@ static bool find_space(int *y, int *x, int height, int width)
 
 
 
-/*
- * Type 1 -- normal rectangular rooms
+/*!
+ * @brief ¥¿¥¤¥×1¤ÎÉô²°¡ÄÄ̾ï²ÄÊÑĹÊý·Á¤ÎÉô²°¤òÀ¸À®¤¹¤ë / Type 1 -- normal rectangular rooms
+ * @return ¤Ê¤·
  */
 static bool build_type1(void)
 {
@@ -703,9 +705,9 @@ static bool build_type1(void)
        return TRUE;
 }
 
-
-/*
- * Type 2 -- Overlapping rectangular rooms
+/*!
+ * @brief ¥¿¥¤¥×2¤ÎÉô²°¡ÄÆó½ÅĹÊý·Á¤ÎÉô²°¤òÀ¸À®¤¹¤ë / Type 2 -- Overlapping rectangular rooms
+ * @return ¤Ê¤·
  */
 static bool build_type2(void)
 {
@@ -818,17 +820,18 @@ static bool build_type2(void)
 
 
 
-/*
- * Type 3 -- Cross shaped rooms
- *
- * Builds a room at a row, column coordinate
- *
- * Room "a" runs north/south, and Room "b" runs east/east
- * So the "central pillar" runs from x1a, y1b to x2a, y2b.
- *
- * Note that currently, the "center" is always 3x3, but I think that
- * the code below will work (with "bounds checking") for 5x5, or even
- * for unsymetric values like 4x3 or 5x3 or 3x4 or 3x5, or even larger.
+/*!
+ * @brief ¥¿¥¤¥×2¤ÎÉô²°¡Ä½½»ú·¿¤ÎÉô²°¤òÀ¸À®¤¹¤ë / Type 3 -- Cross shaped rooms
+ * @return ¤Ê¤·
+ * @details
+ * Builds a room at a row, column coordinate\n
+ *\n
+ * Room "a" runs north/south, and Room "b" runs east/east\n
+ * So the "central pillar" runs from x1a, y1b to x2a, y2b.\n
+ *\n
+ * Note that currently, the "center" is always 3x3, but I think that\n
+ * the code below will work (with "bounds checking") for 5x5, or even\n
+ * for unsymetric values like 4x3 or 5x3 or 3x4 or 3x5, or even larger.\n
  */
 static bool build_type3(void)
 {
@@ -1077,15 +1080,16 @@ static bool build_type3(void)
 }
 
 
-/*
- * Type 4 -- Large room with inner features
- *
- * Possible sub-types:
- *     1 - Just an inner room with one door
- *     2 - An inner room within an inner room
- *     3 - An inner room with pillar(s)
- *     4 - Inner room has a maze
- *     5 - A set of four inner rooms
+/*!
+ * @brief ¥¿¥¤¥×4¤ÎÉô²°¡Ä¸ÇÄꥵ¥¤¥º¤ÎÆó½Å¹½Â¤Éô²°¤òÀ¸À®¤¹¤ë / Type 4 -- Large room with inner features
+ * @return ¤Ê¤·
+ * @details
+ * Possible sub-types:\n
+ *     1 - Just an inner room with one door\n
+ *     2 - An inner room within an inner room\n
+ *     3 - An inner room with pillar(s)\n
+ *     4 - Inner room has a maze\n
+ *     5 - A set of four inner rooms\n
  */
 static bool build_type4(void)
 {