From 33ff55a8f1287643986621e7130e8acddf42b221 Mon Sep 17 00:00:00 2001 From: alberth Date: Sat, 10 Nov 2012 20:46:39 +0000 Subject: (svn r24693) -Doc: Add some doxymentation into the newgrf code. --- src/newgrf_station.h | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'src/newgrf_station.h') diff --git a/src/newgrf_station.h b/src/newgrf_station.h index ee7757376..a536687a6 100644 --- a/src/newgrf_station.h +++ b/src/newgrf_station.h @@ -22,12 +22,13 @@ #include "newgrf_spritegroup.h" #include "newgrf_town.h" +/** Scope resolver for stations. */ struct StationScopeResolver : public ScopeResolver { - TileIndex tile; - struct BaseStation *st; - const struct StationSpec *statspec; - CargoID cargo_type; - Axis axis; ///< Station axis, used only for the slope check callback. + TileIndex tile; ///< %Tile of the station. + struct BaseStation *st; ///< Instance of the station. + const struct StationSpec *statspec; ///< Station (type) specification. + CargoID cargo_type; ///< Type of cargo of the station. + Axis axis; ///< Station axis, used only for the slope check callback. StationScopeResolver(ResolverObject *ro, const StationSpec *statspec, BaseStation *st, TileIndex tile); @@ -38,9 +39,10 @@ struct StationScopeResolver : public ScopeResolver { /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const; }; +/** Station resolver. */ struct StationResolverObject : public ResolverObject { - StationScopeResolver station_scope; - TownScopeResolver *town_scope; + StationScopeResolver station_scope; ///< The station scope resolver. + TownScopeResolver *town_scope; ///< The town scope resolver (created on the first call). StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile, CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0); -- cgit v1.2.3-54-g00ecf