--- a/src/ai/api/ai_bridge.hpp Sun Jun 15 23:35:40 2008 +0000
+++ b/src/ai/api/ai_bridge.hpp Mon Jun 16 00:07:49 2008 +0000
@@ -103,6 +103,9 @@
/**
* Build a bridge from one tile to the other.
+ * As an extra for road, this functions builds two half-pieces of road on
+ * each end of the bridge, making it easier for you to connect it to your
+ * network.
* @param vehicle_type The vehicle-type of bridge to build.
* @param bridge_id The bridge-type to build.
* @param start Where to start the bridge.
@@ -121,6 +124,8 @@
* @exception AIBridge::ERR_BRIDGE_CANNOT_END_IN_WATER
* @exception AIBridge::ERR_BRIDGE_HEADS_NOT_ON_SAME_HEIGHT
* @return Whether the bridge has been/can be build or not.
+ * @note No matter if the road pieces were build or not, if building the
+ * bridge succeeded, this function returns true.
*/
static bool BuildBridge(AIVehicle::VehicleType vehicle_type, BridgeID bridge_id, TileIndex start, TileIndex end);