Doc: added code highlighting to specification

Stefan Cyliax · Stefan Cyliax · commit 5d042af53aa4 · 2021-10-20T15:18:16.000+02:00
Signed-off-by: Stefan Cyliax &lt;stefan.cyliax@asam.net&gt;
diff --git a/doc/misc/example.adoc b/doc/misc/example.adoc
@@ -3,7 +3,7 @@
 The following example shows the content of a `modelDescription.xml` file that satisfies OSMP requirements.
 The example describes a sensor model FMU with one input, one output, and no additional features:
 
-[source,xml]
+[source,xml,linenums]
 ----
 <?xml version="1.0" encoding="UTF-8"?>
 <fmiModelDescription
diff --git a/doc/setup/build_install_example.adoc b/doc/setup/build_install_example.adoc
@@ -21,56 +21,48 @@ Demonstrates a simple C network proxy that can send and receive OSI data via TCP
 
 . Clone the OSMP repository.
 +
-[source]
 ----
 git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git
 ----
 +
 . Switch to the OSMP repository.
 +
-[source]
 ----
 cd osi-sensor-model-packaging
 ----
 +
 . Update and initialize the OSI submodule.
 +
-[source]
 ----
 git submodule update --init
 ----
 +
 . Switch to the `examples/` directory.
 +
-[source]
 ----
 cd examples
 ----
 +
 . Create a new directory called `build/`.
 +
-[source]
 ----
 mkdir -p build
 ----
 +
 . Switch to the `build/` directory.
 +
-[source]
 ----
 cd build
 ----
 +
 . Run _cmake_ in the parent directory.
 +
-[source]
 ----
 cmake ..
 ----
 +
 . Run _cmake_ build.
 +
-[source]
 ----
 cmake --build .
 ----
diff --git a/doc/spec/ground_truth_init_parameters.adoc b/doc/spec/ground_truth_init_parameters.adoc
@@ -13,7 +13,7 @@ This allows a model to do expensive map calculations only once during initializa
 
 Ground truth initialization paramters shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPGroundTruthInit
 ----
diff --git a/doc/spec/sensor_data_inputs.adoc b/doc/spec/sensor_data_inputs.adoc
@@ -4,7 +4,7 @@
 
 Sensor data inputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorDataIn
 ----
diff --git a/doc/spec/sensor_data_outputs.adoc b/doc/spec/sensor_data_outputs.adoc
@@ -4,7 +4,7 @@
 
 Sensor data outputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorDataOut
 ----
diff --git a/doc/spec/sensor_view_input_configuration.adoc b/doc/spec/sensor_view_input_configuration.adoc
@@ -10,14 +10,14 @@ Before exiting initialization mode, the simulation environment then sets this co
 
 Sensor view input configurations shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorViewInConfig
 ----
 
 Sensor view input configuration requests shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorViewInConfigRequest
 ----
diff --git a/doc/spec/sensor_view_inputs.adoc b/doc/spec/sensor_view_inputs.adoc
@@ -4,7 +4,7 @@
 
 Sensor view inputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorViewIn
 ----
diff --git a/doc/spec/sensor_view_outputs.adoc b/doc/spec/sensor_view_outputs.adoc
@@ -4,7 +4,7 @@
 
 Sensor view outputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
 OSMPSensorViewOut
 ----
diff --git a/doc/spec/traffic_command_inputs.adoc b/doc/spec/traffic_command_inputs.adoc
@@ -7,9 +7,9 @@ This makes it possible to control the traffic participant behavior using scenari
 
 Traffic command inputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
-`OSMPTrafficCommandIn`
+OSMPTrafficCommandIn
 ----
 
 **Rules**
diff --git a/doc/spec/traffic_update_outputs.adoc b/doc/spec/traffic_update_outputs.adoc
@@ -6,9 +6,9 @@ Traffic update outputs are present in traffic participant models.
 
 Traffic update outputs shall be named with the following prefix:
 
-[source]
+[source,protobuf]
 ----
-`OSMPTrafficUpdateOut`
+OSMPTrafficUpdateOut
 ----
 
 **Rules**

Original file line number	Diff line number	Diff line change
`@@ -21,56 +21,48 @@ Demonstrates a simple C network proxy that can send and receive OSI data via TCP`
`21`	`21`
`22`	`22`	`. Clone the OSMP repository.`
`23`	`23`	`+`
`24`		`-[source]`
`25`	`24`	`----`
`26`	`25`	`git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git`
`27`	`26`	`----`
`28`	`27`	`+`
`29`	`28`	`. Switch to the OSMP repository.`
`30`	`29`	`+`
`31`		`-[source]`
`32`	`30`	`----`
`33`	`31`	`cd osi-sensor-model-packaging`
`34`	`32`	`----`
`35`	`33`	`+`
`36`	`34`	`. Update and initialize the OSI submodule.`
`37`	`35`	`+`
`38`		`-[source]`
`39`	`36`	`----`
`40`	`37`	`git submodule update --init`
`41`	`38`	`----`
`42`	`39`	`+`
`43`	`40`	. Switch to the `examples/` directory.
`44`	`41`	`+`
`45`		`-[source]`
`46`	`42`	`----`
`47`	`43`	`cd examples`
`48`	`44`	`----`
`49`	`45`	`+`
`50`	`46`	. Create a new directory called `build/`.
`51`	`47`	`+`
`52`		`-[source]`
`53`	`48`	`----`
`54`	`49`	`mkdir -p build`
`55`	`50`	`----`
`56`	`51`	`+`
`57`	`52`	. Switch to the `build/` directory.
`58`	`53`	`+`
`59`		`-[source]`
`60`	`54`	`----`
`61`	`55`	`cd build`
`62`	`56`	`----`
`63`	`57`	`+`
`64`	`58`	`. Run _cmake_ in the parent directory.`
`65`	`59`	`+`
`66`		`-[source]`
`67`	`60`	`----`
`68`	`61`	`cmake ..`
`69`	`62`	`----`
`70`	`63`	`+`
`71`	`64`	`. Run _cmake_ build.`
`72`	`65`	`+`
`73`		`-[source]`
`74`	`66`	`----`
`75`	`67`	`cmake --build .`
`76`	`68`	`----`