From: Christian Heller Date: Wed, 21 Aug 2013 19:33:35 +0000 (+0200) Subject: Improved formatting and comments for yx_uint16.h X-Git-Tag: tce~1071 X-Git-Url: https://plomlompom.com/repos/%7B%7B%20web_path%20%7D%7D/decks/%7B%7Bdb.prefix%7D%7D/%7B%7Bprefix%7D%7D/%7B%7Btodo.comment%7D%7D?a=commitdiff_plain;h=2ae596eebaa801026f17ef128887c41ff75c6d66;p=plomrogue Improved formatting and comments for yx_uint16.h --- diff --git a/src/yx_uint16.h b/src/yx_uint16.h index e5249b0..325b224 100644 --- a/src/yx_uint16.h +++ b/src/yx_uint16.h @@ -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