diff options
author | alberth <alberth@openttd.org> | 2010-11-05 16:34:22 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-11-05 16:34:22 +0000 |
commit | fa13971337e00ffcd02524bd8a8ce794001564f9 (patch) | |
tree | 624dda236f4e315b455ee599f2009d04f1fdff75 /src/vehicle_func.h | |
parent | 5e3991e20e39fdbe772c68b58ad2fcb88acdf707 (diff) | |
download | openttd-fa13971337e00ffcd02524bd8a8ce794001564f9.tar.xz |
(svn r21088) -Doc: Additions/corrections of doxygen comments.
Diffstat (limited to 'src/vehicle_func.h')
-rw-r--r-- | src/vehicle_func.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/vehicle_func.h b/src/vehicle_func.h index 75f44035c..fbca79beb 100644 --- a/src/vehicle_func.h +++ b/src/vehicle_func.h @@ -74,6 +74,11 @@ struct GetNewVehiclePosResult { GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v); Direction GetDirectionTowards(const Vehicle *v, int x, int y); +/** + * Is the given vehicle type buildable by a company? + * @param type Vehicle type being queried. + * @return Vehicle type is buildable by a company. + */ static inline bool IsCompanyBuildableVehicleType(VehicleType type) { switch (type) { @@ -87,6 +92,11 @@ static inline bool IsCompanyBuildableVehicleType(VehicleType type) } } +/** + * Is the given vehicle buildable by a company? + * @param v Vehicle being queried. + * @return Vehicle is buildable by a company. + */ static inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v) { return IsCompanyBuildableVehicleType(v->type); |