(svn r20288) -Doc: add doxygen string to all GetClassName functions (part of all AI api classes)

src/ai/api/ai_abstractlist.hpp

@@ -24,6 +24,7 @@ class AIAbstractListSorter;
  */
 class AIAbstractList : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIAbstractList"; }
 
 	/** Type of sorter */

src/ai/api/ai_accounting.hpp

@@ -29,6 +29,7 @@
  */
 class AIAccounting : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIAccounting"; }
 
 	/**

src/ai/api/ai_airport.hpp

@@ -19,6 +19,7 @@
  */
 class AIAirport : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIAirport"; }
 
 	/**

src/ai/api/ai_base.hpp

@@ -25,6 +25,7 @@
  */
 class AIBase : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIBase"; }
 
 	/**

src/ai/api/ai_basestation.hpp

@@ -20,6 +20,7 @@
  */
 class AIBaseStation : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIBaseStation"; }
 
 	/**

src/ai/api/ai_bridge.hpp

@@ -41,6 +41,7 @@ public:
 		ERR_BRIDGE_HEADS_NOT_ON_SAME_HEIGHT, // [STR_ERROR_BRIDGEHEADS_NOT_SAME_HEIGHT]
 	};
 
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIBridge"; }
 
 	/**

src/ai/api/ai_bridgelist.hpp

@@ -20,6 +20,7 @@
  */
 class AIBridgeList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIBridgeList"; }
 	AIBridgeList();
 };
@@ -30,6 +31,7 @@ public:
  */
 class AIBridgeList_Length : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIBridgeList_Length"; }
 
 	/**

src/ai/api/ai_cargo.hpp

@@ -19,6 +19,7 @@
  */
 class AICargo : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AICargo"; }
 
 	/**

src/ai/api/ai_cargolist.hpp

@@ -20,6 +20,7 @@
  */
 class AICargoList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AICargoList"; }
 	AICargoList();
 };
@@ -30,6 +31,7 @@ public:
  */
 class AICargoList_IndustryAccepting : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AICargoList_IndustryAccepting"; }
 
 	/**
@@ -44,6 +46,7 @@ public:
  */
 class AICargoList_IndustryProducing : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AICargoList_IndustryProducing"; }
 
 	/**

src/ai/api/ai_company.hpp

@@ -19,6 +19,7 @@
  */
 class AICompany : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AICompany"; }
 
 	/** Different constants related to CompanyID. */

src/ai/api/ai_controller.hpp

