Skip to content

Commit 5108f23

Browse files
thomassedlmayerpmai
authored andcommitted
Fix minor doc formatting issues
Signed-off-by: thomassedlmayer <thomas.sedlmayer@tum.de>
1 parent 76759d7 commit 5108f23

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

osi_environment.proto

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ message EnvironmentalConditions
9090

9191
// Optional external reference to the environmental condition sources.
9292
//
93-
// \note For OpenDRIVE and OpenSECNARIO there is no direct counterpart.
93+
// \note For OpenDRIVE and OpenSCENARIO there is no direct counterpart.
9494
//
9595
// \note For non-ASAM standards, it is implementation-specific how
9696
// source_reference is resolved.
@@ -254,55 +254,55 @@ message EnvironmentalConditions
254254
//
255255
AMBIENT_ILLUMINATION_OTHER = 1;
256256

257-
// Level 1 illumination in ]0.001, 0.01[ lx
257+
// Level 1 illumination in ]0.001, 0.01[ lx. \n
258258
// E.g. Night with no artificial light.
259259
//
260260
// \note Use \c #AMBIENT_ILLUMINATION_LEVEL1 if illumination is less
261-
// than 0.001 lx
261+
// than 0.001 lx.
262262
//
263263
AMBIENT_ILLUMINATION_LEVEL1 = 2;
264264

265-
// Level 2 illumination in [0.01, 1[ lx
265+
// Level 2 illumination in [0.01, 1[ lx. \n
266266
// E.g. Night full moon / Deep twilight.
267267
//
268268
AMBIENT_ILLUMINATION_LEVEL2 = 3;
269269

270-
// Level 3 illumination in [1, 3[ lx
270+
// Level 3 illumination in [1, 3[ lx. \n
271271
// E.g. Deep to average twilight / Minimum lighting on local low
272272
// pedestrian conflict roads.
273273
//
274274
AMBIENT_ILLUMINATION_LEVEL3 = 4;
275275

276-
// Level 4 illumination in [3, 10[ lx
276+
// Level 4 illumination in [3, 10[ lx. \n
277277
// E.g. Average to full twilight / Minimum lighting on collector roads /
278278
// Minimum lighting on major and expressway roads with low to average
279279
// pedestrian conflict.
280280
//
281281
AMBIENT_ILLUMINATION_LEVEL4 = 5;
282282

283-
// Level 5 illumination in [10, 20[ lx
283+
// Level 5 illumination in [10, 20[ lx. \n
284284
// E.g. Minimum lighting on major and expressway roads with high
285285
// pedestrian conflict.
286286
//
287287
AMBIENT_ILLUMINATION_LEVEL5 = 6;
288288

289-
// Level 6 illumination in [20, 400[ lx
289+
// Level 6 illumination in [20, 400[ lx. \n
290290
// E.g. Roads with more lighting / Very dark overcast day to sunrise or
291291
// sunset on a clear day.
292292
//
293293
AMBIENT_ILLUMINATION_LEVEL6 = 7;
294294

295-
// Level 7 illumination in [400, 1000[ lx
295+
// Level 7 illumination in [400, 1000[ lx. \n
296296
// E.g. Sunrise or sunset on a clear day / Overcast day.
297297
//
298298
AMBIENT_ILLUMINATION_LEVEL7 = 8;
299299

300-
// Level 8 illumination in [1000, 10000[ lx
300+
// Level 8 illumination in [1000, 10000[ lx. \n
301301
// E.g. Average to full daylight.
302302
//
303303
AMBIENT_ILLUMINATION_LEVEL8 = 9;
304304

305-
// Level 9 illumination in [10000, 120000[ lx
305+
// Level 9 illumination in [10000, 120000[ lx. \n
306306
// E.g. Full daylight to intense sunlight.
307307
//
308308
// \note Use \c #AMBIENT_ILLUMINATION_LEVEL9 if illumination is more
@@ -348,14 +348,14 @@ message EnvironmentalConditions
348348

349349
// Defines the fractional cloud cover [1] given by observation of total cloud amount in eights (oktas) of the sky.
350350
//
351-
// For visual alignment please see reference[2].
351+
// For visual alignment please see reference [2].
352352
//
353353
// The total degree of coverage indicates how much of the sky is covered with clouds altogether.
354-
// 0 oktas means that there are no traces of clouds in the sky, \c
354+
// 0 oktas means that there are no traces of clouds in the sky,
355355
// 8 oktas means that the sky is completely covered with clouds and no sky blue can be recognized.
356356
//
357357
// \par References:
358-
// [1] CIE engl. International Commission on Illumination. (2020). <em>CIE S017:2020 ILV: Intl. Lighitng Vocabulary, 2nd edn.</em>. Retrieved March 8, 2022, from https://cie.co.at/eilvterm/17-29-116
358+
// [1] CIE engl. International Commission on Illumination. (2020). <em>CIE S017:2020 ILV: Intl. Lighitng Vocabulary, 2nd edn.</em>. Retrieved March 8, 2022, from https://cie.co.at/eilvterm/17-29-116 \n
359359
// [2] UBC The University of British Columbia. (2018). <em>ATSC 113 Weather for Sailing, Flying & Snow Sports</em>. Retrieved March 8, 2022, from https://www.eoas.ubc.ca/courses/atsc113/flying/met_concepts/01-met_concepts/01c-cloud_coverage/index.html
360360
//
361361
enum FractionalCloudCover
@@ -415,9 +415,9 @@ message EnvironmentalConditions
415415
//
416416
message Wind
417417
{
418-
// The origin direction of the wind (not the target direction) in the ground/xy-plane of the \c
419-
// world coordinate system. Corresponds to the heading/yaw angle, counted counterclockwise. \c
420-
// 0 pointing north. If north not explicitly defined via proj4 reference in ground truth, \c
418+
// The origin direction of the wind (not the target direction) in the ground/xy-plane of the
419+
// world coordinate system. Corresponds to the heading/yaw angle, counted counterclockwise.
420+
// 0 pointing north. If north is not explicitly defined via \c #osi3::GroundTruth::proj_string,
421421
// then north is pointing in y-axis direction. The default orientation (x, y, z) is easting, northing, up [1].
422422
//
423423
// \note 0: north; +pi/2: west; pi: south, 3/2 pi: east.
@@ -448,7 +448,7 @@ message EnvironmentalConditions
448448
message Sun
449449
{
450450
// Azimuth of the sun, counted counterclockwise.
451-
// 0 pointing north. If north not explicitly defined via proj4 reference in ground truth, \c
451+
// 0 pointing north. If north is not explicitly defined via \c #osi3::GroundTruth::proj_string,
452452
// then north is pointing in y-axis direction. The default orientation (x, y, z) is easting, northing, up [1].
453453
//
454454
// \note 0: north; +pi/2: west; pi: south, 3/2 pi: east.

0 commit comments

Comments
 (0)