src/ai/api/ai_marine.hpp
branchnoai
changeset 9836 54afebfded49
parent 9829 80fbe02a4184
child 10094 e737405b06dd
--- a/src/ai/api/ai_marine.hpp	Mon Mar 31 07:21:39 2008 +0000
+++ b/src/ai/api/ai_marine.hpp	Mon Mar 31 07:37:51 2008 +0000
@@ -16,122 +16,122 @@
 
 	/**
 	 * Checks whether the given tile is actually a tile with a water depot.
-	 * @param tile the tile to check.
+	 * @param tile The tile to check.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return true if and only if the tile has a water depot.
+	 * @return True if and only if the tile has a water depot.
 	 */
 	static bool IsWaterDepotTile(TileIndex tile);
 
 	/**
 	 * Checks whether the given tile is actually a tile with a dock.
-	 * @param tile the tile to check.
+	 * @param tile The tile to check.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return true if and only if the tile has a dock.
+	 * @return True if and only if the tile has a dock.
 	 */
 	static bool IsDockTile(TileIndex tile);
 
 	/**
 	 * Checks whether the given tile is actually a tile with a buoy.
-	 * @param tile the tile to check.
+	 * @param tile The tile to check.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return true if and only if the tile has a buoy.
+	 * @return True if and only if the tile has a buoy.
 	 */
 	static bool IsBuoyTile(TileIndex tile);
 
 	/**
 	 * Checks whether the given tile is actually a tile with a lock.
-	 * @param tile the tile to check.
+	 * @param tile The tile to check.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return true if and only if the tile has a lock.
+	 * @return True if and only if the tile has a lock.
 	 */
 	static bool IsLockTile(TileIndex tile);
 
 	/**
 	 * Checks whether the given tile is actually a tile with a canal.
-	 * @param tile the tile to check.
+	 * @param tile The tile to check.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return true if and only if the tile has a canal.
+	 * @return True if and only if the tile has a canal.
 	 */
 	static bool IsCanalTile(TileIndex tile);
 
 	/**
 	 * Builds a water depot on tile.
-	 * @param tile the tile where the water depot will be build.
-	 * @param vertical if true, depot will be vertical, else horizontal.
+	 * @param tile The tile where the water depot will be build.
+	 * @param vertical If true, depot will be vertical, else horizontal.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the water depot has been/can be build or not.
+	 * @return Whether the water depot has been/can be build or not.
 	 */
 	static bool BuildWaterDepot(TileIndex tile, bool vertical);
 
 	/**
 	 * Builds a dock where tile is the tile still on land.
-	 * @param tile the tile still on land of the dock.
+	 * @param tile The tile still on land of the dock.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the dock has been/can be build or not.
+	 * @return Whether the dock has been/can be build or not.
 	 */
 	static bool BuildDock(TileIndex tile);
 
 	/**
 	 * Builds a buoy on tile.
-	 * @param tile the tile where the buoy will be build.
+	 * @param tile The tile where the buoy will be build.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the buoy has been/can be build or not.
+	 * @return Whether the buoy has been/can be build or not.
 	 */
 	static bool BuildBuoy(TileIndex tile);
 
 	/**
 	 * Builds a lock on tile.
-	 * @param tile the tile where the lock will be build.
+	 * @param tile The tile where the lock will be build.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the lock has been/can be build or not.
+	 * @return Whether the lock has been/can be build or not.
 	 */
 	static bool BuildLock(TileIndex tile);
 
 	/**
 	 * Builds a canal on tile.
-	 * @param tile the tile where the canal will be build.
+	 * @param tile The tile where the canal will be build.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the canal has been/can be build or not.
+	 * @return Whether the canal has been/can be build or not.
 	 */
 	static bool BuildCanal(TileIndex tile);
 
 	/**
 	 * Removes a water depot.
-	 * @param tile any tile of the water depot.
+	 * @param tile Any tile of the water depot.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the water depot has been/can be removed or not.
+	 * @return Whether the water depot has been/can be removed or not.
 	 */
 	static bool RemoveWaterDepot(TileIndex tile);
 
 	/**
 	 * Removes a dock.
-	 * @param tile any tile of the dock.
+	 * @param tile Any tile of the dock.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the dock has been/can be removed or not.
+	 * @return Whether the dock has been/can be removed or not.
 	 */
 	static bool RemoveDock(TileIndex tile);
 
 	/**
 	 * Removes a buoy.
-	 * @param tile any tile of the buoy.
+	 * @param tile Any tile of the buoy.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the buoy has been/can be removed or not.
+	 * @return Whether the buoy has been/can be removed or not.
 	 */
 	static bool RemoveBuoy(TileIndex tile);
 
 	/**
 	 * Removes a lock.
-	 * @param tile any tile of the lock.
+	 * @param tile Any tile of the lock.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the lock has been/can be removed or not.
+	 * @return Whether the lock has been/can be removed or not.
 	 */
 	static bool RemoveLock(TileIndex tile);
 
 	/**
 	 * Removes a canal.
-	 * @param tile any tile of the canal.
+	 * @param tile Any tile of the canal.
 	 * @pre AIMap::IsValidTile(tile).
-	 * @return whether the canal has been/can be removed or not.
+	 * @return Whether the canal has been/can be removed or not.
 	 */
 	static bool RemoveCanal(TileIndex tile);
 };