From 019a51944696e5619ac6c635e1ce1d8af0981788 Mon Sep 17 00:00:00 2001 From: rubidium Date: Fri, 1 Aug 2008 09:34:34 +0000 Subject: (svn r13910) -Document: string drawing related functions and types (Alberth) --- src/strings_type.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'src/strings_type.h') 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. -- cgit v1.2.3-54-g00ecf