From 33ccd9ada8dbc2984a189e4d2f1b8602f4575fa3 Mon Sep 17 00:00:00 2001
From: yexo <yexo@openttd.org>
Date: Sat, 31 Jul 2010 22:46:29 +0000
Subject: (svn r20272) -Doc: [NoAI] document return value of
 AIGroup::SetAutoReplace

---
 src/ai/api/ai_group.hpp | 1 +
 1 file changed, 1 insertion(+)

(limited to 'src/ai')

diff --git a/src/ai/api/ai_group.hpp b/src/ai/api/ai_group.hpp
index 06b51e481..adfd93df9 100644
--- 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);
-- 
cgit v1.2.3-54-g00ecf