Typos in Documentation

Typos removed.
Add plural s for repeated message fields
Add \c in documentation.

Author: carsten-kuebler

osi_common.proto

@@ -194,7 +194,7 @@ message MountingPosition
 // 
 // Azimuth and elevation are defined as the rotations that would have to be 
 // applied to the local frame (e.g sensor frame definition in 
-// \c DetectionHeader) to make its x-axis point towards the referenced point
+// \c SensorDetectionHeader) to make its x-axis point towards the referenced point
 // or to align it with the referenced vector. The rotations are to be performed
 // \b azimuth \b first (around the z-axis) and \b elevation \b second (around 
 // the new y-axis) to follow the definition of \c Orientation3D. For the

osi_datarecording.proto

@@ -7,33 +7,36 @@ import "osi_sensordata.proto";
 package osi;
 
 //
-// \brief (Time) Series of SensorData messages that may be used for data recording or internal buffering by some sensor models.
+// \brief (Time) Series of SensorData messages that may be used for data
+// recording or internal buffering by some sensor models.
 //
 message SensorDataSeries
 {
     // List of sensor data messages for subsequent timesteps.
     //
-    repeated SensorData sensor_data = 1;
+    repeated SensorData sensor_data_list = 1;
 }
 
 //
-// \brief List of SensorData interface copies, one for each sensor in the vehicle.
-// 
+// \brief List of SensorData interface copies, one for each sensor in the
+//  vehicle.
+//
 // Can be used to bundle output of multiple sensors in one transmission.
 //
 message SensorDataList
 {
     // List of sensor data for multiple sensors at a specific timestep.
     //
-    repeated SensorData sensor = 1;
+    repeated SensorData sensors = 1;
 }
 
 //
-// \brief List of sensors where each element contains a time series of SensorData messages.
+// \brief List of sensors where each element contains a time series of
+// SensorData messages.
 //
 message SensorDataSeriesList
 {
     // List of sensor data for multiple sensors at subsequent timesteps.
     //
-    repeated SensorDataSeries sensor = 1;
+    repeated SensorDataSeries sensors = 1;
 }

osi_featuredata.proto

@@ -11,7 +11,7 @@ package osi;
 // object hypothesis and tracking.
 //
 // All information regarding the environment is given with respect to the sensor 
-// coordinate system specified in \c DetectionHeader::mounting_position. 
+// coordinate system specified in \c SensorDetectionHeader::mounting_position. 
 // When simulating multiple sensors, each sensor has an individual copy of 
 // \c FeatureData in its own reference frame. This allows an independent 
 // treatment of the sensors.
@@ -32,7 +32,7 @@ message FeatureData
 //
 message SensorDetectionHeader
 {
-    // Version number of used detection list messages ( \c DetectionHeader, 
+    // Version number of used detection list messages ( \c SensorDetectionHeader, 
     // \c LidarDetection, \c LidarDetectionList etc.).
     // 
     optional DetectionInterfaceVersion version = 1;
@@ -41,13 +41,14 @@ message SensorDetectionHeader
     // was processed or at which it is transmitted) in the global synchronized
     // time.
     //
-    // \note See SensorData::timestamp and SensorData::last_measurement_time
-    // for detailed discussions on the semantics of time-related fields.
+    // \note See \c SensorData::timestamp and
+    // \c SensorData::last_measurement_time for detailed discussions on the 
+    // semantics of time-related fields.
     optional Timestamp measurement_time = 2;
 
     // Monotonous counter to identify the exact cycle. 
     // Generally the detection function is called periodic and 
-    // \c DetectionHeader::cycle_counter corresponds to the number of periods.
+    // \c SensorDetectionHeader::cycle_counter corresponds to the number of periods.
     optional uint64 cycle_counter = 3;
 
 
@@ -126,7 +127,7 @@ message SensorDetectionHeader
     }
 
     //
-    // \brief Version of detection messages ( \c DetectionHeader, 
+    // \brief Version of detection messages ( \c SensorDetectionHeader, 
     // \c LidarDetection, \c LidarDetectionList etc.).
     //
     message DetectionInterfaceVersion

osi_sensordata.proto

@@ -15,12 +15,14 @@ import "osi_hostvehicledata.proto";
 package osi;
 
 //
-// \brief The virtual sensor information derived from GroundTruth and potentially processed by sensor-models.
+// \brief The virtual sensor information derived from \c GroundTruth and 
+// potentially processed by sensor-models.
 //
