Mercurial > hg > openttd

changeset 15379:46202127b446 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r20022) -Doc: Add some doxygen comments.
author alberth <alberth@openttd.org>
date Sat, 26 Jun 2010 15:22:10 +0000
parents ee826a793259
children 68d5e0063d97
files src/console_cmds.cpp src/console_gui.cpp src/console_internal.h src/console_type.h src/livery.h
diffstat 5 files changed, 13 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- 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[])
--- a/src/console_gui.cpp
+++ b/src/console_gui.cpp
@@ -168,7 +168,7 @@
 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 @@
 	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 @@
 	MarkWholeScreenDirty();
 }
 
+/** Toggle in-game console between opened and closed. */
 void IConsoleSwitch()
 {
 	switch (_iconsole_mode) {
--- a/src/console_internal.h
+++ b/src/console_internal.h
@@ -60,8 +60,8 @@
 };
 
 /* 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();
--- 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,
--- 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 @@
 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,