summaryrefslogtreecommitdiff
path: root/src/strings_type.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-08-01 09:34:34 +0000
committerrubidium <rubidium@openttd.org>2008-08-01 09:34:34 +0000
commit019a51944696e5619ac6c635e1ce1d8af0981788 (patch)
tree2ff51cc080d35422ab3d268a167cf4863270082e /src/strings_type.h
parent6a401d5dfc04cc5e57dcdb8bcc2192f74e06a220 (diff)
downloadopenttd-019a51944696e5619ac6c635e1ce1d8af0981788.tar.xz
(svn r13910) -Document: string drawing related functions and types (Alberth)
Diffstat (limited to 'src/strings_type.h')
-rw-r--r--src/strings_type.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/strings_type.h b/src/strings_type.h
index d9482f23d..00c7d6538 100644
--- a/src/strings_type.h
+++ b/src/strings_type.h
@@ -5,11 +5,14 @@
#ifndef STRINGS_TYPE_H
#define STRINGS_TYPE_H
+/**
+ * Numeric value that represents a string, independent of the selected language.
+ */
typedef uint16 StringID;
-static const StringID INVALID_STRING_ID = 0xFFFF;
+static const StringID INVALID_STRING_ID = 0xFFFF; ///< Constant representing an invalid string
enum {
- MAX_LANG = 64,
+ MAX_LANG = 64, ///< Maximal number of languages supported by the game
};
/** Information about a language */
@@ -26,7 +29,7 @@ struct DynamicLanguages {
Language ent[MAX_LANG]; ///< Information about the languages
};
-// special string constants
+/** Special string constants */
enum SpecialStrings {
// special strings for town names. the town name is generated dynamically on request.