docs: Correct errors and inconsistencies in climate control section
authorMatthew Vick <mvick@jaguarlandrover.com>
Thu, 3 Dec 2015 22:30:49 +0000 (14:30 -0800)
committerMatthew Vick <mvick@jaguarlandrover.com>
Thu, 3 Dec 2015 23:20:15 +0000 (15:20 -0800)
Resolve an error in the climate control documentation related to the fan
speed level and resolve a few trivial inconsistencies nearby.

Signed-off-by: Matthew Vick <mvick@jaguarlandrover.com>
docs/amb.in.fidl

index 398a33d..34574df 100644 (file)
@@ -635,7 +635,7 @@ interface org.automotive.ClimateControl extends VehiclePropertyType  {
   attribute AirflowDirectionType AirflowDirection
 
   /*!  FanSpeedLevel
-  *   \brief MUST return seat heater status: on (true) / off (false).
+  *   \brief MUST return the speed of the fan ( 0: off, 1: lowest speed, 7: highest speed )
   */
   attribute UInt8 FanSpeedLevel
 
@@ -665,12 +665,12 @@ interface org.automotive.ClimateControl extends VehiclePropertyType  {
   attribute UInt8 SeatCooler
 
   /*!  AirRecirculation
-  *   \brief MUST return current setting of air recirculation: on (true) or pulling in outside air (false).
+  *   \brief MUST return current setting of air recirculation: on (true) or pulling in outside air (false)
   */
   attribute Boolean AirRecirculation
 
   /*!  SteeringWheelHeater
-  *   \brief MUST return current status of steering wheel heater ( 0: off, 1: least warm, 10: warmest ).
+  *   \brief MUST return current status of steering wheel heater ( 0: off, 1: least warm, 10: warmest )
   */
   attribute UInt8 SteeringWheelHeater
 }