@@ -24,6 +24,7 @@ class AIController {
 	friend class AIInstance;
 
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIController"; }
 
 	/**

src/ai/api/ai_date.hpp

@@ -26,6 +26,7 @@
  */
 class AIDate : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIDate"; }
 
 	/**

src/ai/api/ai_depotlist.hpp

@@ -21,6 +21,7 @@
  */
 class AIDepotList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIDepotList"; }
 
 	/**

src/ai/api/ai_engine.hpp

@@ -23,6 +23,7 @@
  */
 class AIEngine : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEngine"; }
 
 	/**

src/ai/api/ai_enginelist.hpp

@@ -21,6 +21,7 @@
  */
 class AIEngineList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEngineList"; }
 
 	/**

src/ai/api/ai_error.hpp

@@ -43,6 +43,7 @@
  */
 class AIError : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIError"; }
 
 	/**

src/ai/api/ai_event.hpp

@@ -21,6 +21,7 @@
  */
 class AIEvent : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEvent"; }
 
 	/**
@@ -81,6 +82,7 @@ public:
 	/**
 	 * The name of the class, needed by several sub-processes.
 	 */
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventController"; }
 
 	/**

src/ai/api/ai_event_types.hpp

@@ -22,6 +22,7 @@
  */
 class AIEventVehicleCrashed : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventVehicleCrashed"; }
 
 	/**
@@ -84,6 +85,7 @@ private:
  */
 class AIEventSubsidyOffer : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventSubsidyOffer"; }
 
 	/**
@@ -116,6 +118,7 @@ private:
  */
 class AIEventSubsidyOfferExpired : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventSubsidyOfferExpired"; }
 
 	/**
@@ -148,6 +151,7 @@ private:
  */
 class AIEventSubsidyAwarded : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventSubsidyAwarded"; }
 
 	/**
@@ -180,6 +184,7 @@ private:
  */
 class AIEventSubsidyExpired : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventSubsidyExpired"; }
 
 	/**
@@ -214,6 +219,7 @@ private:
  */
 class AIEventEnginePreview : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventEnginePreview"; }
 
 	/**
@@ -298,6 +304,7 @@ private:
  */
 class AIEventCompanyNew : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventCompanyNew"; }
 
 	/**
@@ -331,6 +338,7 @@ private:
  */
 class AIEventCompanyInTrouble : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventCompanyInTrouble"; }
 
 	/**
@@ -363,6 +371,7 @@ private:
  */
 class AIEventCompanyAskMerger : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventCompanyAskMerger"; }
 
 	/**
@@ -412,6 +421,7 @@ private:
  */
 class AIEventCompanyMerger : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventCompanyMerger"; }
 
 	/**
@@ -456,6 +466,7 @@ private:
  */
 class AIEventCompanyBankrupt : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventCompanyBankrupt"; }
 
 	/**
@@ -488,6 +499,7 @@ private:
  */
 class AIEventVehicleLost : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventVehicleLost"; }
 
 	/**
@@ -520,6 +532,7 @@ private:
  */
 class AIEventVehicleWaitingInDepot : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventVehicleWaitingInDepot"; }
 
 	/**
@@ -552,6 +565,7 @@ private:
  */
 class AIEventVehicleUnprofitable : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventVehicleUnprofitable"; }
 
 	/**
@@ -584,6 +598,7 @@ private:
  */
 class AIEventIndustryOpen : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventIndustryOpen"; }
 
 	/**
@@ -616,6 +631,7 @@ private:
  */
 class AIEventIndustryClose : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventIndustryClose"; }
 
 	/**
@@ -648,6 +664,7 @@ private:
  */
 class AIEventEngineAvailable : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventEngineAvailable"; }
 
 	/**
@@ -680,6 +697,7 @@ private:
  */
 class AIEventStationFirstVehicle : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventStationFirstVehicle"; }
 
 	/**
@@ -721,6 +739,7 @@ private:
  */
 class AIEventDisasterZeppelinerCrashed : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventDisasterZeppelinerCrashed"; }
 
 	/**
@@ -753,6 +772,7 @@ private:
  */
 class AIEventDisasterZeppelinerCleared : public AIEvent {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIEventDisasterZeppelinerCleared"; }
 
 	/**

src/ai/api/ai_execmode.hpp

@@ -23,6 +23,7 @@
  */
 class AIExecMode : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIExecMode"; }
 
 private:

src/ai/api/ai_gamesettings.hpp

@@ -37,6 +37,7 @@
  */
 class AIGameSettings : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIGameSettings"; }
 
 	/**

src/ai/api/ai_group.hpp

@@ -20,6 +20,7 @@
  */
 class AIGroup : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIGroup"; }
 
 	/**

src/ai/api/ai_grouplist.hpp

@@ -21,6 +21,7 @@
  */
 class AIGroupList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIGroupList"; }
 	AIGroupList();
 };

src/ai/api/ai_industry.hpp

@@ -19,6 +19,7 @@
  */
 class AIIndustry : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustry"; }
 
 	/**

src/ai/api/ai_industrylist.hpp

@@ -20,6 +20,7 @@
  */
 class AIIndustryList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustryList"; }
 	AIIndustryList();
 };
@@ -30,6 +31,7 @@ public:
  */
 class AIIndustryList_CargoAccepting : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; }
 
 	/**
@@ -45,6 +47,7 @@ public:
  */
 class AIIndustryList_CargoProducing : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustryList_CargoProducing"; }
 
 	/**

src/ai/api/ai_industrytype.hpp

@@ -21,6 +21,7 @@
  */
 class AIIndustryType : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustryType"; }
 
 	/**

src/ai/api/ai_industrytypelist.hpp

@@ -21,6 +21,7 @@
  */
 class AIIndustryTypeList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIIndustryTypeList"; }
 	AIIndustryTypeList();
 };

src/ai/api/ai_list.hpp

@@ -20,6 +20,7 @@
  */
 class AIList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIList"; }
 
 public:

src/ai/api/ai_log.hpp

@@ -23,6 +23,7 @@ class AILog : public AIObject {
 	friend class AIController;
 
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AILog"; }
 
 #ifndef EXPORT_SKIP

src/ai/api/ai_map.hpp

@@ -22,6 +22,7 @@ class AIMap : public AIObject {
 public:
 	static const int TILE_INVALID = (int)INVALID_TILE; ///< Invalid TileIndex.
 
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIMap"; }
 
 	/**

src/ai/api/ai_marine.hpp

@@ -20,6 +20,7 @@
  */
 class AIMarine : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIMarine"; }
 
 	/**

src/ai/api/ai_order.hpp

@@ -20,6 +20,7 @@
  */
 class AIOrder : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIOrder"; }
 
 	/**

src/ai/api/ai_rail.hpp

@@ -21,6 +21,7 @@
  */
 class AIRail : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIRail"; }
 
 	/**

src/ai/api/ai_railtypelist.hpp

@@ -20,6 +20,7 @@
  */
 class AIRailTypeList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIRailTypeList"; }
 	AIRailTypeList();
 };

src/ai/api/ai_road.hpp

@@ -21,6 +21,7 @@
  */
 class AIRoad : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIRoad"; }
 
 	/**

src/ai/api/ai_sign.hpp

@@ -21,6 +21,7 @@
  */
 class AISign : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AISign"; }
 
 	/**

src/ai/api/ai_signlist.hpp

@@ -20,6 +20,7 @@
  */
 class AISignList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AISignList"; }
 	AISignList();
 };

