diff options
| author | rubidium <rubidium@openttd.org> | 2009-06-03 18:47:08 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2009-06-03 18:47:08 +0000 |
| commit | caf98238e3cffedbc80fc9f7aa0f485500f6913a (patch) | |
| tree | 988ded205687ea822e8e3e2e3db2fb3fa494d59a /src/ai/api/ai_order.hpp | |
| parent | 13c69b897e5456a3423cf557535a848dee68a0f5 (diff) | |
| download | openttd-caf98238e3cffedbc80fc9f7aa0f485500f6913a.tar.xz | |
(svn r16510) -Doc: silence some (AI) doxygen warnings by adding comments about the appropriate things.
Diffstat (limited to 'src/ai/api/ai_order.hpp')
| -rw-r--r-- | src/ai/api/ai_order.hpp | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/ai/api/ai_order.hpp b/src/ai/api/ai_order.hpp index 14f20c258..c55b5e3e8 100644 --- a/src/ai/api/ai_order.hpp +++ b/src/ai/api/ai_order.hpp @@ -288,8 +288,10 @@ public: * Sets the OrderCondition of the given order for the given vehicle. * @param vehicle_id The vehicle to set the condition type for. * @param order_position The order to set the condition type for. + * @param condition The condition to compare on. * @pre IsValidVehicleOrder(vehicle_id, order_position). * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). + * @pre condition >= OC_LOAD_PERCENTAGE && condition <= OC_UNCONDITIONALLY. * @return Whether the order has been/can be changed. */ static bool SetOrderCondition(VehicleID vehicle_id, OrderPosition order_position, OrderCondition condition); @@ -298,8 +300,10 @@ public: * Sets the CompareFunction of the given order for the given vehicle. * @param vehicle_id The vehicle to set the compare function for. * @param order_position The order to set the compare function for. + * @param compare The new compare function of the order. * @pre IsValidVehicleOrder(vehicle_id, order_position). * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). + * @pre compare >= CF_EQUALS && compare <= CF_IS_FALSE. * @return Whether the order has been/can be changed. */ static bool SetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position, CompareFunction compare); @@ -308,6 +312,7 @@ public: * Sets the value to compare against of the given order for the given vehicle. * @param vehicle_id The vehicle to set the value for. * @param order_position The order to set the value for. + * @param value The value to compare against. * @pre IsValidVehicleOrder(vehicle_id, order_position). * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). * @pre value >= 0 && value < 2048. |