Doxygen fixes

doc/_config.adoc

@@ -37,7 +37,7 @@ ifndef::include-only-once[]
 :doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/
 // Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved.
 // We create a variable for every repo that is included. It point to the repo in question.
-// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef.
+// If the subrepo is rendered separately, then the variable is set to just "./images" with ifdef.
 // Please note that this variable has to used in all image includes. Includes here have to use "image::./images..."
 // :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images  // example
 :imagesoutdir: ./images/generated_images

doxygen_config.cmake.in

@@ -14,7 +14,7 @@ RECURSIVE              = YES
 
 # There is no standard configuration for .proto files documentation.
 # A Doxygen filter for .proto files has to be added under the directory doc/.
-# proto2cpp.py is an external script. See README.md for more informations.
+# proto2cpp.py is an external script. See README.md for more information.
 JAVADOC_AUTOBRIEF      = YES
 REPEAT_BRIEF           = YES
 ALWAYS_DETAILED_SEC    = YES

osi_common.proto

@@ -67,7 +67,7 @@ message Vector2d
 //
 message Timestamp
 {
-    // The number of seconds since the start of e.g. the simulation / system /
+    // The number of seconds since the start of e.g.\ the simulation / system /
     // vehicle.
     //
     // Unit: s
@@ -93,7 +93,7 @@ message Timestamp
 }
 
 //
-// \brief The dimension of a 3D box, e.g. the size of a 3D bounding box or its
+// \brief The dimension of a 3D box, e.g.\ the size of a 3D bounding box or its
 // uncertainties.
 //
 // \image html OSI_Dimension3D.svg
@@ -458,14 +458,14 @@ message BoundingBox
         //
         TYPE_OTHER = 1;
 
-        // The main structure of an object, e.g. a chassis of a vehicle, 
+        // The main structure of an object, e.g.\ a chassis of a vehicle,
         // or the central structure of a building, a tree trunk, etc.
         //
         TYPE_BASE_STRUCTURE = 2;
 
-        // A protruding, integral part of an object, which is not 
-        // temporarily attached, e.g. a tree crown, a light pole arm, or a 
-        // parking house gate. The protruding structure is meant to be an 
+        // A protruding, integral part of an object, which is not
+        // temporarily attached, e.g.\ a tree crown, a light pole arm, or a
+        // parking house gate. The protruding structure is meant to be an
         // additional part to a base structure.
         //
         TYPE_PROTRUDING_STRUCTURE = 3;
@@ -503,7 +503,7 @@ message BoundingBox
 //
 message BaseStationary
 {
-    // The 3D dimensions of the stationary object (bounding box), e.g. a
+    // The 3D dimensions of the stationary object (bounding box), e.g.\ a
     // landmark.
     //
     // \note The \c #dimension must completely enclose the geometry of the
@@ -516,7 +516,7 @@ message BaseStationary
     //
     optional Vector3d position = 2;
 
-    // The relative orientation of the stationary object w.r.t. its parent
+    // The relative orientation of the stationary object w.r.t.\ its parent
     // frame, noted in the parent frame. The orientation becomes global/absolute
     // if the parent frame is inertial (all parent frames up to ground truth).
     //
@@ -600,7 +600,7 @@ message BaseMoving
     //
     optional Vector3d position = 2;
 
-    // The relative orientation of the moving object w.r.t. its parent frame,
+    // The relative orientation of the moving object w.r.t.\ its parent frame,
     // noted in the parent frame. The orientation becomes global/absolute if
     // the parent frame is inertial (all parent frames up to ground truth).
     //
@@ -614,7 +614,7 @@ message BaseMoving
     //
     optional Orientation3d orientation = 3;
 
-    // The relative velocity of the moving object w.r.t. the parent frame,
+    // The relative velocity of the moving object w.r.t.\ the parent frame,
     // noted in the parent frame. The velocity becomes global/absolute if
     // the parent frame does is inertial (all parent frames up to ground truth).
     //
@@ -623,7 +623,7 @@ message BaseMoving
     //
     optional Vector3d velocity = 4;
 
-    // The relative acceleration of the moving object w.r.t. its parent frame,
+    // The relative acceleration of the moving object w.r.t.\ its parent frame,
     // noted in the parent frame. The acceleration becomes global/absolute if
     // the parent frame is inertial (all parent frames up to ground truth).
     //
@@ -635,7 +635,7 @@ message BaseMoving
     //
     optional Vector3d acceleration = 5;
 
-    // The relative orientation rate of the moving object w.r.t. its parent
+    // The relative orientation rate of the moving object w.r.t.\ its parent
     // frame and parent orientation rate in the center point of the bounding box
     // (origin of the bounding box frame), noted in the parent frame.
     // The orientation becomes global/absolute if the parent frame is inertial
@@ -652,7 +652,7 @@ message BaseMoving
     //
     optional Orientation3d orientation_rate = 6;
 
-    // The relative orientation acceleration of the moving object w.r.t. its
+    // The relative orientation acceleration of the moving object w.r.t.\ its
     // parent frame and parent orientation acceleration in the center point of
     // the bounding box (origin of the bounding box frame), noted in the parent
     // frame. The orientation becomes global/absolute if the parent frame is

osi_detectedlane.proto

@@ -57,7 +57,7 @@ message DetectedLane
 // The parent frame of a detected lane boundary is the virtual sensor coordinate
 // system.
 //
-// /note The virtual sensor coordinate system is relative to the vehicle coordinate
+// \note The virtual sensor coordinate system is relative to the vehicle coordinate
 // system which has its origin in the center of the rear axle of the ego
 // vehicle. This means if virtual sensor mounting position and orientation are
 // set to (0,0,0) the virtual sensor coordinate system coincides with the

osi_detectedobject.proto

@@ -92,15 +92,15 @@ message DetectedItemHeader
 }
 
 //
-// \brief A stationary object (e.g. landmark) in the environment as detected by
+// \brief A stationary object (e.g.\ landmark) in the environment as detected by
 // the sensor.
 //
 // \image html OSI_DetectedStationaryObject.svg
 //
 // The parent frame of a detected stationary object is the virtual sensor
 // coordinate system.
 //
-// /note The virtual sensor coordinate system is relative to the vehicle coordinate
+// \note The virtual sensor coordinate system is relative to the vehicle coordinate
 // system which has its origin in the center of the rear axle of the ego
 // vehicle. This means if virtual sensor mounting position and orientation are
 // set to (0,0,0) the virtual sensor coordinate system coincides with the
@@ -120,7 +120,7 @@ message DetectedStationaryObject
     optional BaseStationary base = 2;
 
     // The root mean squared error of the base parameters of the detected
-    // stationary object (e.g. landmark). \c StationaryObject::base has to be
+    // stationary object (e.g.\ landmark). \c StationaryObject::base has to be
     // identical for all \c #candidate stationary objects.
     //
     optional BaseStationary base_rmse = 3;
@@ -181,7 +181,7 @@ message DetectedStationaryObject
         //
         optional double probability = 1;
 
-        // The classification of the stationary object (e.g. landmark).
+        // The classification of the stationary object (e.g.\ landmark).
         //
         optional StationaryObject.Classification classification = 2;
     }
@@ -194,7 +194,7 @@ message DetectedStationaryObject
 // The parent frame of a detected moving object is the virtual sensor coordinate
 // system.
 //
-// /note The virtual sensor coordinate system is relative to the vehicle coordinate
+// \note The virtual sensor coordinate system is relative to the vehicle coordinate
 // system which has its origin in the center of the rear axle of the ego
 // vehicle. This means if virtual sensor mounting position and orientation are
 // set to (0,0,0) the virtual sensor coordinate system coincides with the
@@ -218,7 +218,7 @@ message DetectedMovingObject
     optional BaseMoving base = 2;
 
     // The root mean squared error of the base parameters of the detected
-    // moving object (e.g. car). \c MovingObject::base has to be
+    // moving object (e.g.\ car). \c MovingObject::base has to be
     // identical for all \c #candidate moving objects.
     //
     optional BaseMoving base_rmse = 3;
@@ -233,7 +233,7 @@ message DetectedMovingObject
     //
     optional ReferencePoint reference_point = 4;
 
-    // Actual movement state w.r.t. the moving object history.
+    // Actual movement state w.r.t.\ the moving object history.
     //
     optional MovementState movement_state = 5;
 
@@ -266,7 +266,7 @@ message DetectedMovingObject
     optional double percentage_side_lane_right = 7;
 
     // A list of candidates for this moving object as estimated by the
-    // sensor (e.g. pedestrian, car).
+    // sensor (e.g.\ pedestrian, car).
     //
     repeated CandidateMovingObject candidate = 8;
 
@@ -321,7 +321,7 @@ message DetectedMovingObject
         //
         optional double probability = 1;
 
-        // The description of the moving object (e.g. car).
+        // The description of the moving object (e.g.\ car).
         //
         optional MovingObject.Type type = 2;
 

osi_detectedroadmarking.proto

@@ -23,7 +23,7 @@ package osi3;
 // The parent frame of a detected road marking is the virtual sensor coordinate
 // system.
 //
-// /note The virtual sensor coordinate system is relative to the vehicle coordinate
+// \note The virtual sensor coordinate system is relative to the vehicle coordinate
 // system which has its origin in the center of the rear axle of the ego
 // vehicle. This means if virtual sensor mounting position and orientation are
 // set to (0,0,0) the virtual sensor coordinate system coincides with the

osi_detectedtrafficlight.proto

@@ -20,7 +20,7 @@ package osi3;
 // The parent frame of a detected traffic light is the virtual sensor coordinate
 // system.
 //
-// /note The virtual sensor coordinate system is relative to the vehicle coordinate
+// \note The virtual sensor coordinate system is relative to the vehicle coordinate
 // system which has its origin in the center of the rear axle of the ego
 // vehicle. This means if virtual sensor mounting position and orientation are
 // set to (0,0,0) the virtual sensor coordinate system coincides with the

