(svn r10623) [NoAI] -Documentation: document AITileListNeighbourRoadCount a bit more
--- a/src/ai/api/ai_tilelist_valuator.hpp Wed Jul 18 15:30:34 2007 +0000
+++ b/src/ai/api/ai_tilelist_valuator.hpp Thu Jul 19 16:17:10 2007 +0000
@@ -63,8 +63,9 @@
};
/**
- * Count the neighbour tiles which have a piece of road of tiles in AITileList.
- * @note resulting items are of the type int32 (the amount of neighbour road tiles)
+ * Count for each entry in AITileList the amount of neighbours that contain road.
+ * This is a value between 0 and 4, as it only check horizontal and vertical.
+ * @note resulting items are of the type int32 (the amount of neighbour road tiles, value between 0 and 4)
* @note the input items are of the type TileIndex
*/
class AITileListNeighbourRoadCount : public AIAbstractList::Valuator {