(svn r12508) [NoAI] -Fix: @note that refer to @return should come after @return, not before @param noai
authortruebrain
Mon, 31 Mar 2008 09:32:51 +0000
branchnoai
changeset 9842 ef007135fa47
parent 9841 f931a10242c9
child 9843 29f34a179daf
(svn r12508) [NoAI] -Fix: @note that refer to @return should come after @return, not before @param
src/ai/api/ai_engine.hpp
src/ai/api/ai_tile.hpp
--- a/src/ai/api/ai_engine.hpp	Mon Mar 31 09:25:03 2008 +0000
+++ b/src/ai/api/ai_engine.hpp	Mon Mar 31 09:32:51 2008 +0000
@@ -88,19 +88,19 @@
 
 	/**
 	 * Get the maximum age of a brand new engine.
-	 * @note age is in days; divide by 366 to get per year.
 	 * @param engine_id The engine to get the maximum age of.
 	 * @pre IsValidEngine(engine_id).
 	 * @returns The maximum age of a new engine in days.
+	 * @note Age is in days; divide by 366 to get per year.
 	 */
 	static uint32 GetMaxAge(EngineID engine_id);
 
 	/**
 	 * Get the running cost of an engine.
-	 * @note cost is per year; divide by 364 to get per day.
 	 * @param engine_id The engine to get the running cost of.
 	 * @pre IsValidEngine(engine_id).
 	 * @return The running cost of a vehicle per year.
+	 * @note Cost is per year; divide by 364 to get per day.
 	 */
 	static Money GetRunningCost(EngineID engine_id);
 
--- a/src/ai/api/ai_tile.hpp	Mon Mar 31 09:25:03 2008 +0000
+++ b/src/ai/api/ai_tile.hpp	Mon Mar 31 09:32:51 2008 +0000
@@ -58,12 +58,12 @@
 	/**
 	 * Check if this tile is buildable in a rectangle around a tile, with the
 	 *  entry in the list as top-left.
-	 * @note Road and rail are considered buildable.
 	 * @param tile The tile to check on.
 	 * @param width The width of the rectangle.
 	 * @param height The height of the rectangle.
 	 * @pre AIMap::IsValidTile(tile).
 	 * @return True if it is buildable, false if not.
+	 * @note Road and rail are considered buildable.
 	 */
 	static bool IsBuildableRectangle(TileIndex tile, uint width, uint height);