(svn r9670) -Documentation: add documentation to some the _map files.

2007-04-18 18:20:31 +00:00
parent 4eb87ac62b
commit aa284fd531
4 changed files with 141 additions and 18 deletions
--- a/src/station_map.cpp
+++ b/src/station_map.cpp
@@ -6,7 +6,12 @@
 #include "openttd.h"
 #include "station_map.h"

-
+/**
+ * Get the station type (rail, airport, truck etc) for the given tile.
+ * @param t the tile to get the station type of.
+ * @pre IsTileType(t, MP_STATION)
+ * @return the station type of the given tile.
+ */
 StationType GetStationType(TileIndex t)
 {
 	assert(IsTileType(t, MP_STATION));