(svn r23452) -Codechange: document instead of writing to stderr that ScriptStation::GetCoverageRadius doesn't work for STATION_AIRPORT

2011-12-08 23:28:02 +00:00
parent 2c07e9cae8
commit 4430cadfa1
2 changed files with 4 additions and 4 deletions
--- a/src/script/api/script_station.hpp
+++ b/src/script/api/script_station.hpp
@@ -89,7 +89,9 @@ public:
 	/**
 	 * Get the coverage radius of this type of station.
 	 * @param station_type The type of station.
+	 * @pre station_type != STATION_AIRPORT.
 	 * @return The radius in tiles.
+	 * @note Coverage radius of airports needs to be requested via ScriptAirport::GetAirportCoverageRadius(), as it requires AirportType.
 	 */
 	static int32 GetCoverageRadius(ScriptStation::StationType station_type);