diff src/vehicle_func.h @ 10260:d23fed9a51e2 draft

(svn r14491) -Documentation: updates/additions of doxygen docs (Alberth)
author rubidium <rubidium@openttd.org>
date Sun, 19 Oct 2008 15:39:12 +0000
parents c54d140df948
children 28fa021b003c
line wrap: on
line diff
--- a/src/vehicle_func.h
+++ b/src/vehicle_func.h
@@ -75,14 +75,13 @@
 
 void CcCloneVehicle(bool success, TileIndex tile, uint32 p1, uint32 p2);
 
-
+/** Position information of a vehicle after it moved */
 struct GetNewVehiclePosResult {
-	int x, y;
-	TileIndex old_tile;
-	TileIndex new_tile;
+	int x, y;  ///< x and y position of the vehicle after moving
+	TileIndex old_tile; ///< Current tile of the vehicle
+	TileIndex new_tile; ///< Tile of the vehicle after moving
 };
 
-/* returns true if staying in the same tile */
 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
 Direction GetDirectionTowards(const Vehicle *v, int x, int y);