Skip to content

Commit bde32cc

Browse files
committed
Regularize doxygen comments, fix typos
1 parent 2d08aa5 commit bde32cc

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

osi_detectedlandmark.proto

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,22 @@ message DetectedTrafficSign
1515
{
1616
// Specific ID of the traffic sign as assigned by the sensor internally.
1717
// Need not match with ground_truth_id.
18+
//
1819
optional Identifier tracking_id = 2;
1920

2021
// The ID of the original traffic sign in the ground truth.
2122
// In case of a ghost sign (no corresponding ground truth), this field
2223
// should be unset.
24+
//
2325
optional Identifier ground_truth_id = 3;
2426

2527
// A list of candidates for this traffic sign as estimated by the sensor.
2628
//
2729
repeated CandidateSign candidate_sign = 4;
2830

2931
// A list of candidates for (a) possible supplementary sign(s) as estimated
30-
// by the sensor.
32+
// by the sensor.
33+
//
3134
repeated CandidateSupplementarySign candidate_supplementary_sign = 5;
3235

3336
// The detected geometry of the traffic sign.
@@ -39,6 +42,7 @@ message DetectedTrafficSign
3942
//
4043
// \note Use as confidence measure where a low value means less confidence
4144
// and a high value indicates strong confidence.
45+
//
4246
optional double existence_probability = 7;
4347

4448
// The measurement state.
@@ -47,6 +51,7 @@ message DetectedTrafficSign
4751

4852
// The root mean squared error of the base parameters of the detected
4953
// traffic sign.
54+
//
5055
optional BaseStationary rmse = 9;
5156

5257
// Links to the corresponding lanes.
@@ -61,6 +66,7 @@ message DetectedTrafficSign
6166
// \note This information can be determined via the detected entities'
6267
// detections ( \c ...Detection::object_id = 'this detected entity' ) and
6368
// the sensors (their IDs) to which these detections belong.
69+
//
6470
repeated Identifier sensor_id = 11;
6571

6672
// Definition of traffic sign geometries.
@@ -69,6 +75,7 @@ message DetectedTrafficSign
6975
{
7076
// Geometry of the traffic sign is unknown (must not be used in ground
7177
// truth).
78+
//
7279
GEOMETRY_UNKNOWN = 0;
7380

7481
// Geometry of the traffic sign is unspecified (but known).
@@ -109,14 +116,17 @@ message DetectedTrafficSign
109116

110117
// Traffic sign has a rectangle geometry. (width is bigger than height)
111118
// E.g. one-way
119+
//
112120
GEOMETRY_RECTANGLE = 10;
113121

114122
// Traffic sign that has a pole geometry. (height is bigger than width)
115123
// E.g. pole indicating highways exit in xx m.
124+
//
116125
GEOMETRY_POLE = 11;
117126

118127
// Traffic sign that has an oversize rectangle geometry.
119128
// E.g. direction plates on highway or city signs.
129+
//
120130
GEOMETRY_PLATE = 12;
121131
}
122132
}
@@ -129,10 +139,12 @@ message CandidateSign
129139
// The definition of the candidate's properties.
130140
// The sign.id values of all \c CandidateSign within one
131141
// \c DetectedTrafficSign correspond to the tracking ID and must be identical.
142+
//
132143
optional TrafficSign sign = 1;
133144

134145
// The estimated probability that this candidate is the true value.
135146
// Range [0,1]. The sum of all candidate_probabilities must be one.
147+
//
136148
optional double candidate_probability = 2;
137149

