diff options
| author | belugas <belugas@openttd.org> | 2007-04-06 04:10:19 +0000 |
|---|---|---|
| committer | belugas <belugas@openttd.org> | 2007-04-06 04:10:19 +0000 |
| commit | d4d5ce7ee56c91a5dd84cbb0b5d1df54e1c20b9f (patch) | |
| tree | a1e7d7ce47984afb0335e16c0f45d7edc5977704 /src/direction.h | |
| parent | 15d360c7f6c9519a49b1210ce3100534eaf3001b (diff) | |
| download | openttd-d4d5ce7ee56c91a5dd84cbb0b5d1df54e1c20b9f.tar.xz | |
(svn r9568) -Documentation: doxygen and comment changes: Root of src is finally done. Now, time to start clearing as much as possible
Diffstat (limited to 'src/direction.h')
| -rw-r--r-- | src/direction.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/direction.h b/src/direction.h index d0dd988eb..837fa149f 100644 --- a/src/direction.h +++ b/src/direction.h @@ -24,7 +24,7 @@ enum Direction { /** Define basic enum properties */ template <> struct EnumPropsT<Direction> : MakeEnumPropsT<Direction, byte, DIR_BEGIN, DIR_END, INVALID_DIR> {}; -typedef TinyEnumT<Direction> DirectionByte; +typedef TinyEnumT<Direction> DirectionByte; //typedefing-enumification of Direction static inline Direction ReverseDir(Direction d) { @@ -73,7 +73,7 @@ DECLARE_POSTFIX_INCREMENT(DiagDirection); /** Define basic enum properties */ template <> struct EnumPropsT<DiagDirection> : MakeEnumPropsT<DiagDirection, byte, DIAGDIR_BEGIN, DIAGDIR_END, INVALID_DIAGDIR> {}; -typedef TinyEnumT<DiagDirection> DiagDirectionByte; +typedef TinyEnumT<DiagDirection> DiagDirectionByte; //typedefing-enumification of DiagDirection static inline DiagDirection ReverseDiagDir(DiagDirection d) { @@ -137,7 +137,9 @@ static inline DiagDirection AxisToDiagDir(Axis a) /** * Convert an axis and a flag for north/south into a DiagDirection + * @param xy axis to convert * @param ns north -> 0, south -> 1 + * @return the desired DiagDirection */ static inline DiagDirection XYNSToDiagDir(Axis xy, uint ns) { |