Skip to content

Commit db152c4

Browse files
committed
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 <thomas.tb.bleher@bmw.de>
1 parent 4317ac8 commit db152c4

3 files changed

Lines changed: 31 additions & 31 deletions

File tree

osi_common.proto

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ message Vector2d
6767
//
6868
message Timestamp
6969
{
70-
// The number of seconds since the start of e.g. the simulation / system /
70+
// The number of seconds since the start of e.g.\ the simulation / system /
7171
// vehicle.
7272
//
7373
// Unit: s
@@ -93,7 +93,7 @@ message Timestamp
9393
}
9494

9595
//
96-
// \brief The dimension of a 3D box, e.g. the size of a 3D bounding box or its
96+
// \brief The dimension of a 3D box, e.g.\ the size of a 3D bounding box or its
9797
// uncertainties.
9898
//
9999
// \image html OSI_Dimension3D.svg
@@ -458,14 +458,14 @@ message BoundingBox
458458
//
459459
TYPE_OTHER = 1;
460460

461-
// The main structure of an object, e.g. a chassis of a vehicle,
461+
// The main structure of an object, e.g.\ a chassis of a vehicle,
462462
// or the central structure of a building, a tree trunk, etc.
463463
//
464464
TYPE_BASE_STRUCTURE = 2;
465465

466-
// A protruding, integral part of an object, which is not
467-
// temporarily attached, e.g. a tree crown, a light pole arm, or a
468-
// parking house gate. The protruding structure is meant to be an
466+
// A protruding, integral part of an object, which is not
467+
// temporarily attached, e.g.\ a tree crown, a light pole arm, or a
468+
// parking house gate. The protruding structure is meant to be an
469469
// additional part to a base structure.
470470
//
471471
TYPE_PROTRUDING_STRUCTURE = 3;
@@ -503,7 +503,7 @@ message BoundingBox
503503
//
504504
message BaseStationary
505505
{
506-
// The 3D dimensions of the stationary object (bounding box), e.g. a
506+
// The 3D dimensions of the stationary object (bounding box), e.g.\ a
507507
// landmark.
508508
//
509509
// \note The \c #dimension must completely enclose the geometry of the
@@ -516,7 +516,7 @@ message BaseStationary
516516
//
517517
optional Vector3d position = 2;
518518

519-
// The relative orientation of the stationary object w.r.t. its parent
519+
// The relative orientation of the stationary object w.r.t.\ its parent
520520
// frame, noted in the parent frame. The orientation becomes global/absolute
521521
// if the parent frame is inertial (all parent frames up to ground truth).
522522
//
@@ -600,7 +600,7 @@ message BaseMoving
600600
//
601601
optional Vector3d position = 2;
602602

603-
// The relative orientation of the moving object w.r.t. its parent frame,
603+
// The relative orientation of the moving object w.r.t.\ its parent frame,
604604
// noted in the parent frame. The orientation becomes global/absolute if
605605
// the parent frame is inertial (all parent frames up to ground truth).
606606
//
@@ -614,7 +614,7 @@ message BaseMoving
614614
//
615615
optional Orientation3d orientation = 3;
616616

617-
// The relative velocity of the moving object w.r.t. the parent frame,
617+
// The relative velocity of the moving object w.r.t.\ the parent frame,
618618
// noted in the parent frame. The velocity becomes global/absolute if
619619
// the parent frame does is inertial (all parent frames up to ground truth).
620620
//
@@ -623,7 +623,7 @@ message BaseMoving
623623
//
624624
optional Vector3d velocity = 4;
625625

626-
// The relative acceleration of the moving object w.r.t. its parent frame,
626+
// The relative acceleration of the moving object w.r.t.\ its parent frame,
627627
// noted in the parent frame. The acceleration becomes global/absolute if
628628
// the parent frame is inertial (all parent frames up to ground truth).
629629
//
@@ -635,7 +635,7 @@ message BaseMoving
635635
//
636636
optional Vector3d acceleration = 5;
637637

638-
// The relative orientation rate of the moving object w.r.t. its parent
638+
// The relative orientation rate of the moving object w.r.t.\ its parent
639639
// frame and parent orientation rate in the center point of the bounding box
640640
// (origin of the bounding box frame), noted in the parent frame.
641641
// The orientation becomes global/absolute if the parent frame is inertial
@@ -652,7 +652,7 @@ message BaseMoving
652652
//
653653
optional Orientation3d orientation_rate = 6;
654654

655-
// The relative orientation acceleration of the moving object w.r.t. its
655+
// The relative orientation acceleration of the moving object w.r.t.\ its
656656
// parent frame and parent orientation acceleration in the center point of
657657
// the bounding box (origin of the bounding box frame), noted in the parent
658658
// frame. The orientation becomes global/absolute if the parent frame is

osi_detectedobject.proto

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ message DetectedItemHeader
9292
}
9393

