Some refactoring in map library.

[plomrogue] / src / yx_uint16.h

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index d055a6d4c7a3df45ba1b4de482532bb42156f633..f6f90a372dca46c8af4b63a17dcd1e4e3f37bcb6 100644 (file)
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -24,7 +24,8 @@ struct yx_uint16
 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.
+ * west: 'W', north: 'N', south: 'S'). If "dir" is invalid or would wrap the
+ * move around the edge of a 2^16x2^16 cells field, "yx" remains unchanged.
  */
 extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);