Skip to content

Commit bf83f06

Browse files
authored
Merge pull request #215 from OpenSimulationInterface/documentation/v3.0.1-update6
Small changes
2 parents e96dd6f + b01f984 commit bf83f06

File tree

5 files changed

+12
-17
lines changed

5 files changed

+12
-17
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The version number is defined in InterfaceVersion::version_number in osi_common.
5656
Major:
5757
A change of the major version results in an incompatibility of code and recorded proto messages.
5858
- An existing field with a number changes its meaning
59-
```optional double field = 1;``` -> ```repeated double field = 1;```
59+
`optional double field = 1;` -> `repeated double field = 1;`
6060
Changing the definition of units or interpretation of a field
6161
- Deleting a field and reusing the field number
6262
- Changing the technology
@@ -93,10 +93,7 @@ In order to generate the doxygen documentation for OSI, please follow the follow
9393
2. Download the [proto2cpp](https://github.com/OpenSimulationInterface/proto2cpp) repo.
9494
Copy the content of the repo proto2cpp to your desired `<path-to-proto2cpp.py>`
9595
3. Install [graphviz](https://graphviz.gitlab.io/_pages/Download/Download_windows.html), set an environmental variable 'graphviz' with the path to the binary file and add it to the PATH variable: `PATH += %graphviz%`.
96-
4. From the cmd navigate to the build directory and run:
97-
```cmd
98-
cmake -DFILTER_PROTO2CPP_PY_PATH=<path-to-proto2cpp.py> <path-to-CMakeLists.txt>
99-
```
96+
4. From the cmd navigate to the build directory and run: `cmd cmake -DFILTER_PROTO2CPP_PY_PATH=<path-to-proto2cpp.py> <path-to-CMakeLists.txt>`
10097
5. The build process will then generate the doxygen documentation under the directory doc.
10198

10299

@@ -105,12 +102,10 @@ Citing
105102

106103
Use the following citation for referencing the OSI interface in your scientific work:
107104

108-
```
109-
@misc{osi.2017,
105+
`@misc{osi.2017,
110106
author = {Hanke, Timo and Hirsenkorn, Nils and {van~Driesten}, Carlo and {Garcia~Ramos}, Pilar and Schiementz, Mark and Schneider, Sebastian},
111107
year = {2017},
112108
title = {{Open Simulation Interface: A generic interface for the environment perception of automated driving functions in virtual scenarios.}},
113109
url = {http://www.hot.ei.tum.de/forschung/automotive-veroeffentlichungen/},
114110
note = {{Accessed: 2017-08-28}}
115-
}
116-
```
111+
}`

osi_lane.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ message Lane
3737
optional Classification classification = 2;
3838

3939
//
40-
// \brief Classification of a lane.
40+
// \brief \c Classification of a lane.
4141
//
4242
message Classification
4343
{
@@ -364,7 +364,7 @@ message LaneBoundary
364364
}
365365

366366
//
367-
// \brief Classification data of a lane boundary.
367+
// \brief \c Classification data of a lane boundary.
368368
//
369369
message Classification
370370
{

osi_roadmarking.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ message RoadMarking
4242
//
4343
optional BaseStationary base = 2;
4444

45-
// Classification data for the road marking.
45+
// The classification data for the road marking.
4646
//
4747
optional Classification classification = 3;
4848

4949
//
50-
// \brief Classification data for a road surface marking.
50+
// \brief \c Classification data for a road surface marking.
5151
//
5252
message Classification
5353
{

osi_trafficlight.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ message TrafficLight
2525
//
2626
optional BaseStationary base = 2;
2727

28-
// Classification data for the traffic light.
28+
// The classification data for the traffic light.
2929
//
3030
optional Classification classification = 3;
3131

3232
//
33-
// \brief Classification data for a traffic light.
33+
// \brief \c Classification data for a traffic light.
3434
//
3535
message Classification
3636
{

osi_trafficsign.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ message TrafficSign
174174
optional Classification classification = 2;
175175

176176
//
177-
// \brief Classification data for a traffic sign.
177+
// \brief \c Classification data for a traffic sign.
178178
//
179179
message Classification
180180
{
@@ -936,7 +936,7 @@ message TrafficSign
936936
optional Classification classification = 2;
937937

938938
//
939-
// \brief Classification data for a supplementary traffic sign.
939+
// \brief \c Classification data for a supplementary traffic sign.
940940
//
941941
message Classification
942942
{

0 commit comments

Comments
 (0)