src/ai/api/ai_station.hpp

@@ -22,6 +22,7 @@
  */
 class AIStation : public AIBaseStation {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIStation"; }
 
 	/**

src/ai/api/ai_stationlist.hpp

@@ -21,6 +21,7 @@
  */
 class AIStationList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIStationList"; }
 
 	/**
@@ -35,6 +36,7 @@ public:
  */
 class AIStationList_Vehicle : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIStationList_Vehicle"; }
 
 	/**

src/ai/api/ai_subsidy.hpp

@@ -20,6 +20,7 @@
  */
 class AISubsidy : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AISubsidy"; }
 
 	/**

src/ai/api/ai_subsidylist.hpp

@@ -20,6 +20,7 @@
  */
 class AISubsidyList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AISubsidyList"; }
 	AISubsidyList();
 };

src/ai/api/ai_testmode.hpp

@@ -25,6 +25,7 @@
  */
 class AITestMode : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITestMode"; }
 
 private:

src/ai/api/ai_tile.hpp

@@ -21,6 +21,7 @@
  */
 class AITile : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITile"; }
 
 	/**

src/ai/api/ai_tilelist.hpp

@@ -21,6 +21,7 @@
  */
 class AITileList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITileList"; }
 
 	/**
@@ -63,6 +64,7 @@ public:
  */
 class AITileList_IndustryAccepting : public AITileList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITileList_IndustryAccepting"; }
 
 	/**
@@ -81,6 +83,7 @@ public:
  */
 class AITileList_IndustryProducing : public AITileList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITileList_IndustryProducing"; }
 
 	/**
@@ -99,6 +102,7 @@ public:
  */
 class AITileList_StationType : public AITileList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITileList_StationType"; }
 
 	/**

src/ai/api/ai_town.hpp

@@ -20,6 +20,7 @@
  */
 class AITown : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITown"; }
 
 	/**

src/ai/api/ai_townlist.hpp

@@ -20,6 +20,7 @@
  */
 class AITownList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITownList"; }
 	AITownList();
 };

src/ai/api/ai_tunnel.hpp

@@ -20,6 +20,7 @@
  */
 class AITunnel : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AITunnel"; }
 
 	/**

src/ai/api/ai_vehicle.hpp

@@ -22,6 +22,7 @@
  */
 class AIVehicle : public AIObject {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicle"; }
 
 	/**

src/ai/api/ai_vehiclelist.hpp

@@ -21,6 +21,7 @@
  */
 class AIVehicleList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList"; }
 	AIVehicleList();
 };
@@ -31,6 +32,7 @@ public:
  */
 class AIVehicleList_Station : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList_Station"; }
 
 	/**
@@ -50,6 +52,7 @@ public:
  */
 class AIVehicleList_Depot : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList_Depot"; }
 
 	/**
@@ -64,6 +67,7 @@ public:
  */
 class AIVehicleList_SharedOrders : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList_SharedOrders"; }
 
 	/**
@@ -78,6 +82,7 @@ public:
  */
 class AIVehicleList_Group : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList_Group"; }
 
 	/**
@@ -92,6 +97,7 @@ public:
  */
 class AIVehicleList_DefaultGroup : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIVehicleList_DefaultGroup"; }
 
 	/**

src/ai/api/ai_waypoint.hpp

@@ -21,6 +21,7 @@
  */
 class AIWaypoint : public AIBaseStation {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIWaypoint"; }
 
 	/**

src/ai/api/ai_waypointlist.hpp

@@ -21,6 +21,7 @@
  */
 class AIWaypointList : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIWaypointList"; }
 
 	/**
@@ -35,6 +36,7 @@ public:
  */
 class AIWaypointList_Vehicle : public AIAbstractList {
 public:
+	/** Get the name of this class to identify it towards squirrel. */
 	static const char *GetClassName() { return "AIWaypointList_Vehicle"; }
 
 	/**