home · contact · privacy
Improved formatting and comments for yx_uint16.h
authorChristian Heller <c.heller@plomlompom.de>
Wed, 21 Aug 2013 19:33:35 +0000 (21:33 +0200)
committerChristian Heller <c.heller@plomlompom.de>
Wed, 21 Aug 2013 19:33:35 +0000 (21:33 +0200)
src/yx_uint16.h

index e5249b0ab3ca4e69685fc7a845209fb963af9760..325b22449570ca6fad0a18158a8ed07768e78bc2 100644 (file)
@@ -20,6 +20,8 @@ struct yx_uint16
     uint16_t x;
 };
 
+
+
 /* Directions available for movement. */
 enum dir
 {
@@ -29,10 +31,19 @@ enum dir
     WEST
 };
 
+
+
 /* Return 1 if two yx_uint16 coordinates at "a" and "b" are equal, else 0. */
 extern uint8_t yx_uint16_cmp(struct yx_uint16 * a, struct yx_uint16 * b);
 
-/* Return yx_uint16 coordinate one step from coordinate yx in direction dir. */
+
+
+/* Return yx_uint16 coordinate one step from coordinate yx in direction dir.
+ *
+ * If an invalid dir "d" is passed, "yx" remains unchanged.
+ */
 extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
 
+
+
 #endif