diff options
| author | rubidium <rubidium@openttd.org> | 2011-05-01 19:51:52 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-05-01 19:51:52 +0000 |
| commit | 5a620d1c6592057b500f0889eef8949dc1e95e4b (patch) | |
| tree | dabae6247490fdea860bea292bb8eee49ce46fe4 /src/station_map.h | |
| parent | 1a515e6344028854c855671c19f49d8f869eb18f (diff) | |
| download | openttd-5a620d1c6592057b500f0889eef8949dc1e95e4b.tar.xz | |
(svn r22406) -Document: some more "random-ish" tidbits
Diffstat (limited to 'src/station_map.h')
| -rw-r--r-- | src/station_map.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/station_map.h b/src/station_map.h index 661cc834c..1411a7833 100644 --- a/src/station_map.h +++ b/src/station_map.h @@ -33,8 +33,8 @@ static inline StationID GetStationIndex(TileIndex t) } -static const int GFX_DOCK_BASE_WATER_PART = 4; -static const int GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET = 4; +static const int GFX_DOCK_BASE_WATER_PART = 4; ///< The offset for the water parts. +static const int GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET = 4; ///< The offset for the drive through parts. /** * Get the station type of this tile @@ -476,6 +476,7 @@ static inline bool IsCustomStationSpecIndex(TileIndex t) /** * Set the custom station spec for this tile. * @param t Tile to set the stationspec of. + * @param specindex The new spec. * @pre HasStationTileRail(t) */ static inline void SetCustomStationSpecIndex(TileIndex t, byte specindex) @@ -498,7 +499,8 @@ static inline uint GetCustomStationSpecIndex(TileIndex t) /** * Set the random bits for a station tile. - * @param t Tile to set random bits for + * @param t Tile to set random bits for. + * @param random_bits The random bits. * @pre IsTileType(t, MP_STATION) */ static inline void SetStationTileRandomBits(TileIndex t, byte random_bits) @@ -526,6 +528,7 @@ static inline byte GetStationTileRandomBits(TileIndex t) * @param sid the station to which this tile belongs * @param st the type this station tile * @param section the StationGfx to be used for this tile + * @param wc The water class of the station */ static inline void MakeStation(TileIndex t, Owner o, StationID sid, StationType st, byte section, WaterClass wc = WATER_CLASS_INVALID) { @@ -599,7 +602,7 @@ static inline void MakeRoadStop(TileIndex t, Owner o, StationID sid, RoadStopTyp * @param sid the station to which this tile belongs * @param rst the type of roadstop to make this tile * @param rt the roadtypes on this tile - * @param d the direction of the roadstop + * @param a the direction of the roadstop */ static inline void MakeDriveThroughRoadStop(TileIndex t, Owner station, Owner road, Owner tram, StationID sid, RoadStopType rst, RoadTypes rt, Axis a) { |