summaryrefslogtreecommitdiff
path: root/src/console_type.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-06-26 15:22:10 +0000
committeralberth <alberth@openttd.org>2010-06-26 15:22:10 +0000
commit212dbbf4d8d8f397b8392947471cfb916d470564 (patch)
treedd28ae0a82943998bfc316bf6c2b504c355cca6a /src/console_type.h
parentef17c6042f2a78414dea5853cfccf99256ddbbb5 (diff)
downloadopenttd-212dbbf4d8d8f397b8392947471cfb916d470564.tar.xz
(svn r20022) -Doc: Add some doxygen comments.
Diffstat (limited to 'src/console_type.h')
-rw-r--r--src/console_type.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/console_type.h b/src/console_type.h
index 9c1e713a6..f8fec98d2 100644
--- a/src/console_type.h
+++ b/src/console_type.h
@@ -12,12 +12,14 @@
#ifndef CONSOLE_TYPE_H
#define CONSOLE_TYPE_H
+/** Modes of the in-game console. */
enum IConsoleModes {
- ICONSOLE_FULL,
- ICONSOLE_OPENED,
- ICONSOLE_CLOSED
+ ICONSOLE_FULL, ///< In-game console is closed.
+ ICONSOLE_OPENED, ///< In-game console is opened, upper 1/3 of the screen.
+ ICONSOLE_CLOSED ///< In-game console is opened, whole screen.
};
+/** Colours of the console messages. */
enum ConsoleColour {
CC_DEFAULT = 1,
CC_ERROR = 3,