-// The virtual sensor information is supposed to imitate the output of a real sensor. All information regarding the
-// environment is given with respect to the sensor coordinate system specified in \c SensorData::mounting_position. 
-// When simulating multiple sensors, each sensor has an individual copy of the SensorData interface. This allows an
-// independent treatment of the sensors.
+// The virtual sensor information is supposed to imitate the output of a real 
+// sensor. All information regarding the environment is given with respect to 
+// the sensor coordinate system specified in \c SensorData::mounting_position. 
+// When simulating multiple sensors, each sensor has an individual copy of the 
+// \c SensorData interface. This allows an independent treatment of the sensors.
 //
 message SensorData
 {  
@@ -43,7 +45,7 @@ message SensorData
     // The time that the actual measurement was performed (which will usually
     // correspond with the timestamp of the GroundTruth the sensor model
     // processed to arrive at these results) can be found in the additional
-    // field SensorData::last_measurement_time.
+    // field \c SensorData::last_measurement_time.
     //
     // For an ideal zero latency sensor the two timestamps would be the same
     // and would correspond with the timestamp from the current GroundTruth
@@ -100,9 +102,9 @@ message SensorData
     // The timestamp of the last real-world measurement (e.g. GT input) that
     // this set of sensor data takes into account.  This in effect is the last
     // time instance of reality the measurements correspond to.  See field
-    // SensorData::timestamp for a detailed discussion.  This value is also
-    // the upper bound to the DetectedObjectHeader::measurement_time and the
-    // feature data DetectionHeader::measurement_time fields.
+    // \c SensorData::timestamp for a detailed discussion.  This value is also
+    // the upper bound to the \c DetectedObjectHeader::measurement_time and the
+    // feature data \c SensorDetectionHeader::measurement_time fields.
     // 
     optional Timestamp last_measurement_time = 8;
 

osi_sensorview.proto

@@ -21,7 +21,7 @@ message SensorView
 
     // The data timestamp of the simulation environment. Zero time is arbitrary
     // but must be identical for all messages. Zero time does not need to
-    // coincide with the unix epoch. Recommended is the starting time point of
+    // coincide with the UNIX epoch. Recommended is the starting time point of
     // the simulation.
     //
     // \note For sensor view data this timestamp coincides both with the
@@ -51,8 +51,8 @@ message SensorView
 // \brief Radar Sensor View
 //
 // Radar-Specific Sensor View Data
-message RadarSensorView {
-    
+message RadarSensorView 
+{
     // Radar Input Configuration valid at the time the data was created
     //
     optional RadarSensorInputConfiguration radar_sensor_input_configuration = 1;
@@ -62,45 +62,51 @@ message RadarSensorView {
     // This field includes one entry for each ray, in left-to-right,
     // top-to-bottom order (think scan lines in a TV).
     //
-    repeated Reflection reflection = 2;
+    repeated Reflection reflections = 2;
 
     //
     // \brief The radar reflection.
     //    
-    message Reflection {
+    message Reflection 
+    {
         // Relative signal level of the reflection
         //
         // This takes the combined_antenna_diagram (losses in TX and RX)
         // as well as the signal losses due to scattering and absorption
         // into account, and will, when multiplied by TX power yield the
         // actual RX power.
+        //
         // Unit: [dB]
         optional double signal_strength = 1;
 
         // Time of flight
         //
         // This is the time of flight of the reflection, which is directly
-        // proportional to the distance travelled. 
+        // proportional to the distance traveled. 
+        //
         // Unit: [s]
         optional double time_of_flight = 2;
 
         // Doppler shift
         //
         // Shift in frequency based on the specified TX frequency
+        //
         // Unit: [Hz]
         optional double doppler_shift = 3;
 
         // TX horizontal angle (azimuth)
         //
         // Horizontal angle of incidence of the source of the reflection
         // at the TX antenna.
+        //
         // Unit: [rad]
         optional double source_horizontal_angle = 4;
 
         // TX vertical angle (elevation)
         //
         // Vertical angle of incidence of the source of the reflection
         // at the TX antenna.
+        //
         // Unit: [rad]
         optional double source_vertical_angle = 5;
     }
@@ -110,8 +116,8 @@ message RadarSensorView {
 // \brief Lidar Sensor View
 //
 // Lidar-Specific Sensor View Data
-message LidarSensorView {
-
+message LidarSensorView 
+{
     // Lidar Input Configuration valid at the time the data was created
     //
     optional LidarSensorInputConfiguration lidar_sensor_input_configuration = 1;
@@ -126,26 +132,30 @@ message LidarSensorView {
     //
     // \brief The lidar reflection.
     //
-    message Reflection {
+    message Reflection 
+    {
         // Relative signal level of the reflection
         //
         // This takes the combined_antenna_diagram (losses in TX and RX)
         // as well as the signal losses due to scattering and absorption
         // into account, and will, when multiplied by TX power yield the
         // actual RX power.
+        //
         // Unit: [dB]
         optional double signal_strength = 1;
 
         // Time of flight
         //
         // This is the time of flight of the reflection, which is directly
-        // proportional to the distance travelled. 
+        // proportional to the distance traveled. 
+        //
         // Unit: [s]
         optional double time_of_flight = 2;
 
         // Doppler shift
         //
         // Shift in frequency based on the specified TX frequency
+        //
         // Unit: [Hz]
         optional double doppler_shift = 3;
     }
@@ -155,7 +165,8 @@ message LidarSensorView {
 // \brief Camera Sensor View
 //
 // Camera-Specific Sensor View Data
-message CameraSensorView {
+message CameraSensorView 
+{
 
     // Camera Input Configuration valid at the time the data was created
     //
@@ -173,7 +184,8 @@ message CameraSensorView {
 // \brief Ultrasonic Sensor View
 //
 // Ultrasonic-Specific Sensor View Data
-message UltrasonicSensorView {
+message UltrasonicSensorView 
+{
 
     // Ultrasonic Input Configuration valid at the time the data was created
     //