diff options
| author | alberth <alberth@openttd.org> | 2011-05-14 18:38:54 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2011-05-14 18:38:54 +0000 |
| commit | 990ec6f0a91038dabde458d6aa28a608ba3c52f5 (patch) | |
| tree | fcf64c9fd4357c51798b7895a6adc3c081276ac0 /src/openttd.h | |
| parent | 28092366ec8aaf953b6e8bb92d745ee2c32fad1e (diff) | |
| download | openttd-990ec6f0a91038dabde458d6aa28a608ba3c52f5.tar.xz | |
(svn r22460) -Doc: Semantic documentation fixes, and doxygen additions (partly by planetmaker).
Diffstat (limited to 'src/openttd.h')
| -rw-r--r-- | src/openttd.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/openttd.h b/src/openttd.h index 5b48a4f60..6646801e3 100644 --- a/src/openttd.h +++ b/src/openttd.h @@ -36,14 +36,14 @@ enum SwitchMode { SM_LOAD_HEIGHTMAP, }; -/* Display Options */ +/** Display Options */ enum DisplayOptions { - DO_SHOW_TOWN_NAMES = 0, - DO_SHOW_STATION_NAMES = 1, - DO_SHOW_SIGNS = 2, - DO_FULL_ANIMATION = 3, - DO_FULL_DETAIL = 5, - DO_SHOW_WAYPOINT_NAMES = 6, + DO_SHOW_TOWN_NAMES = 0, ///< Display town names. + DO_SHOW_STATION_NAMES = 1, ///< Display station names. + DO_SHOW_SIGNS = 2, ///< Display signs. + DO_FULL_ANIMATION = 3, ///< Perform palette animation. + DO_FULL_DETAIL = 5, ///< Also draw details of track and roads. + DO_SHOW_WAYPOINT_NAMES = 6, ///< Display waypoint names. }; extern GameMode _game_mode; @@ -59,7 +59,7 @@ enum PauseMode { PM_PAUSED_ERROR = 1 << 3, ///< A game paused because a (critical) error PM_PAUSED_ACTIVE_CLIENTS = 1 << 4, ///< A game paused for 'min_active_clients' - /* Pause mode bits when paused for network reasons */ + /** Pause mode bits when paused for network reasons. */ PMB_PAUSED_NETWORK = PM_PAUSED_ACTIVE_CLIENTS | PM_PAUSED_JOIN, }; DECLARE_ENUM_AS_BIT_SET(PauseMode) |