Add more enums docs

Signed-off-by: Martin Stump <martin.stump@mercedes-benz.com>

include/MantleAPI/Common/route_definition.h

@@ -22,13 +22,14 @@
 
 namespace mantle_api
 {
-/// Defines how a route should be calculated
+
+/// Define how a route should be calculated.
 enum class RouteStrategy : int
 {
-  kUndefined = 0,
-  kFastest,
-  kLeastIntersections,
-  kShortest
+  kUndefined = 0,       ///< The route calculation is undefined.
+  kFastest,             ///< The fastest route is calculated, which is the one that takes the least amount of time.
+  kLeastIntersections,  ///< The route with the least intersections is calculated.
+  kShortest             ///< The shortest route is calculated, which is the one that covers the least amount of distance.
 };
 
 /// Groups a Waypoint with a RouteStrategy
@@ -46,4 +47,5 @@ struct RouteDefinition
 };
 
 }  // namespace mantle_api
+
 #endif  // MANTLEAPI_COMMON_ROUTE_DEFINITION_H

include/MantleAPI/EnvironmentalConditions/weather.h

@@ -24,7 +24,7 @@ namespace mantle_api
 enum class Precipitation : int
 {
   kUnknown = 0,  ///< The amount of precipitation is unknown.
-  kOther,        ///< The amount of precipitation is known but unspecified.
+  kOther,        ///< The amount of precipitation is known, but unspecified.
   kNone,         ///< There is no precipitation.
   kVeryLight,    ///< There is very light precipitation.
   kLight,        ///< There is light precipitation.
@@ -38,7 +38,7 @@ enum class Precipitation : int
 enum class Fog : int
 {
   kUnknown = 0,          ///< The amount of fog is unknown.
-  kOther,                ///< The amount of fog is known but unspecified.
+  kOther,                ///< The amount of fog is known, but unspecified.
   kExcellentVisibility,  ///< Visibility is excellent. There is no fog.
   kGoodVisibility,       ///< Visibility is good. There is light fog.
   kModerateVisibility,   ///< Visibility is moderate. There is thick fog.
@@ -49,19 +49,20 @@ enum class Fog : int
   kDense                 ///< Visibility is poor. There is dense fog.
 };
 
+/// Specify the level of illumination.
 enum class Illumination : int
 {
-  kUnknown = 0,
-  kOther,
-  kLevel1,
-  kLevel2,
-  kLevel3,
-  kLevel4,
-  kLevel5,
-  kLevel6,
-  kLevel7,
-  kLevel8,
-  kLevel9
+  kUnknown = 0,  ///< The level of illumination is unknown.
+  kOther,        ///< The level of illumination is known, but unspecified.
+  kLevel1,       ///< The level of illumination is 1.
+  kLevel2,       ///< The level of illumination is 2.
+  kLevel3,       ///< The level of illumination is 3.
+  kLevel4,       ///< The level of illumination is 4.
+  kLevel5,       ///< The level of illumination is 5.
+  kLevel6,       ///< The level of illumination is 6.
+  kLevel7,       ///< The level of illumination is 7.
+  kLevel8,       ///< The level of illumination is 8.
+  kLevel9        ///< The level of illumination is 9.
 };
 
 struct Weather

include/MantleAPI/Map/i_lane_location_query_service.h

@@ -27,10 +27,12 @@
 
 namespace mantle_api
 {
+
+/// Specifiy the direction of the lane relative to the reference pose.
 enum class Direction : int
 {
-  kForward = 0,
-  kBackwards
+  kForward = 0,  ///< The lane has the same direction as the reference pose.
+  kBackwards     ///< The lane has the opposite direction of the reference pose.
 };
 
 enum class LateralDisplacementDirection : int

include/MantleAPI/Traffic/entity_properties.h

@@ -28,12 +28,12 @@ namespace mantle_api
 /// Specify the type of an entity.
 enum class EntityType : int
 {
-  kUnknown = 0,  ///< The type of entity is unknown.
-  kOther,        ///< The type of entity is known, but unspecified.
-  kVehicle,      ///< Object is a vehicle.
-  kPedestrian,   ///< Object is a pedestrian.
-  kAnimal,       ///< Object is an animal.
-  kStatic        ///< Object is static and does not move.
+  kUnknown = 0,  ///< The type of the entity is unknown.
+  kOther,        ///< The type of the entity is known, but unspecified.
+  kVehicle,      ///< The entity is a vehicle.
+  kPedestrian,   ///< The entity is a pedestrian.
+  kAnimal,       ///< The entity is an animal.
+  kStatic        ///< The entity is static and does not move.
 };
 
 /// Basic properties that describe scenario entities.
@@ -56,42 +56,43 @@ inline bool operator==(const EntityProperties& lhs, const EntityProperties& rhs)
 /// Specify the class of a vehicle.
 enum class VehicleClass : int
 {
-  kUnknown = 0,      ///< The type of vehicle is unknown.
-  kOther = 1,        ///< The type of vehicle is known, but unspecified.
-  kSmallCar = 2,     ///< Vehicle is a small car. Definition: Hatchback car with maximum length 4 m.
-  kCompactCar = 3,   ///< Vehicle is a compact car. Definition: Hatchback car with length between 4 and 4.5 m.
-  kMediumCar = 4,    ///< Vehicle is a medium car. Definition: Hatchback or sedan with length between 4.5 and 5 m.
-  kLuxuryCar = 5,    ///< Vehicle is a luxury car. Definition: Sedan or coupe that is longer then 5 m.
-  kDeliveryVan = 6,  ///< Vehicle is a delivery van.
-  kHeavyTruck = 7,   ///< Vehicle is a heavy truck.
-  kSemiTrailer = 8,  ///< Vehicle is a truck with semi-trailer.
-  kTrailer = 9,      ///< Vehicle is a trailer (possibly attached to another vehicle).
-  kMotorcycle = 10,  ///< Vehicle is a motorcycle or moped.
-  kBicycle = 11,     ///< Vehicle is a bicycle (without motor and specific lights).
-  kBus = 12,         ///< Vehicle is a bus.
-  kTram = 13,        ///< Vehicle is a tram.
-  kTrain = 14,       ///< Vehicle is a train.
-  kWheelchair = 15,  ///< Vehicle is a wheelchair.
-  kInvalid = -1      ///< Vehicle type is not specified properly.
+  kUnknown = 0,      ///< The type of the vehicle is unknown.
+  kOther = 1,        ///< The type of the vehicle is known, but unspecified.
+  kSmallCar = 2,     ///< The vehicle is a small car. Definition: Hatchback car with maximum length 4 m.
+  kCompactCar = 3,   ///< The vehicle is a compact car. Definition: Hatchback car with length between 4 and 4.5 m.
+  kMediumCar = 4,    ///< The vehicle is a medium car. Definition: Hatchback or sedan with length between 4.5 and 5 m.
+  kLuxuryCar = 5,    ///< The vehicle is a luxury car. Definition: Sedan or coupe that is longer then 5 m.
+  kDeliveryVan = 6,  ///< The vehicle is a delivery van.
+  kHeavyTruck = 7,   ///< The vehicle is a heavy truck.
+  kSemiTrailer = 8,  ///< The vehicle is a truck with semi-trailer.
+  kTrailer = 9,      ///< The vehicle is a trailer. The trailer may be attached to another vehicle.
+  kMotorcycle = 10,  ///< The vehicle is a motorcycle or moped.
+  kBicycle = 11,     ///< The vehicle is a bicycle (without motor and specific lights).
+  kBus = 12,         ///< The vehicle is a bus.
+  kTram = 13,        ///< The vehicle is a tram.
+  kTrain = 14,       ///< The vehicle is a train.
+  kWheelchair = 15,  ///< The vehicle is a wheelchair.
+  kInvalid = -1      ///< The type of the vehicle is not specified properly.
 };
 
 /// Specify the state of the indicators of a vehicle.
 enum class IndicatorState : int
 {
-  kUnknown = 0,  ///< The state of the indicators is unknown (must not be used in ground truth).
+  kUnknown = 0,  ///< The state of the indicators is unknown. This state must not be used in ground truth.
   kOther,        ///< The state of the indicators is known, but unspecified.
-  kOff,          ///< Indicators are off.
-  kLeft,         ///< Left indicator is on.
-  kRight,        ///< Right indicator is on.
-  kWarning       ///< Hazard/warning light, i.e. both indicators, are on.
+  kOff,          ///< The indicators are off.
+  kLeft,         ///< The left indicator is on.
+  kRight,        ///< The right indicator is on.
+  kWarning       ///< The hazard/warning light, i.e. both indicators, are on.
 };
 
+/// Specify external control of a vehicle.
 enum class ExternalControlState : int
 {
-  kOff = 0,
-  kFull,
-  kLateralOnly,
-  kLongitudinalOnly
+  kOff = 0,          ///< The vehicle is not controlled externally at all.
+  kFull,             ///< The vehicle is controlled externally in full.
+  kLateralOnly,      ///< Only lateral control is external.
+  kLongitudinalOnly  ///< Only longitudinal control is external.
 };
 
 struct Performance

include/MantleAPI/Traffic/traffic_light_properties.h

@@ -42,7 +42,7 @@ enum class TrafficLightBulbMode : int
   kOff,          ///< The traffic light bulb is off.
   kConstant,     ///< The traffic light bulb is constantly glowing.
   kFlashing,     ///< The traffic light bulb is flashing.
-  kCounting      ///< The traffic light bulb is counting, cf. pedestrian traffic lights in the US.
+  kCounting      ///< The traffic light bulb is counting, i.e. pedestrian traffic lights in the US.
 };
 
 struct TrafficLightBulbState