Mercurial > hg > openttd
changeset 6415:c2c9492ad5f1 draft
(svn r9551) -Documentation: Some more doxygen work
| author | belugas <belugas@openttd.org> |
|---|---|
| date | Tue, 03 Apr 2007 16:12:28 +0000 |
| parents | ec1486c86076 |
| children | 0c8df93f48c9 |
| files | src/aircraft.h src/aircraft_cmd.cpp src/aircraft_gui.cpp |
| diffstat | 3 files changed, 39 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- 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 @@ */ 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 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 */
--- a/src/aircraft_cmd.cpp +++ b/src/aircraft_cmd.cpp @@ -2162,6 +2162,10 @@ } } +/** + * Updates the status of the Aircraft heading or in the station + * @param st Station been updated + */ void UpdateAirplanesOnNewStation(const Station *st) { /* only 1 station is updated per function call, so it is enough to get entry_point once */ @@ -2172,7 +2176,7 @@ if (v->type == VEH_AIRCRAFT && IsNormalAircraft(v)) { if (v->u.air.targetairport == st->index) { // if heading to this airport /* update position of airplane. If plane is not flying, landing, or taking off - *you cannot delete airport, so it doesn't matter */ + * you cannot delete airport, so it doesn't matter */ if (v->u.air.state >= FLYING) { // circle around v->u.air.pos = v->u.air.previous_pos = AircraftGetEntryPoint(v, ap); v->u.air.state = FLYING;
--- a/src/aircraft_gui.cpp +++ b/src/aircraft_gui.cpp @@ -36,6 +36,13 @@ } } +/** + * 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) { if (success) { @@ -49,6 +56,13 @@ } } +/** + * 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) { if (success) ShowAircraftViewWindow(GetVehicle(_new_vehicle_id));