(svn r14702) -Documentation: Add a note about the meaning and validity of Vehicle::dest_tile.

1 files changed, 7 insertions, 1 deletions

diff --git a/src/vehicle_base.h b/src/vehicle_base.h
index cee6c4d5b..6df247c15 100644
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -217,7 +217,13 @@ public:
 	char *name;              ///< Name of vehicle
 
 	TileIndex tile;          ///< Current tile index
-	TileIndex dest_tile;     ///< Heading for this tile
+
+	/**
+	 * Heading for this tile.
+	 * For airports and train stations this tile does not necessarily belong to the destination station,
+	 * but it can be used for heuristical purposes to estimate the distance.
+	 */
+	TileIndex dest_tile;
 
 	Money profit_this_year;        ///< Profit this year << 8, low 8 bits are fract
 	Money profit_last_year;        ///< Profit last year << 8, low 8 bits are fract