(svn r21088) -Doc: Additions/corrections of doxygen comments.

This commit is contained in:
alberth
2010-11-05 16:34:22 +00:00
parent 5e3991e20e
commit fa13971337
13 changed files with 258 additions and 121 deletions

View File

@@ -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);