Minor code-stylistic revisions to yx_uint16 library.

[plomrogue] / src / yx_uint16.h

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index 29298e5ded0f4b97f79f12d2d5e3d04b5b934a37..d055a6d4c7a3df45ba1b4de482532bb42156f633 100644 (file)
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -7,9 +7,7 @@
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-
-
-#include <stdint.h> /* for uint16_t */
+#include <stdint.h> /* for uint8_t, uint16_t */
 
 
 
@@ -20,19 +18,16 @@ struct yx_uint16
     uint16_t x;
 };
 
-/* Directions available for movement. */
-enum dir
-{
-    NORTH = 1,
-    EAST,
-    SOUTH,
-    WEST
-};
 
-/* Return 1 if two yx_uint16 coordinates a and b are equal, else 0. */
-extern char yx_uint16_cmp(struct yx_uint16 a, struct yx_uint16 b);
 
-/* Return yx_uint16 coordinate one step from coordinate yx in direction dir. */
-extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
+/* 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 "yx" in direction "dir" (east: 'E',
+ * west: 'W', north: 'N', south: 'S'). An invalid dir leaves "yx" unchanged.
+ */
+extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);
+
+
 
 #endif