summaryrefslogtreecommitdiff
path: root/src/group_type.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-02 17:42:12 +0000
committerrubidium <rubidium@openttd.org>2011-05-02 17:42:12 +0000
commitfb5ecb94992e7febf4bc059cb6ec4a51f50c66b0 (patch)
tree87956636c318baa8d5d8d62f13263c4f64dbe881 /src/group_type.h
parent4d5dbf51707c42c24eeafdb65016b079c54adcf2 (diff)
downloadopenttd-fb5ecb94992e7febf4bc059cb6ec4a51f50c66b0.tar.xz
(svn r22411) -Document: another bunch of bits
Diffstat (limited to 'src/group_type.h')
-rw-r--r--src/group_type.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/group_type.h b/src/group_type.h
index 7d09ce3ff..ef93e91d9 100644
--- a/src/group_type.h
+++ b/src/group_type.h
@@ -12,11 +12,11 @@
#ifndef GROUP_TYPE_H
#define GROUP_TYPE_H
-typedef uint16 GroupID;
+typedef uint16 GroupID; ///< Type for all group identifiers.
-static const GroupID ALL_GROUP = 0xFFFD;
-static const GroupID DEFAULT_GROUP = 0xFFFE; ///< ungrouped vehicles are in this group.
-static const GroupID INVALID_GROUP = 0xFFFF;
+static const GroupID ALL_GROUP = 0xFFFD; ///< All vehicles are in this group.
+static const GroupID DEFAULT_GROUP = 0xFFFE; ///< Ungrouped vehicles are in this group.
+static const GroupID INVALID_GROUP = 0xFFFF; ///< Sentinel for invalid groups.
static const uint MAX_LENGTH_GROUP_NAME_CHARS = 32; ///< The maximum length of a group name in characters including '\0'