diff options
| author | alberth <alberth@openttd.org> | 2009-07-26 12:49:26 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2009-07-26 12:49:26 +0000 |
| commit | 75ccf9de3a4abc4a67a373959013a18321995d88 (patch) | |
| tree | 7464c0b223d12fd580b65f77347fd6c81da11d5b /src/vehicle_type.h | |
| parent | 5b576e6e7a200eda8f1ef05254133591d32f2e27 (diff) | |
| download | openttd-75ccf9de3a4abc4a67a373959013a18321995d88.tar.xz | |
(svn r16960) -Doc: Added some viewport and vehicle type doxygen strings.
Diffstat (limited to 'src/vehicle_type.h')
| -rw-r--r-- | src/vehicle_type.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/src/vehicle_type.h b/src/vehicle_type.h index b008e1d87..0b5024c49 100644 --- a/src/vehicle_type.h +++ b/src/vehicle_type.h @@ -9,15 +9,16 @@ typedef uint16 VehicleID; +/** Available vehicle types. */ enum VehicleType { - VEH_TRAIN, - VEH_ROAD, - VEH_SHIP, - VEH_AIRCRAFT, - VEH_EFFECT, - VEH_DISASTER, + VEH_TRAIN, ///< %Train vehicle type. + VEH_ROAD, ///< Road vehicle type. + VEH_SHIP, ///< %Ship vehicle type. + VEH_AIRCRAFT, ///< %Aircraft vehicle type. + VEH_EFFECT, ///< Effect vehicle type (smoke, explosions, sparks, bubbles) + VEH_DISASTER, ///< Disaster vehicle type. VEH_END, - VEH_INVALID = 0xFF, + VEH_INVALID = 0xFF, ///< Non-existing type of vehicle. }; DECLARE_POSTFIX_INCREMENT(VehicleType); /** It needs to be 8bits, because we save and load it as such */ @@ -36,7 +37,7 @@ struct BaseVehicle VehicleTypeByte type; ///< Type of vehicle }; -static const VehicleID INVALID_VEHICLE = 0xFFFF; +static const VehicleID INVALID_VEHICLE = 0xFFFF; ///< Constant representing a non-existing vehicle. /** Pathfinding option states */ enum { |