From 854595542423a6729ba8a17faa76593c92586de5 Mon Sep 17 00:00:00 2001
From: peter1138 <peter1138@openttd.org>
Date: Tue, 8 Apr 2014 21:52:53 +0000
Subject: [PATCH] (svn r26451) -Change: Document GroupIsInGroup() function.

---
 src/group_cmd.cpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/group_cmd.cpp b/src/group_cmd.cpp
index 77e0b0d38a..be1bfce5d9 100644
--- a/src/group_cmd.cpp
+++ b/src/group_cmd.cpp
@@ -713,6 +713,12 @@ void RemoveAllGroupsForCompany(const CompanyID company)
 }
 
 
+/**
+ * Test if GroupID group is a descendant of (or is) GroupID search
+ * @param search The GroupID to search in
+ * @param group The GroupID to search for
+ * @return True iff group is search or a descendant of search
+ */
 bool GroupIsInGroup(GroupID search, GroupID group)
 {
 	if (search == NEW_GROUP ||