summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbelugas <belugas@openttd.org>2007-04-03 16:12:28 +0000
committerbelugas <belugas@openttd.org>2007-04-03 16:12:28 +0000
commit56943ab5849bd4a67819d90bc7f5118ed48d2a22 (patch)
tree58f428589debc35ef0698746db83b8195f98ca7f
parent0d691539a40b6cec330a3adf2718f1fe33f89aab (diff)
downloadopenttd-56943ab5849bd4a67819d90bc7f5118ed48d2a22.tar.xz
(svn r9551) -Documentation: Some more doxygen work
-rw-r--r--src/aircraft.h21
-rw-r--r--src/aircraft_cmd.cpp6
-rw-r--r--src/aircraft_gui.cpp14
3 files changed, 39 insertions, 2 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 */
diff --git a/src/aircraft_cmd.cpp b/src/aircraft_cmd.cpp
index 4c53254f0..9d6310fcd 100644
--- a/src/aircraft_cmd.cpp
+++ b/src/aircraft_cmd.cpp
@@ -2162,6 +2162,10 @@ void UpdateOldAircraft()
}
}
+/**
+ * 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 @@ void UpdateAirplanesOnNewStation(const Station *st)
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;
diff --git a/src/aircraft_gui.cpp b/src/aircraft_gui.cpp
index d5e772600..d0b90e86b 100644
--- a/src/aircraft_gui.cpp
+++ b/src/aircraft_gui.cpp
@@ -36,6 +36,13 @@ void DrawAircraftImage(const Vehicle *v, int x, int y, VehicleID selection)
}
}
+/**
+ * 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 @@ 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)
{
if (success) ShowAircraftViewWindow(GetVehicle(_new_vehicle_id));