summaryrefslogtreecommitdiff
path: root/src/rail.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2014-09-07 16:13:29 +0000
committeralberth <alberth@openttd.org>2014-09-07 16:13:29 +0000
commitdcc67681ad84a5a046350ad5fe5418b14ab61f32 (patch)
treeb3d61509bb3a6ea3874031897cca0496d106eac2 /src/rail.h
parentf72ad87540a5fa575bf790bb2796c484152998b5 (diff)
downloadopenttd-dcc67681ad84a5a046350ad5fe5418b14ab61f32.tar.xz
(svn r26803) -Doc: Document some fields in the build vehicle gui, and the rail definition struct.
Diffstat (limited to 'src/rail.h')
-rw-r--r--src/rail.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/rail.h b/src/rail.h
index 249c1bea1..90952f5ea 100644
--- a/src/rail.h
+++ b/src/rail.h
@@ -150,16 +150,16 @@ struct RailtypeInfo {
CursorID depot; ///< Cursor for building a depot
CursorID tunnel; ///< Cursor for building a tunnel
CursorID convert; ///< Cursor for converting track
- } cursor;
+ } cursor; ///< Cursors associated with the rail type.
struct {
- StringID name;
- StringID toolbar_caption;
- StringID menu_text;
- StringID build_caption;
- StringID replace_text;
- StringID new_loco;
- } strings;
+ StringID name; ///< Name of this rail type.
+ StringID toolbar_caption; ///< Caption in the construction toolbar GUI for this rail type.
+ StringID menu_text; ///< Name of this rail type in the main toolbar dropdown.
+ StringID build_caption; ///< Caption of the build vehicle GUI for this rail type.
+ StringID replace_text; ///< Text used in the autoreplace GUI.
+ StringID new_loco; ///< Name of an engine for this type of rail in the engine preview GUI.
+ } strings; ///< Strings associated with the rail type.
/** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */
SpriteID snow_offset;