summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/aircraft.h7
-rw-r--r--src/effectvehicle_base.h7
-rw-r--r--src/roadveh.h7
-rw-r--r--src/ship.h7
-rw-r--r--src/train.h7
-rw-r--r--src/vehicle_base.h7
6 files changed, 5 insertions, 37 deletions
diff --git a/src/aircraft.h b/src/aircraft.h
index 090add20d..72343e6c5 100644
--- a/src/aircraft.h
+++ b/src/aircraft.h
@@ -89,12 +89,7 @@ struct AircraftCache {
};
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) Aircraft();
- *
- * As side-effect the vehicle type is set correctly.
+ * Aircraft, helicopters, rotors and their shadows belong to this class.
*/
struct Aircraft : public SpecializedVehicle<Aircraft, VEH_AIRCRAFT> {
AircraftCache acache; ///< Cache of often used calculated values
diff --git a/src/effectvehicle_base.h b/src/effectvehicle_base.h
index dd79370af..5340bdd5d 100644
--- a/src/effectvehicle_base.h
+++ b/src/effectvehicle_base.h
@@ -8,13 +8,6 @@
#include "vehicle_base.h"
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) Train();
- *
- * As side-effect the vehicle type is set correctly.
- *
* A special vehicle is one of the following:
* - smoke
* - electric sparks for trains
diff --git a/src/roadveh.h b/src/roadveh.h
index 1e688e289..f63cf02ee 100644
--- a/src/roadveh.h
+++ b/src/roadveh.h
@@ -116,12 +116,7 @@ struct RoadVehicleCache {
};
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) RoadVehicle();
- *
- * As side-effect the vehicle type is set correctly.
+ * Buses, trucks and trams belong to this class.
*/
struct RoadVehicle : public SpecializedVehicle<RoadVehicle, VEH_ROAD> {
RoadVehicleCache rcache; ///< Cache of often used calculated values
diff --git a/src/ship.h b/src/ship.h
index 99a4f94aa..84bd7af57 100644
--- a/src/ship.h
+++ b/src/ship.h
@@ -15,12 +15,7 @@ void RecalcShipStuff(Vehicle *v);
void GetShipSpriteSize(EngineID engine, uint &width, uint &height);
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) Ship();
- *
- * As side-effect the vehicle type is set correctly.
+ * All ships have this type.
*/
struct Ship: public SpecializedVehicle<Ship, VEH_SHIP> {
TrackBitsByte state;
diff --git a/src/train.h b/src/train.h
index a96ccb3f2..b38139e01 100644
--- a/src/train.h
+++ b/src/train.h
@@ -294,12 +294,7 @@ struct TrainCache {
};
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) Train();
- *
- * As side-effect the vehicle type is set correctly.
+ * 'Train' is either a loco or a wagon.
*/
struct Train : public SpecializedVehicle<Train, VEH_TRAIN> {
TrainCache tcache;
diff --git a/src/vehicle_base.h b/src/vehicle_base.h
index eef514d03..e3659a009 100644
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -553,12 +553,7 @@ struct SpecializedVehicle : public Vehicle {
#define FOR_ALL_VEHICLES_OF_TYPE(name, var) FOR_ALL_ITEMS_FROM(name, vehicle_index, var, 0) if (var->type == name::EXPECTED_TYPE)
/**
- * This class 'wraps' Vehicle; you do not actually instantiate this class.
- * You create a Vehicle using AllocateVehicle, so it is added to the pool
- * and you reinitialize that to a Train using:
- * v = new (v) Train();
- *
- * As side-effect the vehicle type is set correctly.
+ * Disasters, like submarines, skyrangers and their shadows, belong to this class.
*/
struct DisasterVehicle : public SpecializedVehicle<DisasterVehicle, VEH_DISASTER> {
uint16 image_override;