From d832626bb9f8009c636c3ebef0620ead499ef8d3 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sun, 19 Oct 2008 15:39:12 +0000
Subject: (svn r14491) -Documentation: updates/additions of doxygen docs
 (Alberth)

---
 src/station_map.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'src/station_map.h')

diff --git a/src/station_map.h b/src/station_map.h
index 0f3ff0721..c7d938f3d 100644
--- a/src/station_map.h
+++ b/src/station_map.h
@@ -14,6 +14,10 @@
 
 typedef byte StationGfx;
 
+/** Get Station ID from a tile
+ * @pre Tile \t must be part of the station
+ * @param t Tile to query station ID from
+ * @return Station ID of the station at \a t */
 static inline StationID GetStationIndex(TileIndex t)
 {
 	assert(IsTileType(t, MP_STATION));
@@ -97,16 +101,29 @@ static inline bool IsAirport(TileIndex t)
 
 bool IsHangar(TileIndex t);
 
+/**
+ * Is the station at \a t a truck stop?
+ * @param t Tile to check
+ * @return \c true if station is a truck stop, \c false otherwise */
 static inline bool IsTruckStop(TileIndex t)
 {
 	return GetStationType(t) == STATION_TRUCK;
 }
 
+/**
+ * Is the station at \a t a bus stop?
+ * @param t Tile to check
+ * @return \c true if station is a bus stop, \c false otherwise */
 static inline bool IsBusStop(TileIndex t)
 {
 	return GetStationType(t) == STATION_BUS;
 }
 
+/**
+ * Is the station at \a t a road station?
+ * @pre Tile at \a t is a station tile
+ * @param t Tile to check
+ * @return \c true if station at the tile is a bus top or a truck stop, \c false otherwise */
 static inline bool IsRoadStop(TileIndex t)
 {
 	assert(IsTileType(t, MP_STATION));
-- 
cgit v1.2.3-54-g00ecf