diff options
author | belugas <belugas@openttd.org> | 2007-04-03 16:12:28 +0000 |
---|---|---|
committer | belugas <belugas@openttd.org> | 2007-04-03 16:12:28 +0000 |
commit | 56943ab5849bd4a67819d90bc7f5118ed48d2a22 (patch) | |
tree | 58f428589debc35ef0698746db83b8195f98ca7f /src/aircraft.h | |
parent | 0d691539a40b6cec330a3adf2718f1fe33f89aab (diff) | |
download | openttd-56943ab5849bd4a67819d90bc7f5118ed48d2a22.tar.xz |
(svn r9551) -Documentation: Some more doxygen work
Diffstat (limited to 'src/aircraft.h')
-rw-r--r-- | src/aircraft.h | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/src/aircraft.h b/src/aircraft.h index 8c4f93e86..46ccdb211 100644 --- a/src/aircraft.h +++ b/src/aircraft.h @@ -8,7 +8,7 @@ #include "station_map.h" #include "vehicle.h" -/* An aircraft can be one ot those types */ +/** An aircraft can be one ot those types */ enum AircraftSubType { AIR_HELICOPTER = 0, ///< an helicopter AIR_AIRCRAFT = 2, ///< an airplane @@ -73,7 +73,22 @@ static inline bool IsAircraftBuildableAtStation(EngineID engine, TileIndex tile) */ uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi); +/** + * This is the Callback method after the construction attempt of an aircraft + * @param success indicates completion (or not) of the operation + * @param tile of depot where aircraft is built + * @param p1 unused + * @param p2 unused + */ void CcBuildAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2); + +/** + * This is the Callback method after the cloning attempt of an aircraft + * @param success indicates completion (or not) of the operation + * @param tile unused + * @param p1 unused + * @param p2 unused + */ void CcCloneAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2); /** Handle Aircraft specific tasks when a an Aircraft enters a hangar @@ -88,6 +103,10 @@ void HandleAircraftEnterHangar(Vehicle *v); */ void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height); +/** + * Updates the status of the Aircraft heading or in the station + * @param st Station been updated + */ void UpdateAirplanesOnNewStation(const Station *st); #endif /* AIRCRAFT_H */ |