From 7c1170668a715ec11d21bcb58e2ae005e1202768 Mon Sep 17 00:00:00 2001 From: rubidium Date: Fri, 5 Feb 2010 16:11:23 +0000 Subject: [PATCH] (svn r19017) -Doc: [NoAI] A parameter wasn't documented --- src/ai/api/ai_order.hpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ai/api/ai_order.hpp b/src/ai/api/ai_order.hpp index fe0dcd826d..ae9ea6f882 100644 --- a/src/ai/api/ai_order.hpp +++ b/src/ai/api/ai_order.hpp @@ -352,9 +352,11 @@ public: * 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);