changeset 14458:d809c6815bf5 draft

(svn r19017) -Doc: [NoAI] A parameter wasn't documented
author rubidium <rubidium@openttd.org>
date Fri, 05 Feb 2010 16:11:23 +0000
parents 5d72b506e97b
children 8d0e19518a53
files src/ai/api/ai_order.hpp
diffstat 1 files changed, 2 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/ai/api/ai_order.hpp
+++ b/src/ai/api/ai_order.hpp
@@ -352,9 +352,11 @@
 	 * Sets the stoplocation of the given order for the given train.
 	 * @param vehicle_id The vehicle to get the value for.
 	 * @param order_position The order to get the value for.
+	 * @param stop_location The relative position where a train will stop inside a station.
 	 * @pre IsValidVehicleOrder(vehicle_id, order_position).
 	 * @pre AIVehicle::GetVehicleType(vehicle_id) == AIVehicle::VT_RAIL.
 	 * @pre IsGotoStationOrder(vehicle_id, order_position).
+	 * @pre stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR
 	 * @return Whether the order has been/can be changed.
 	 */
 	static bool SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location);