summaryrefslogtreecommitdiff
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
parentef17c6042f2a78414dea5853cfccf99256ddbbb5 (diff)
downloadopenttd-212dbbf4d8d8f397b8392947471cfb916d470564.tar.xz
(svn r20022) -Doc: Add some doxygen comments.
-rw-r--r--src/console_cmds.cpp2
-rw-r--r--src/console_gui.cpp4
-rw-r--r--src/console_internal.h4
-rw-r--r--src/console_type.h8
-rw-r--r--src/livery.h4
5 files changed, 13 insertions, 9 deletions
diff --git a/src/console_cmds.cpp b/src/console_cmds.cpp
index fff0788aa..dfe05bdbd 100644
--- a/src/console_cmds.cpp
+++ b/src/console_cmds.cpp
@@ -42,7 +42,7 @@
#endif /* ENABLE_NETWORK */
/* scriptfile handling */
-static bool _script_running;
+static bool _script_running; ///< Script is running (used to abort execution when #ConReturn is encountered).
/* console command defines */
#define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])
diff --git a/src/console_gui.cpp b/src/console_gui.cpp
index 6a73790be..264e107bf 100644
--- a/src/console_gui.cpp
+++ b/src/console_gui.cpp
@@ -168,7 +168,7 @@ static const WindowDesc _console_window_desc(
struct IConsoleWindow : Window
{
static int scroll;
- int line_height;
+ int line_height; ///< Height of one line of text in the console.
int line_offset;
IConsoleWindow() : Window()
@@ -375,6 +375,7 @@ void IConsoleGUIFree()
IConsoleClearBuffer();
}
+/** Change the size of the in-game console window after the screen size changed, or the window state changed. */
void IConsoleResize(Window *w)
{
switch (_iconsole_mode) {
@@ -392,6 +393,7 @@ void IConsoleResize(Window *w)
MarkWholeScreenDirty();
}
+/** Toggle in-game console between opened and closed. */
void IConsoleSwitch()
{
switch (_iconsole_mode) {
diff --git a/src/console_internal.h b/src/console_internal.h
index 6debe8a19..8630ebf33 100644
--- a/src/console_internal.h
+++ b/src/console_internal.h
@@ -60,8 +60,8 @@ struct IConsoleAlias {
};
/* console parser */
-extern IConsoleCmd *_iconsole_cmds; ///< list of registred commands
-extern IConsoleAlias *_iconsole_aliases; ///< list of registred aliases
+extern IConsoleCmd *_iconsole_cmds; ///< List of registered commands.
+extern IConsoleAlias *_iconsole_aliases; ///< List of registered aliases.
/* console functions */
void IConsoleClearBuffer();
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,
diff --git a/src/livery.h b/src/livery.h
index d34e4c47e..aa7af96f5 100644
--- a/src/livery.h
+++ b/src/livery.h
@@ -14,7 +14,7 @@
#include "company_type.h"
-/* List of different livery schemes. */
+/** List of different livery schemes. */
enum LiveryScheme {
LS_BEGIN = 0,
LS_DEFAULT = 0,
@@ -57,7 +57,7 @@ enum LiveryScheme {
DECLARE_POSTFIX_INCREMENT(LiveryScheme)
template <> struct EnumPropsT<LiveryScheme> : MakeEnumPropsT<LiveryScheme, byte, LS_BEGIN, LS_END, LS_END, 8> {};
-/* List of different livery classes, used only by the livery GUI. */
+/** List of different livery classes, used only by the livery GUI. */
enum LiveryClass {
LC_OTHER,
LC_RAIL,