(svn r10608) [NoAI] -Documentation: comment some functions to make Doxygen happy
--- a/src/ai/api/ai_airport.hpp Sun Jul 15 16:39:11 2007 +0000
+++ b/src/ai/api/ai_airport.hpp Wed Jul 18 08:38:50 2007 +0000
@@ -12,6 +12,9 @@
*/
class AIAirport : public AIObject {
public:
+ /**
+ * The types of airports available in the game.
+ */
enum AirportType {
AT_SMALL = 0,
AT_LARGE = 1,
--- a/src/ai/api/ai_pathfinder.hpp Sun Jul 15 16:39:11 2007 +0000
+++ b/src/ai/api/ai_pathfinder.hpp Wed Jul 18 08:38:50 2007 +0000
@@ -15,6 +15,9 @@
*/
class AIPathFinder : public AIObject {
public:
+ /**
+ * The type of pathfinders known in the game.
+ */
enum PathFinderType {
PATHFINDER_ROAD = 0,
PATHFINDER_RAIL = 1,
--- a/src/ai/api/ai_stationlist.hpp Sun Jul 15 16:39:11 2007 +0000
+++ b/src/ai/api/ai_stationlist.hpp Wed Jul 18 08:38:50 2007 +0000
@@ -12,6 +12,11 @@
*/
class AIStationList : public AIAbstractList {
public:
+ /**
+ * Type of stations to get the list of.
+ * You you give BUS_STOP + TRAIN, and a station only has a
+ * bus-stop, it will be considered a hit.
+ */
enum StationType {
STATION_ANY = 0x00,
STATION_TRAIN = 0x01,
--- a/src/ai/api/ai_tilelist_valuator.hpp Sun Jul 15 16:39:11 2007 +0000
+++ b/src/ai/api/ai_tilelist_valuator.hpp Wed Jul 18 08:38:50 2007 +0000
@@ -35,6 +35,9 @@
*/
static const char *GetClassName() { return "AITileListBuildableRectangle"; }
+ /**
+ * Custom constructor, we want a width and height as parameter.
+ */
AITileListBuildableRectangle(uint width, uint height) { this->width = width; this->height = height; }
private: