diff options
| author | peter1138 <peter1138@openttd.org> | 2014-04-08 21:52:53 +0000 |
|---|---|---|
| committer | peter1138 <peter1138@openttd.org> | 2014-04-08 21:52:53 +0000 |
| commit | 854595542423a6729ba8a17faa76593c92586de5 (patch) | |
| tree | dc9f1634ba6f7516ad519d0e607a03a3562d21a2 /src/group_cmd.cpp | |
| parent | 567d0ff3a7286fe830bf188c2911e3d10d70eb8c (diff) | |
| download | openttd-854595542423a6729ba8a17faa76593c92586de5.tar.xz | |
(svn r26451) -Change: Document GroupIsInGroup() function.
Diffstat (limited to 'src/group_cmd.cpp')
| -rw-r--r-- | src/group_cmd.cpp | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/group_cmd.cpp b/src/group_cmd.cpp index 77e0b0d38..be1bfce5d 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 || |