From 7efd7e19ed046a4a0c03077f27930291ba5b9725 Mon Sep 17 00:00:00 2001 From: rubidium Date: Tue, 18 Jan 2011 22:31:06 +0000 Subject: (svn r21845) -Codechange: move documentation towards the code to make it more likely to be updates [d-m]. --- src/group_cmd.cpp | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'src/group_cmd.cpp') diff --git a/src/group_cmd.cpp b/src/group_cmd.cpp index ba68515fd..cfa6a3fb5 100644 --- a/src/group_cmd.cpp +++ b/src/group_cmd.cpp @@ -409,6 +409,14 @@ void UpdateTrainGroupID(Train *v) SetWindowDirty(WC_REPLACE_VEHICLE, VEH_TRAIN); } +/** + * Get the number of engines with EngineID id_e in the group with GroupID + * id_g + * @param company The company the group belongs to + * @param id_g The GroupID of the group used + * @param id_e The EngineID of the engine to count + * @return The number of engines with EngineID id_e in the group + */ uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e) { if (Group::IsValidID(id_g)) return Group::Get(id_g)->num_engines[id_e]; -- cgit v1.2.3-54-g00ecf