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 3a13f0194a8b87564dac6d5f61280149550edf30..d055a6d4c7a3df45ba1b4de482532bb42156f633 100644 (file)
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,19 +1,33 @@
+/* yx_uint16.h
+ *
+ * Structs and routines for coordinates and movement in 2-dimensional space
+ * (such as the ncurses screen and game maps).
+ */
+
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-#include <stdint.h>
+#include <stdint.h> /* for uint8_t, uint16_t */
+
+
+
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+    uint16_t y;
+    uint16_t x;
+};
+
+
+
+/* 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);
 
-enum dir {
-  NORTH = 1,
-  EAST  = 2,
-  SOUTH = 3,
-  WEST  = 4 };
+/* 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);
 
-struct yx_uint16 {
-  uint16_t y;
-  uint16_t x; };
 
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
-extern struct yx_uint16 mv_yx_in_dir (enum dir, struct yx_uint16);
 
 #endif