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

1 files changed, 10 insertions, 0 deletions

diff --git a/src/roadveh_cmd.cpp b/src/roadveh_cmd.cpp
index d13c94b91..931c74d1c 100644
--- a/src/roadveh_cmd.cpp
+++ b/src/roadveh_cmd.cpp
@@ -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);