From 1a515e6344028854c855671c19f49d8f869eb18f Mon Sep 17 00:00:00 2001 From: rubidium Date: Sun, 1 May 2011 19:14:12 +0000 Subject: (svn r22405) -Document: some more "random-ish" tidbits --- src/transport_type.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'src/transport_type.h') diff --git a/src/transport_type.h b/src/transport_type.h index 5c2b22cba..28a1c5cf8 100644 --- a/src/transport_type.h +++ b/src/transport_type.h @@ -14,6 +14,7 @@ #include "core/enum_type.hpp" +/** Type for the company global vehicle unit number. */ typedef uint16 UnitID; /** Available types of transport */ @@ -24,14 +25,15 @@ enum TransportType { * accessing tunnels and bridges. For now, you should just not change * the values for road and rail. */ - TRANSPORT_BEGIN = 0, + TRANSPORT_BEGIN = 0, ///< Begin of the iterator. TRANSPORT_RAIL = TRANSPORT_BEGIN, ///< Transport by train TRANSPORT_ROAD, ///< Transport by road vehicle TRANSPORT_WATER, ///< Transport over water TRANSPORT_AIR, ///< Transport through air - TRANSPORT_END, - INVALID_TRANSPORT = 0xff, + TRANSPORT_END, ///< End of iterations. + INVALID_TRANSPORT = 0xff, ///< Sentinel for invalid transport types. }; +/** Helper information for extract tool. */ template <> struct EnumPropsT : MakeEnumPropsT {}; #endif /* TRANSPORT_TYPE_H */ -- cgit v1.2.3-54-g00ecf