mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r20022) -Doc: Add some doxygen comments.

release/1.1
alberth 2010-06-26 15:22:10 +00:00
parent ef17c6042f
commit 212dbbf4d8
5 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/console_cmds.cpp
View File

@ -42,7 +42,7 @@
#endif /* ENABLE_NETWORK */ #endif /* ENABLE_NETWORK */
/* scriptfile handling */ /* scriptfile handling */
static bool _script_running; static bool _script_running; ///< Script is running (used to abort execution when #ConReturn is encountered).
/* console command defines */ /* console command defines */
#define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[]) #define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])

4
src/console_gui.cpp
View File

@ -168,7 +168,7 @@ static const WindowDesc _console_window_desc(
struct IConsoleWindow : Window struct IConsoleWindow : Window
{ {
static int scroll; static int scroll;
int line_height; int line_height; ///< Height of one line of text in the console.
int line_offset; int line_offset;
IConsoleWindow() : Window() IConsoleWindow() : Window()
@ -375,6 +375,7 @@ void IConsoleGUIFree()
IConsoleClearBuffer(); IConsoleClearBuffer();
} }
/** Change the size of the in-game console window after the screen size changed, or the window state changed. */
void IConsoleResize(Window *w) void IConsoleResize(Window *w)
{ {
switch (_iconsole_mode) { switch (_iconsole_mode) {
@ -392,6 +393,7 @@ void IConsoleResize(Window *w)
MarkWholeScreenDirty(); MarkWholeScreenDirty();
} }
/** Toggle in-game console between opened and closed. */
void IConsoleSwitch() void IConsoleSwitch()
{ {
switch (_iconsole_mode) { switch (_iconsole_mode) {

4
src/console_internal.h
View File

@ -60,8 +60,8 @@ struct IConsoleAlias {
}; };
/* console parser */ /* console parser */
extern IConsoleCmd *_iconsole_cmds; ///< list of registred commands extern IConsoleCmd *_iconsole_cmds; ///< List of registered commands.
extern IConsoleAlias *_iconsole_aliases; ///< list of registred aliases extern IConsoleAlias *_iconsole_aliases; ///< List of registered aliases.
/* console functions */ /* console functions */
void IConsoleClearBuffer(); void IConsoleClearBuffer();

8
src/console_type.h
View File

@ -12,12 +12,14 @@
#ifndef CONSOLE_TYPE_H #ifndef CONSOLE_TYPE_H
#define CONSOLE_TYPE_H #define CONSOLE_TYPE_H
/** Modes of the in-game console. */
enum IConsoleModes { enum IConsoleModes {
ICONSOLE_FULL, ICONSOLE_FULL, ///< In-game console is closed.
ICONSOLE_OPENED, ICONSOLE_OPENED, ///< In-game console is opened, upper 1/3 of the screen.
ICONSOLE_CLOSED ICONSOLE_CLOSED ///< In-game console is opened, whole screen.
}; };
/** Colours of the console messages. */
enum ConsoleColour { enum ConsoleColour {
CC_DEFAULT = 1, CC_DEFAULT = 1,
CC_ERROR = 3, CC_ERROR = 3,

4
src/livery.h
View File

@ -14,7 +14,7 @@
#include "company_type.h" #include "company_type.h"
/* List of different livery schemes. */ /** List of different livery schemes. */
enum LiveryScheme { enum LiveryScheme {
LS_BEGIN = 0, LS_BEGIN = 0,
LS_DEFAULT = 0, LS_DEFAULT = 0,
@ -57,7 +57,7 @@ enum LiveryScheme {
DECLARE_POSTFIX_INCREMENT(LiveryScheme) DECLARE_POSTFIX_INCREMENT(LiveryScheme)
template <> struct EnumPropsT<LiveryScheme> : MakeEnumPropsT<LiveryScheme, byte, LS_BEGIN, LS_END, LS_END, 8> {}; 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 { enum LiveryClass {
LC_OTHER, LC_OTHER,
LC_RAIL, LC_RAIL,