diff options
author | Helmut Schmidt <Helmut.3.Schmidt@continental-corporation.com> | 2017-01-25 16:05:14 +0100 |
---|---|---|
committer | Helmut Schmidt <Helmut.3.Schmidt@continental-corporation.com> | 2017-01-25 16:05:14 +0100 |
commit | 95fd37ec9dd1955f40730d373880502f18795ddb (patch) | |
tree | 5eae5acad42ee49f4d49371119e7f1d458719561 | |
parent | 219b75b3d7c398dfd8c8bedd318de8a8722ca28c (diff) | |
download | positioning-95fd37ec9dd1955f40730d373880502f18795ddb.tar.gz |
SensorService API: fix minor documentation bugs which caused doxygen warnings
-rw-r--r-- | sensors-service/api/acceleration.h | 3 | ||||
-rw-r--r-- | sensors-service/api/gyroscope.h | 3 | ||||
-rw-r--r-- | sensors-service/api/slip-angle.h | 2 | ||||
-rw-r--r-- | sensors-service/api/steering-angle.h | 8 | ||||
-rw-r--r-- | sensors-service/api/vehicle-data.h | 2 |
5 files changed, 10 insertions, 8 deletions
diff --git a/sensors-service/api/acceleration.h b/sensors-service/api/acceleration.h index 35c0a62..7362e43 100644 --- a/sensors-service/api/acceleration.h +++ b/sensors-service/api/acceleration.h @@ -98,6 +98,7 @@ typedef enum { * - first rotate by angleYaw about the Zv axis * - second rotate by anglePitch about the new (intermediate) Y axis * - third rotate by angleRoll about the new X axis + * * Notes * - the angles are frequently called "Euler angles" and the rotations "Euler rotations" * - a different order of the rotations would lead to a different orientation @@ -114,7 +115,7 @@ typedef enum { * if any of the angles (angleYaw, anglePitch, angleRoll) is not zero * then the raw measurement values of the accelerometer X, Y, Z axes may have to be be transformed * to the vehicle axis system by the client of this interface, depending on the type of application. - * Raw measurements are provided in @TAccelerationData instead of already transformed values, because + * Raw measurements are provided in @ref TAccelerationData instead of already transformed values, because * - for accelerometers with less than 3 axes, the transformation is mathematically not well-defined * - some types of calibration operations are better performed on raw data * diff --git a/sensors-service/api/gyroscope.h b/sensors-service/api/gyroscope.h index 20f6e4f..1f56a4e 100644 --- a/sensors-service/api/gyroscope.h +++ b/sensors-service/api/gyroscope.h @@ -89,6 +89,7 @@ typedef enum { * - first rotate by angleYaw about the Zv axis * - second rotate by anglePitch about the new (intermediate) Y axis * - third rotate by angleRoll about the new X axis + * * Notes * - the angles are frequently called "Euler angles" and the rotations "Euler rotations" * - a different order of the rotations would lead to a different orientation @@ -105,7 +106,7 @@ typedef enum { * if any of the angles (angleYaw, anglePitch, angleRoll) is not zero * then the raw measurement values of the gyroscope Z, Y, X axes may have to be be transformed * to the vehicle axis system by the client of this interface, depending on the type of application. - * Raw measurements are provided in @TGyroscopeData instead of already transformed values, because + * Raw measurements are provided in @ref TGyroscopeData instead of already transformed values, because * - for gyroscopes with less than 3 axes, the transformation is mathematically not well-defined * - some types of calibration operations are better performed on raw data * diff --git a/sensors-service/api/slip-angle.h b/sensors-service/api/slip-angle.h index f618572..ab0b85c 100644 --- a/sensors-service/api/slip-angle.h +++ b/sensors-service/api/slip-angle.h @@ -36,7 +36,7 @@ typedef enum { /** * Slip angle sensor service provides the slip angle value. - * @ref ISO 8855:2011, section 5.2.9 "vehicle sideslip angle" + * See ISO 8855:2011, section 5.2.9 "vehicle sideslip angle" * The reference coordinate system for the slip angle is defined in ISO 8855:2011 * * You must check the valid bit(s) before usage. diff --git a/sensors-service/api/steering-angle.h b/sensors-service/api/steering-angle.h index 3025035..9490b24 100644 --- a/sensors-service/api/steering-angle.h +++ b/sensors-service/api/steering-angle.h @@ -46,11 +46,11 @@ typedef struct { uint64_t timestamp; /**< Timestamp of the acquisition of the steering angle signal [ms]. All sensor/GNSS timestamps must be based on the same time source. */ float front; /**< Returns the mean steer angle of the front wheels [degree]. - @ref ISO 8855:2011, section 7.1.3. */ + See ISO 8855:2011, section 7.1.3. */ float rear; /**< Returns the mean steer angle of the rear wheels [degree]. - @ref ISO 8855:2011, section 7.1.3. */ + See ISO 8855:2011, section 7.1.3. */ float steeringWheel; /**< Returns the angle of the steering wheel [degree]. - @ref ISO 8855:2011, section 7.1.8. + See ISO 8855:2011, section 7.1.8. Must be used in combination with the steeringRatio @ref TSteeringAngleConfiguration. */ uint32_t validityBits; /**< Bit mask indicating the validity of each corresponding value. [bitwise or'ed @ref ESteeringAngleValidityBits values]. @@ -64,7 +64,7 @@ typedef struct { float sigmaSteeringAngle; /**< Standard error estimate of the front steer angle in [degree]. -1 if invalid.*/ float sigmaSteeringWheelAngle; /**< Standard error estimate of the steering wheel angle in [degree]. -1 if invalid.*/ float steeringRatio; /**< Ratio between steering wheel angle change and front steer angle change. - @ref ISO 8855:2011, section 7.1.13. + See ISO 8855:2011, section 7.1.13. Only valid when static. 0 if invalid. Unit: [-] */ } TSteeringAngleConfiguration; diff --git a/sensors-service/api/vehicle-data.h b/sensors-service/api/vehicle-data.h index bb4105e..535c619 100644 --- a/sensors-service/api/vehicle-data.h +++ b/sensors-service/api/vehicle-data.h @@ -124,7 +124,7 @@ bool snsVehicleDataDestroy(); /** * Accessing static configuration information about the vehicle. - * @param vehicleData After calling the method the available vehicle configuration data is written into vehicleData. + * @param vehicleDataConfiguration After calling the method the available vehicle configuration data is written into vehicleData. * @return Is true if data can be provided and false otherwise, e.g. missing initialization */ bool snsVehicleDataGetConfiguration(TVehicleDataConfiguration* vehicleDataConfiguration); |