# HG changeset patch
# User yexo <yexo@openttd.org>
# Date 2010-07-31 22:46:29
# Node ID 27f26f9f8f914fd62e7de3029e6ba9a5af74e765
# Parent  7c4c457ebe78bde59e7772f6068496d366be2f24

(svn r20272) -Doc: [NoAI] document return value of AIGroup::SetAutoReplace

diff --git a/src/ai/api/ai_group.hpp b/src/ai/api/ai_group.hpp
--- a/src/ai/api/ai_group.hpp
+++ b/src/ai/api/ai_group.hpp
@@ -150,6 +150,7 @@ public:
 	 * @param engine_id_new The engine id to replace with.
 	 * @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL.
 	 * @pre AIEngine.IsBuildable(engine_id_new).
+	 * @return True if and if the replacing was successfully started.
 	 * @note To stop autoreplacing engine_id_old, call StopAutoReplace(group_id, engine_id_old).
 	 */
 	static bool SetAutoReplace(GroupID group_id, EngineID engine_id_old, EngineID engine_id_new);