cpp/openttd-patchpack/source Changeset - r15369:4eefcf058ead

Changeset - r15369:4eefcf058ead

Parent rev.

Child rev.

[Not reviewed]

master

0 5 0

alberth - 14 years ago 2010-06-26 15:22:10
alberth@openttd.org

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

5 files changed with 13 insertions and 9 deletions:

src/console_cmds.cpp

src/console_gui.cpp

src/console_internal.h

src/console_type.h

src/livery.h

0 comments (0 inline, 0 general)

src/console_cmds.cpp

➞

Show inline comments

@@ @@ -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[])

src/console_gui.cpp

➞

Show inline comments

@@ @@ -168,7 +168,7 @@ static const WindowDesc _console_window_ @@
 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) {

src/console_internal.h

➞

Show inline comments

@@ @@ -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();

src/console_type.h

➞

Show inline comments

@@ @@ -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,

src/livery.h

➞

Show inline comments

@@ @@ -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,

0 comments (0 inline, 0 general)