From 806dc543c5f4b4c68b66fc9f008734d697f18257 Mon Sep 17 00:00:00 2001 From: Thomas Bleher Date: Mon, 6 Jul 2026 13:46:06 +0200 Subject: [PATCH 1/4] Fix some spelling errors Signed-off-by: Thomas Bleher --- doc/_config.adoc | 2 +- doc/images/OSI_BaseMoving.svg | 4 ++-- doc/images/OSI_MovingObject.svg | 2 +- doxygen_config.cmake.in | 2 +- osi_hostvehicledata.proto | 2 +- osi_trafficsign.proto | 2 +- tests/test_invalid_enum.py | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/_config.adoc b/doc/_config.adoc index 99470356b..67abb0997 100644 --- a/doc/_config.adoc +++ b/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 diff --git a/doc/images/OSI_BaseMoving.svg b/doc/images/OSI_BaseMoving.svg index d26570c76..f0025a6e7 100644 --- a/doc/images/OSI_BaseMoving.svg +++ b/doc/images/OSI_BaseMoving.svg @@ -412,7 +412,7 @@ Date: Mon, 6 Jul 2026 13:53:10 +0200 Subject: [PATCH 2/4] Fix /note to \note Signed-off-by: Thomas Bleher --- osi_detectedlane.proto | 2 +- osi_detectedobject.proto | 4 ++-- osi_detectedroadmarking.proto | 2 +- osi_detectedtrafficlight.proto | 2 +- osi_logicaldetectiondata.proto | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/osi_detectedlane.proto b/osi_detectedlane.proto index ad3310fd4..f6d59e5f7 100644 --- a/osi_detectedlane.proto +++ b/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 diff --git a/osi_detectedobject.proto b/osi_detectedobject.proto index 238a4af5f..893e07550 100644 --- a/osi_detectedobject.proto +++ b/osi_detectedobject.proto @@ -100,7 +100,7 @@ message DetectedItemHeader // 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 @@ -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 diff --git a/osi_detectedroadmarking.proto b/osi_detectedroadmarking.proto index 3075e8e47..907e3c79d 100644 --- a/osi_detectedroadmarking.proto +++ b/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 diff --git a/osi_detectedtrafficlight.proto b/osi_detectedtrafficlight.proto index b481e5490..80b13fd0a 100644 --- a/osi_detectedtrafficlight.proto +++ b/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 diff --git a/osi_logicaldetectiondata.proto b/osi_logicaldetectiondata.proto index c9b9b7299..cd9187aa1 100644 --- a/osi_logicaldetectiondata.proto +++ b/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 From db152c4831bb5309d6efb613938832021c1311cd Mon Sep 17 00:00:00 2001 From: Thomas Bleher Date: Mon, 6 Jul 2026 15:00:10 +0200 Subject: [PATCH 3/4] Doxygen: Correct wrong autobrief descriptions If \brief is not set, Doxygen will generate a brief description from the first sentence. The sentence stops whenever Doxygen encounters a ". " sequence. This led to strangely cut off sentences in the generated Doxygen documentation. Fix this by escaping the whitespace following a dot in a sentence that should be continued. Signed-off-by: Thomas Bleher --- osi_common.proto | 26 +++++++++++++------------- osi_detectedobject.proto | 14 +++++++------- osi_lane.proto | 22 +++++++++++----------- 3 files changed, 31 insertions(+), 31 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index 493a13c6a..a799b5d48 100644 --- a/osi_common.proto +++ b/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 diff --git a/osi_detectedobject.proto b/osi_detectedobject.proto index 893e07550..007b175e9 100644 --- a/osi_detectedobject.proto +++ b/osi_detectedobject.proto @@ -92,7 +92,7 @@ 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 @@ -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; } @@ -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; diff --git a/osi_lane.proto b/osi_lane.proto index 3f4269764..5cf22f7c1 100644 --- a/osi_lane.proto +++ b/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; From 07956e1df32c73f8bb787e8dd409a478c5983be4 Mon Sep 17 00:00:00 2001 From: Thomas Bleher Date: Mon, 6 Jul 2026 15:00:40 +0200 Subject: [PATCH 4/4] Fix invalid HTML markup Doxygen complained about this. Signed-off-by: Thomas Bleher --- osi_trafficsign.proto | 1 - 1 file changed, 1 deletion(-) diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 7a582070a..4e568e2c9 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -6640,7 +6640,6 @@ message TrafficSign // Noise protection with time limit. //
// See [\c Noise protection](\ref NOISE_PROTECTION_TEXT). - // // // //