(svn r26451) -Change: Document GroupIsInGroup() function.

10 years ago · 3ea8e22fc1
parent ed8f6f1a0f
commit 3ea8e22fc1
1 changed files with 6 additions and 0 deletions
--- 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 ||