OSDN Git Service

Add Doxygen comment to cmd1.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 21 Jan 2014 12:52:34 +0000 (12:52 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Tue, 21 Jan 2014 12:52:34 +0000 (12:52 +0000)
src/cmd1.c

index dce884a..50f1407 100644 (file)
@@ -64,7 +64,7 @@
  *\n
  * #.#\n
  * ##.##\n
- * .@x..\n
+ * \.\@x..\n
  * ##.##\n
  * #.#\n
  *\n
@@ -4153,19 +4153,21 @@ static bool find_breakleft;
 
 
 
-/*
+/*!
+ * @brief ¥À¥Ã¥·¥å½èÍý¤ÎƳÆþ /
  * Initialize the running algorithm for a new direction.
- *
- * Diagonal Corridor -- allow diaginal entry into corridors.
- *
- * Blunt Corridor -- If there is a wall two spaces ahead and
- * we seem to be in a corridor, then force a turn into the side
- * corridor, must be moving straight into a corridor here. ???
- *
- * Diagonal Corridor    Blunt Corridor (?)
- *       # #                  #
- *       #x#                 @x#
- *       @p.                  p
+ * @param dir Æ³Æþ¤Î°ÜÆ°Àè
+ * @details
+ * Diagonal Corridor -- allow diaginal entry into corridors.\n
+ *\n
+ * Blunt Corridor -- If there is a wall two spaces ahead and\n
+ * we seem to be in a corridor, then force a turn into the side\n
+ * corridor, must be moving straight into a corridor here. ???\n
+ *\n
+ * Diagonal Corridor    Blunt Corridor (?)\n
+ *       # #                  #\n
+ *       #x#                 @x#\n
+ *       @p.                  p\n
  */
 static void run_init(int dir)
 {
@@ -4260,9 +4262,11 @@ static void run_init(int dir)
 }
 
 
-/*
+/*!
+ * @brief ¥À¥Ã¥·¥å°ÜÆ°¤¬·Ñ³¤Ç¤­¤ë¤«¤É¤¦¤«¤ÎȽÄê /
  * Update the current "run" path
- *
+ * @return
+ * ¥À¥Ã¥·¥å°ÜÆ°¤¬·Ñ³¤Ç¤­¤ë¤Ê¤é¤ÐTRUE¤òÊÖ¤¹¡£
  * Return TRUE if the running should be stopped
  */
 static bool run_test(void)
@@ -4600,8 +4604,11 @@ static bool run_test(void)
 
 
 
-/*
+/*!
+ * @brief ·Ñ³Ū¤Ê¥À¥Ã¥·¥å½èÍý /
  * Take one step along the current "run" path
+ * @param dir °ÜÆ°¤ò»î¤ß¤ëÊý¸þID
+ * @return ¤Ê¤·
  */
 void run_step(int dir)
 {
@@ -4673,8 +4680,12 @@ void run_step(int dir)
 
 
 #ifdef TRAVEL
-/*
+
+/*!
+ * @brief ¥È¥é¥Ù¥ëµ¡Ç½¤ÎȽÄê½èÍý /
  * Test for traveling
+ * @param prev_dir Á°²ó°ÜÆ°¤ò¹Ô¤Ã¤¿¸µ¤ÎÊý³ÑID
+ * @return ¤Ê¤·
  */
 static int travel_test(int prev_dir)
 {
@@ -4774,8 +4785,10 @@ static int travel_test(int prev_dir)
 }
 
 
-/*
+/*!
+ * @brief ¥È¥é¥Ù¥ëµ¡Ç½¤Î¼ÂÁõ /
  * Travel command
+ * @return ¤Ê¤·
  */
 void travel_step(void)
 {