(svn r21925) -Doc: Doxygen additions and markup corrections to vehicle-related functions.

This commit is contained in:
alberth
2011-01-29 21:37:11 +00:00
parent 734994c9ba
commit eea2f90da7
4 changed files with 42 additions and 23 deletions

View File

@@ -155,6 +155,11 @@ void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID eng
DrawSprite(sprite, pal, preferred_x, y);
}
/**
* Get length of a road vehicle.
* @param v Road vehicle to query length.
* @return Length of the given road vehicle.
*/
static uint GetRoadVehLength(const RoadVehicle *v)
{
uint length = 8;
@@ -167,6 +172,11 @@ static uint GetRoadVehLength(const RoadVehicle *v)
return length;
}
/**
* Update the cache of a road vehicle.
* @param v Road vehicle needing an update of its cache.
* @pre \a v must be first road vehicle.
*/
void RoadVehUpdateCache(RoadVehicle *v)
{
assert(v->type == VEH_ROAD);