From d4d5ce7ee56c91a5dd84cbb0b5d1df54e1c20b9f Mon Sep 17 00:00:00 2001
From: belugas <belugas@openttd.org>
Date: Fri, 6 Apr 2007 04:10:19 +0000
Subject: (svn r9568) -Documentation: doxygen and comment changes: Root of src
 is finally done.  Now, time to start clearing as much as possible

---
 src/direction.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'src/direction.h')

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)
 {
-- 
cgit v1.2.3-70-g09d2