From 82a1d0f2e459644d1385077aea42a4841b889329 Mon Sep 17 00:00:00 2001 From: rubidium Date: Tue, 3 Apr 2007 21:51:40 +0000 Subject: (svn r9554) -Documentation: add documentation to some map accessors. --- src/road_map.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'src/road_map.h') diff --git a/src/road_map.h b/src/road_map.h index 6385b0cc8..88e0a0295 100644 --- a/src/road_map.h +++ b/src/road_map.h @@ -173,10 +173,19 @@ static inline DiagDirection GetRoadDepotDirection(TileIndex t) * - road tunnels: entrance is treated as road piece * - bridge ramps: start of the ramp is treated as road piece * - bridge middle parts: bridge itself is ignored + * @param tile the tile to get the road bits for + * @return the road bits of the given tile */ -RoadBits GetAnyRoadBits(TileIndex); - +RoadBits GetAnyRoadBits(TileIndex tile); +/** + * Get the accessible track bits for the given tile. + * Special behaviour: + * - road depots: no track bits + * - non-drive-through stations: no track bits + * @param tile the tile to get the track bits for + * @return the track bits for the given tile + */ TrackBits GetAnyRoadTrackBits(TileIndex tile); -- cgit v1.2.3-70-g09d2