138150
// The amount of time that this detected object has been currently
@@ -149,10 +161,12 @@ message CandidateSupplementarySign
149161
{
150162
// The definition of one of more supplementary signs that together define
151163
// this candidate.
164+
//
152165
repeated SupplementarySign sign = 1;
153166

154167
// The estimated probability that this candidate is the true value.
155168
// Range [0,1]. The sum of all candidate_probabilities must be one.
169+
//
156170
optional double candidate_probability = 2;
157171

158172
// The amount of time that this detected object has been currently
@@ -169,11 +183,13 @@ message DetectedTrafficLight
169183
{
170184
// Specific ID of the traffic light as assigned by the sensor internally.
171185
// Need not match with ground_truth_id.
186+
//
172187
optional Identifier tracking_id = 2;
173188

174189
// The ID of the original traffic light in the ground truth.
175190
// In case of a ghost detection (no corresponding ground truth), this field
176191
// should be unset.
192+
//
177193
optional Identifier ground_truth_id = 3;
178194

179195
// Description of the detected traffic light.
@@ -193,6 +209,7 @@ message DetectedTrafficLight
193209
//
194210
// \note Use as confidence measure where a low value means less confidence
195211
// and a high value indicates strong confidence.
212+
//
196213
optional double existence_probability = 7;
197214

198215
// The measurement state.
@@ -201,6 +218,7 @@ message DetectedTrafficLight
201218

202219
// The root mean squared error of the base parameters of the detected
203220
// traffic light.
221+
//
204222
optional BaseStationary rmse = 9;
205223

206224
// A list of sensors which detected this detected entity.
@@ -211,6 +229,7 @@ message DetectedTrafficLight
211229
// \note This information can be determined via the detected entities'
212230
// detections ( \c ...Detection::object_id = 'this detected entity' ) and
213231
// the sensors (their IDs) to which these detections belong.
232+
//
214233
repeated Identifier sensor_id = 10;
215234

216235
//
@@ -233,15 +252,19 @@ message DetectedTrafficLight
233252
// Direction is unknown (must not be used in ground truth).
234253
//
235254
DIRECTION_UNKNOWN = 0;
255+
236256
// Other (unspecified but known) direction.
237257
//
238258
DIRECTION_OTHER = 1;
259+
239260
// Direction is straight.
240261
//
241262
DIRECTION_STRAIGHT = 2;
263+
242264
// Direction is left.
243265
//
244266
DIRECTION_LEFT = 3;
267+
245268
// Direction is right.
246269
//
247270
DIRECTION_RIGHT = 4;
@@ -270,11 +293,13 @@ message DetectedRoadMarking
270293
{
271294
// Specific ID of the road marking as assigned by the sensor internally.
272295
// Need not match with ground_truth_id.
296+
//
273297
optional Identifier tracking_id = 2;
274298

275299
// The ID of the original road marking in the ground truth.
276300
// In case of a ghost detection (no corresponding ground truth), this field
277301
// should be unset.
302+
//
278303
optional Identifier ground_truth_id = 3;
279304

280305
// A list of candidates for this road marking as estimated by the sensor.
@@ -286,6 +311,7 @@ message DetectedRoadMarking
286311
//
287312
// \note Use as confidence measure where a low value means less confidence
288313
// and a high value indicates strong confidence.
314+
//
289315
optional double existence_probability = 5;
290316

291317
// Links to the corresponding lanes.
@@ -298,6 +324,7 @@ message DetectedRoadMarking
298324

299325
// The root mean squared error of the base parameters of the detected road
300326
// marking.
327+
//
301328
optional BaseStationary rmse = 8;
302329

303330
// A list of sensors which detected this detected entity.
@@ -308,6 +335,7 @@ message DetectedRoadMarking
308335
// \note This information can be determined via the detected entities'
309336
// detections ( \c ...Detection::object_id = 'this detected entity' ) and
310337
// the sensors (their IDs) to which these detections belong.
338+
//
311339
repeated Identifier sensor_id = 11;
312340
}
313341

@@ -322,6 +350,7 @@ message CandidateRoadMarking
322350

323351
// The estimated probability that this candidate is the true value.
324352
// Range [0,1]. The sum of all candidate_probabilities must be one.
353+
//
325354
optional double candidate_probability = 2;
326355

327356
// The amount of time that this detected object has been currently

osi_sensordata.proto

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ message SensorData
2828
{
2929
// The ID of the sensor at host vehicle's mounting_position.
3030
//
31-
// This ID can equal \c DetectionHeader::sensor_id, if SensorData hold only
31+
// This ID can equal \c DetectionHeader::sensor_id, if SensorData holds only
3232
// data from one sensor/sensor model.
33+
//
3334
optional Identifier sensor_id = 1;
3435

3536
// The timestamp of the sensor data. Zero time is arbitrary but must be
@@ -56,6 +57,7 @@ message SensorData
5657
// For a sensor model that does not know its own internal latencies (e.g.
5758
// a dumb sensor with no internal time concept), the two timestamps might
5859
// also be identical, but delayed from the GroundTruth timestamp.
60+
//
5961
optional Timestamp timestamp = 2;
6062

6163
// Ground truth w.r.t. global coordinate system
@@ -185,6 +187,7 @@ message SensorData
185187
// Host vehicle data is data that the host vehicle knows about itself,
186188
// e.g. from location sensors, internal sensors and ECU bus data, etc.,
187189
// that is made available to sensors as input.
190+
//
188191
optional HostVehicleData host_vehicle_data_id = 18;
189192
}
190193

@@ -199,6 +202,7 @@ message DetectedEntityHeader
199202
//
200203
// \note See SensorData::timestamp and SensorData::last_measurement_time
201204
// for detailed discussions on the semantics of time-related fields.
205+
//
202206
optional Timestamp measurement_time = 1;
203207

204208
// Continuous up counter to identify the cycle.
@@ -207,6 +211,7 @@ message DetectedEntityHeader
207211

208212
// Data Qualifier expresses to what extent the content of this event can be
209213
// relied on.
214+
//
210215
optional DataQualifier data_qualifier = 3;
211216

212217
//

0 commit comments

Comments
 (0)