(svn r10634) [NoAI] -Documentation: of course I forgot to document the VehicleType enum noai
authortruelight
Thu, 19 Jul 2007 23:10:08 +0000
branchnoai
changeset 9685 d988aad9fc52
parent 9684 623970482fb2
child 9686 d3c195c226f9
(svn r10634) [NoAI] -Documentation: of course I forgot to document the VehicleType enum
src/ai/api/ai_vehicle.hpp
--- a/src/ai/api/ai_vehicle.hpp	Thu Jul 19 23:01:41 2007 +0000
+++ b/src/ai/api/ai_vehicle.hpp	Thu Jul 19 23:10:08 2007 +0000
@@ -13,6 +13,10 @@
  */
 class AIVehicle : public AIObject {
 public:
+	/**
+	 * The type of a vehicle available in the game. Trams for example are
+	 *  road vehicles, as maglev is a rail vehicle.
+	 */
 	enum VehicleType {
 		/* Order IS important, as it now matches the internal state of the game for vehicle type */
 		VEHICLE_RAIL,