# HG changeset patch
# User truelight
# Date 1174996516 0
# Node ID 2f4087d6352767c608df10f6fc943c924a8c6e7d
# Parent  33b2f192bb34941ad9ee5a242cad53c02c4d04f1
(svn r9500) [NoAI] -Add: document behavoir in test-mode

diff -r 33b2f192bb34 -r 2f4087d63527 src/ai/api/ai_sign.hpp
--- a/src/ai/api/ai_sign.hpp	Tue Mar 27 10:33:42 2007 +0000
+++ b/src/ai/api/ai_sign.hpp	Tue Mar 27 11:55:16 2007 +0000
@@ -72,6 +72,8 @@
 	 * @pre location is always positive and below AIMap::GetMapSize()
 	 * @pre text is not NULL and non-empty, i.e. length is positive.
 	 * @return the SignID of the build sign (use IsValidSign() to check for validity).
+	 *   In test-mode it returns 0 if successful, or any other value to indicate
+	 *   failure.
 	 */
 	SignID BuildSign(TileIndex location, const char *text);
 };
diff -r 33b2f192bb34 -r 2f4087d63527 src/ai/api/ai_vehicle.hpp
--- a/src/ai/api/ai_vehicle.hpp	Tue Mar 27 10:33:42 2007 +0000
+++ b/src/ai/api/ai_vehicle.hpp	Tue Mar 27 11:55:16 2007 +0000
@@ -54,7 +54,8 @@
 	 *   is owned by you.
 	 * @pre IsValidEngine(engine_id).
 	 * @return the VehicleID of the new vehicle, or an invalid VehicleID when
-	 *   it failed. Check the return value using IsValidVehicle.
+	 *   it failed. Check the return value using IsValidVehicle. In test-mode
+	 *   0 is returned if it was successful; any other value indicates failure.
 	 */
 	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);
 
@@ -66,7 +67,8 @@
 	 * @pre the tile at depot has a depot.
 	 * @pre IsValidVehicle(vehicle_id).
 	 * @return the VehicleID of the new vehicle, or an invalid VehicleID when
-	 *   it failed. Check the return value using IsValidVehicle.
+	 *   it failed. Check the return value using IsValidVehicle. In test-mode
+	 *   0 is returned if it was successful; any other value indicates failure.
 	 */
 	VehicleID CloneVehicle(TileIndex depot, VehicleID vehicle_id, bool share_orders);