9494
//
95-
// \brief A stationary object (e.g. landmark) in the environment as detected by
95+
// \brief A stationary object (e.g.\ landmark) in the environment as detected by
9696
// the sensor.
9797
//
9898
// \image html OSI_DetectedStationaryObject.svg
@@ -120,7 +120,7 @@ message DetectedStationaryObject
120120
optional BaseStationary base = 2;
121121

122122
// The root mean squared error of the base parameters of the detected
123-
// stationary object (e.g. landmark). \c StationaryObject::base has to be
123+
// stationary object (e.g.\ landmark). \c StationaryObject::base has to be
124124
// identical for all \c #candidate stationary objects.
125125
//
126126
optional BaseStationary base_rmse = 3;
@@ -181,7 +181,7 @@ message DetectedStationaryObject
181181
//
182182
optional double probability = 1;
183183

184-
// The classification of the stationary object (e.g. landmark).
184+
// The classification of the stationary object (e.g.\ landmark).
185185
//
186186
optional StationaryObject.Classification classification = 2;
187187
}
@@ -218,7 +218,7 @@ message DetectedMovingObject
218218
optional BaseMoving base = 2;
219219

220220
// The root mean squared error of the base parameters of the detected
221-
// moving object (e.g. car). \c MovingObject::base has to be
221+
// moving object (e.g.\ car). \c MovingObject::base has to be
222222
// identical for all \c #candidate moving objects.
223223
//
224224
optional BaseMoving base_rmse = 3;
@@ -233,7 +233,7 @@ message DetectedMovingObject
233233
//
234234
optional ReferencePoint reference_point = 4;
235235

236-
// Actual movement state w.r.t. the moving object history.
236+
// Actual movement state w.r.t.\ the moving object history.
237237
//
238238
optional MovementState movement_state = 5;
239239

@@ -266,7 +266,7 @@ message DetectedMovingObject
266266
optional double percentage_side_lane_right = 7;
267267

268268
// A list of candidates for this moving object as estimated by the
269-
// sensor (e.g. pedestrian, car).
269+
// sensor (e.g.\ pedestrian, car).
270270
//
271271
repeated CandidateMovingObject candidate = 8;
272272

@@ -321,7 +321,7 @@ message DetectedMovingObject
321321
//
322322
optional double probability = 1;
323323

324-
// The description of the moving object (e.g. car).
324+
// The description of the moving object (e.g.\ car).
325325
//
326326
optional MovingObject.Type type = 2;
327327

osi_lane.proto

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,9 @@ message Lane
258258
optional bool centerline_is_driving_direction = 4;
259259

260260
// List of IDs of all lane segments that are directly adjacent to the
261-
// lane on the left side (w.r.t. ascending order of centerline points
262-
// and lane boundary points). Note that lengths of lane segments are
263-
// not synchronized and therefore there are multiple adjacent segments
261+
// lane on the left side (w.r.t.\ ascending order of centerline points
262+
// and lane boundary points). Note that lengths of lane segments are
263+
// not synchronized and therefore there are multiple adjacent segments
264264
// if there is a split/merge point in the adjacent lane.
265265
//
266266
// Example: The lane l3 is the only left adjacent lane for lane l4
@@ -278,9 +278,9 @@ message Lane
278278
repeated Identifier left_adjacent_lane_id = 5;
279279

280280
// List of IDs of all lane segments that are directly adjacent to the
281-
// lane on the right side (w.r.t. ascending order of centerline points
282-
// and lane boundary points). Note that lengths of lane segments are
283-
// not synchronized and therefore there are multiple adjacent segments
281+
// lane on the right side (w.r.t.\ ascending order of centerline points
282+
// and lane boundary points). Note that lengths of lane segments are
283+
// not synchronized and therefore there are multiple adjacent segments
284284
// if there is a split/merge point in the adjacent lane.
285285
//
286286
// Example: \c #right_adjacent_lane_id = (l5, l6)
@@ -379,12 +379,12 @@ message Lane
379379
//
380380
repeated Identifier free_lane_boundary_id = 10;
381381

382-
// The condition of the lane, e.g. influenced by weather.
382+
// The condition of the lane, e.g.\ influenced by weather.
383383
//
384384
optional RoadCondition road_condition = 11;
385385

386-
// The subtype of the lane.
387-
//
386+
// The subtype of the lane.
387+
//
388388
// This subtype specifies a lane more concretely.
389389
//
390390
optional Subtype subtype = 12;
@@ -1030,11 +1030,11 @@ message LaneBoundary
10301030
//
10311031
TYPE_CURB = 12;
10321032

1033-
// A structure (e.g. building or tunnel wall).
1033+
// A structure (e.g.\ building or tunnel wall).
10341034
//
10351035
TYPE_STRUCTURE = 13;
10361036

1037-
// A barrier to guide vehicles and to prevent them from entering other lanes (e.g. a concrete barrier on a highway).
1037+
// A barrier to guide vehicles and to prevent them from entering other lanes (e.g.\ a concrete barrier on a highway).
10381038
//
10391039
TYPE_BARRIER = 14;
10401040

0 commit comments

Comments
 (0)