From 99cb47a3825f370e19adacd1ad1e6241eccb99f9 Mon Sep 17 00:00:00 2001 From: yexo Date: Sun, 1 Aug 2010 19:36:36 +0000 Subject: (svn r20284) -Codechange: use ///< for single-line doxygen comments in the AI code --- src/ai/api/ai_rail.hpp | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) (limited to 'src/ai/api/ai_rail.hpp') diff --git a/src/ai/api/ai_rail.hpp b/src/ai/api/ai_rail.hpp index 4517aa4d0..79f12d215 100644 --- a/src/ai/api/ai_rail.hpp +++ b/src/ai/api/ai_rail.hpp @@ -48,7 +48,7 @@ public: */ enum RailType { /* Note: the values _are_ important as they represent an in-game value */ - RAILTYPE_INVALID = 0xFF, //!< Invalid RailType. + RAILTYPE_INVALID = 0xFF, ///< Invalid RailType. }; /** @@ -56,13 +56,13 @@ public: */ enum RailTrack { /* Note: the values _are_ important as they represent an in-game value */ - RAILTRACK_NE_SW = 1 << 0, //!< Track along the x-axis (north-east to south-west). - RAILTRACK_NW_SE = 1 << 1, //!< Track along the y-axis (north-west to south-east). - RAILTRACK_NW_NE = 1 << 2, //!< Track in the upper corner of the tile (north). - RAILTRACK_SW_SE = 1 << 3, //!< Track in the lower corner of the tile (south). - RAILTRACK_NW_SW = 1 << 4, //!< Track in the left corner of the tile (west). - RAILTRACK_NE_SE = 1 << 5, //!< Track in the right corner of the tile (east). - RAILTRACK_INVALID = 0xFF, //!< Flag for an invalid track. + RAILTRACK_NE_SW = 1 << 0, ///< Track along the x-axis (north-east to south-west). + RAILTRACK_NW_SE = 1 << 1, ///< Track along the y-axis (north-west to south-east). + RAILTRACK_NW_NE = 1 << 2, ///< Track in the upper corner of the tile (north). + RAILTRACK_SW_SE = 1 << 3, ///< Track in the lower corner of the tile (south). + RAILTRACK_NW_SW = 1 << 4, ///< Track in the left corner of the tile (west). + RAILTRACK_NE_SE = 1 << 5, ///< Track in the right corner of the tile (east). + RAILTRACK_INVALID = 0xFF, ///< Flag for an invalid track. }; /** @@ -70,29 +70,29 @@ public: */ enum SignalType { /* Note: the values _are_ important as they represent an in-game value */ - SIGNALTYPE_NORMAL = 0, //!< Normal signal. - SIGNALTYPE_ENTRY = 1, //!< Entry presignal. - SIGNALTYPE_EXIT = 2, //!< Exit signal. - SIGNALTYPE_COMBO = 3, //!< Combo signal. - SIGNALTYPE_PBS = 4, //!< Normal PBS signal. - SIGNALTYPE_PBS_ONEWAY = 5, //!< No-entry PBS signal. - SIGNALTYPE_TWOWAY = 8, //!< Bit mask for twoway signal. - SIGNALTYPE_NORMAL_TWOWAY = SIGNALTYPE_NORMAL | SIGNALTYPE_TWOWAY, //!< Normal twoway signal. - SIGNALTYPE_ENTRY_TWOWAY = SIGNALTYPE_ENTRY | SIGNALTYPE_TWOWAY, //!< Entry twoway signal. - SIGNALTYPE_EXIT_TWOWAY = SIGNALTYPE_EXIT | SIGNALTYPE_TWOWAY, //!< Exit twoway signal. - SIGNALTYPE_COMBO_TWOWAY = SIGNALTYPE_COMBO | SIGNALTYPE_TWOWAY, //!< Combo twoway signal. - SIGNALTYPE_NONE = 0xFF, //!< No signal. + SIGNALTYPE_NORMAL = 0, ///< Normal signal. + SIGNALTYPE_ENTRY = 1, ///< Entry presignal. + SIGNALTYPE_EXIT = 2, ///< Exit signal. + SIGNALTYPE_COMBO = 3, ///< Combo signal. + SIGNALTYPE_PBS = 4, ///< Normal PBS signal. + SIGNALTYPE_PBS_ONEWAY = 5, ///< No-entry PBS signal. + SIGNALTYPE_TWOWAY = 8, ///< Bit mask for twoway signal. + SIGNALTYPE_NORMAL_TWOWAY = SIGNALTYPE_NORMAL | SIGNALTYPE_TWOWAY, ///< Normal twoway signal. + SIGNALTYPE_ENTRY_TWOWAY = SIGNALTYPE_ENTRY | SIGNALTYPE_TWOWAY, ///< Entry twoway signal. + SIGNALTYPE_EXIT_TWOWAY = SIGNALTYPE_EXIT | SIGNALTYPE_TWOWAY, ///< Exit twoway signal. + SIGNALTYPE_COMBO_TWOWAY = SIGNALTYPE_COMBO | SIGNALTYPE_TWOWAY, ///< Combo twoway signal. + SIGNALTYPE_NONE = 0xFF, ///< No signal. }; /** * Types of rail-related objects in the game. */ enum BuildType { - BT_TRACK, //!< Build a track - BT_SIGNAL, //!< Build a signal - BT_DEPOT, //!< Build a depot - BT_STATION, //!< Build a station - BT_WAYPOINT, //!< Build a rail waypoint + BT_TRACK, ///< Build a track + BT_SIGNAL, ///< Build a signal + BT_DEPOT, ///< Build a depot + BT_STATION, ///< Build a station + BT_WAYPOINT, ///< Build a rail waypoint }; /** -- cgit v1.2.3-54-g00ecf