diff options
| author | rubidium <rubidium@openttd.org> | 2011-05-01 19:14:12 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-05-01 19:14:12 +0000 |
| commit | 1a515e6344028854c855671c19f49d8f869eb18f (patch) | |
| tree | e1bba97c1a8fd80f564729cc2d5fc2049110cb2a /src/transport_type.h | |
| parent | b27dd1dcd7375dae63724879eb0f56dd703e5312 (diff) | |
| download | openttd-1a515e6344028854c855671c19f49d8f869eb18f.tar.xz | |
(svn r22405) -Document: some more "random-ish" tidbits
Diffstat (limited to 'src/transport_type.h')
| -rw-r--r-- | src/transport_type.h | 8 |
1 files changed, 5 insertions, 3 deletions
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<TransportType> : MakeEnumPropsT<TransportType, byte, TRANSPORT_BEGIN, TRANSPORT_END, INVALID_TRANSPORT, 2> {}; #endif /* TRANSPORT_TYPE_H */ |