osi_hostvehicledata.proto

@@ -133,7 +133,7 @@ message HostVehicleData
             OPERATING_STATE_SLEEP = 2;
 
             // Cabin lights and entertainment are off. The vehicle can not be driven.
-            // Some ECUs are still operating and not in their minimum electrical sate.
+            // Some ECUs are still operating and not in their minimum electrical state.
             // Usually the driver has left (and closed) the vehicle recently.
             //
             OPERATING_STATE_STANDBY = 3;

osi_lane.proto

@@ -258,9 +258,9 @@ message Lane
         optional bool centerline_is_driving_direction = 4;
 
         // List of IDs of all lane segments that are directly adjacent to the
-        // lane on the left side (w.r.t. ascending order of centerline points
-        // and lane boundary points). Note that lengths of lane segments are 
-        // not synchronized and therefore there are multiple adjacent segments 
+        // lane on the left side (w.r.t.\ ascending order of centerline points
+        // and lane boundary points). Note that lengths of lane segments are
+        // not synchronized and therefore there are multiple adjacent segments
         // if there is a split/merge point in the adjacent lane.
         //
         // Example: The lane l3 is the only left adjacent lane for lane l4
@@ -278,9 +278,9 @@ message Lane
         repeated Identifier left_adjacent_lane_id = 5;
 
         // List of IDs of all lane segments that are directly adjacent to the
-        // lane on the right side (w.r.t. ascending order of centerline points
-        // and lane boundary points). Note that lengths of lane segments are 
-        // not synchronized and therefore there are multiple adjacent segments 
+        // lane on the right side (w.r.t.\ ascending order of centerline points
+        // and lane boundary points). Note that lengths of lane segments are
+        // not synchronized and therefore there are multiple adjacent segments
         // if there is a split/merge point in the adjacent lane.
         //
         // Example: \c #right_adjacent_lane_id = (l5, l6)
@@ -379,12 +379,12 @@ message Lane
         //
         repeated Identifier free_lane_boundary_id = 10;
 
-        // The condition of the lane, e.g. influenced by weather.
+        // The condition of the lane, e.g.\ influenced by weather.
         //
         optional RoadCondition road_condition = 11;
 
-        // The subtype of the lane. 
-        // 
+        // The subtype of the lane.
+        //
         // This subtype specifies a lane more concretely.
         //
         optional Subtype subtype = 12;
@@ -1030,11 +1030,11 @@ message LaneBoundary
             //
             TYPE_CURB = 12;
 
-            // A structure (e.g. building or tunnel wall).
+            // A structure (e.g.\ building or tunnel wall).
             //
             TYPE_STRUCTURE = 13;
 
-            // A barrier to guide vehicles and to prevent them from entering other lanes (e.g. a concrete barrier on a highway).
+            // A barrier to guide vehicles and to prevent them from entering other lanes (e.g.\ a concrete barrier on a highway).
             //
             TYPE_BARRIER = 14;
 

osi_logicaldetectiondata.proto

@@ -35,7 +35,7 @@ message LogicalDetectionData
     // The parent frame of a logical detection is the virtual sensor coordinate
     // system specified by \c SensorView::mounting_position .
     //
-    // /note The virtual sensor coordinate system is relative to the vehicle
+    // \note The virtual sensor coordinate system is relative to the vehicle
     // coordinate system which has its origin in the center of the rear axle of
     // the ego vehicle. This means if virtual sensor mounting position and
     // orientation are set to (0,0,0) the virtual sensor coordinate system

osi_trafficsign.proto

@@ -5646,7 +5646,7 @@ message TrafficSign
             // directions use \c #TYPE_ARROW. Supplementary signs constraint to
             // one type of actors use \c #TYPE_CONSTRAINED_TO. Supplementary
             // signs that will exclude one type of actors use \c #TYPE_EXCEPT.
-            // If supplementary signs combine contraints, restrictions, or plain
+            // If supplementary signs combine constraints, restrictions, or plain
             // text, \c Type is used in descending order in the following
             // sequence: \c #TYPE_EXCEPT, \c #TYPE_CONSTRAINED_TO, \c
             // #TYPE_ARROW, \c #TYPE_TIME, \c #TYPE_SPACE, \c #TYPE_TEXT.
@@ -6640,7 +6640,6 @@ message TrafficSign
                 // Noise protection with time limit.
                 // <br>
                 // See [\c Noise protection](\ref NOISE_PROTECTION_TEXT).
-                // </tt>
                 // </td>
                 // </tr>
                 // <tr>

tests/test_invalid_enum.py

@@ -71,7 +71,7 @@ def test_correct_enum_name(self):
                                 + "'",
                             )
 
-                            # Test to check ENUM type is in captial letters/upper case.
+                            # Test to check ENUM type is in capital letters/upper case.
                             self.assertEqual(
                                 checkName,
                                 checkName.upper(),