Skip to content

Commit 109128e

Browse files
max-rosinpmai
authored andcommitted
fix(docs): Review documentation changes (#467)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com> Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent 66369fd commit 109128e

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

osi_detectedobject.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,8 @@ message DetectedMovingObject
159159
//
160160
// \note The bounding box does NOT includes mirrors for vehicles.
161161
// \note The parent frame of \c base is the sensor's vehicle frame.
162-
// \note The height includes the ground_clearance, so always goes from top to ground.
162+
// \note The height includes the ground_clearance. It always goes from the
163+
// top to the ground.
163164
//
164165
optional BaseMoving base = 2;
165166

osi_object.proto

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,8 @@ message MovingObject
292292
// The base parameters of the vehicle.
293293
//
294294
// \note The bounding box does NOT include side mirrors for vehicles.
295-
// \note The height includes the ground_clearance, so always goes from top to ground.
295+
// \note The height includes the ground_clearance. It always goes from the
296+
// top to the ground.
296297
//
297298
optional BaseMoving base = 2;
298299

@@ -443,11 +444,11 @@ message MovingObject
443444
//
444445
optional Vector3d bbcenter_to_front = 5;
445446

446-
// Static minimal distance or space from the lowest point of the vehicle,
447-
// under neutral load conditions (i.e. disregarding driving dynamic
448-
// effects or road surface effects), to the surface plane below it.
449-
// Can be useful to approximate the clearance area under a vehicle
450-
// that a sensor can see through.
447+
// Static minimal distance or space from the lowest point of the vehicle
448+
// to the surface plane below it under neutral load conditions. This
449+
// distance disregards, for example, driving-dynamic effects or
450+
// road-surface effects. Can be useful to approximate the clearance area
451+
// under a vehicle that a sensor can see through.
451452
// \note \c ground_clearance is included in the bounding box height.
452453
//
453454
optional double ground_clearance = 6;

0 commit comments

Comments
 (0)