Added some corrections to the doxygen comments and the README.md

Author: jdsika

README.md

@@ -3,9 +3,10 @@ Open Simulation Interface (OSI)
 
 [![Travis Build Status](https://travis-ci.org/OpenSimulationInterface/open-simulation-interface.svg?branch=master)](https://travis-ci.org/OpenSimulationInterface/open-simulation-interface)
 
+
 General description
 -------------------
-https://www.hot.ei.tum.de/forschung/automotive-veroeffentlichungen/
+[TUM Department of Electrical and Computer Engineering] (https://www.hot.ei.tum.de/forschung/automotive-veroeffentlichungen/)
 
 
 Global remarks
@@ -38,13 +39,16 @@ Fault injection: how-to
 Injection of pre-defined sensor errors should be handled by a specialized "fault injector" component that acts like a
 sensor model component, i.e. it takes a SensorData message as input and returns a modified SensorData message as output.
 Specific errors should be handled as follows:
-- Ghost objects / false positive: An additional SensorDataObject is added to the list of objects in SensorData.object
-      with SensorDataObject.model_internal_object.ground_truth_type set to kTypeGhost.
-- False negative: The object is marked as not seen by the sensor by setting the property
-      SensorDataObject.model_internal_object.is_seen to false. The implementation of field-of-view calculation modules
-      should respect this flag and never reset an object marked as not-seen to seen.
+- Ghost objects / false positive:
+    An additional SensorDataObject is added to the list of objects in SensorData.object
+	with SensorDataObject.model_internal_object.ground_truth_type set to kTypeGhost.
+- False negative:
+    The object is marked as not seen by the sensor by setting the property 
+	SensorDataObject.model_internal_object.is_seen to false. The implementation 
+	of field-of-view calculation modules should respect this flag and never reset 
+	an object marked as not-seen to seen.
+
 
-	  
 Versioning
 ----------
 The version number is defined in InterfaceVersion::version_number in osi_common.proto as the field's default value.
@@ -70,20 +74,22 @@ The compatibility of both recorded files and code remains.
 - Changing or adding comments
 - Clarification of text passages explaining the message content
 
+
 Packaging
 ---------
 
 A specification to package sensor models using OSI as (extended)
 Functional Mock-up Units (FMUs) for use in simulation environments
 is available [here](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging).
 
+
 Documentation
 -------------
 
 In order to generate the doxygen documentation for OSI, please follow the following steps: 
-1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) and set an environmental variable 'doxygen' with the path to the binary file.
+1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), set an environmental variable 'doxygen' with the path to the binary file and add it to PATH ´<old-path>;%doxygen%´.
 2. Download and unzip the [zip file containing the filter proto2cpp.py](https://sourceforge.net/p/proto2cpp/wiki/Home/ ).
-3. Install [graphviz-2.38](http://www.graphviz.org/Download_windows.php ) and set an environmental variable 'dot' with the path to the binary file.
+3. Install [graphviz-2.38](http://www.graphviz.org/Download_windows.php ), set an environmental variable 'graphviz' with the path to the binary file and add it to PATH ´<old-path>;%graphviz%´.
 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>

osi_common.proto

@@ -4,15 +4,24 @@ option optimize_for = SPEED;
 
 package osi;
 
-
+//
 // \brief The interface version number.
-
+//
+// The field containing the version number. Should be left on default, not to be modified by sender.
+// Increments will happen as part of changes to the whole interface.
+//
 message InterfaceVersion
 {
-    // The field containing the version number. Should be left on default, not to be modified by sender. Increments will
-    // happen as part of changes to the whole interface.
+	// Major version number.
+	//
     optional uint32 major = 1 [default = 2];
+	
+	// Minor version number.
+	//
     optional uint32 minor = 2 [default = 1];
+	
+	// Patch version number.
+	//
     optional uint32 patch = 3 [default = 1];
 }
 
@@ -23,15 +32,15 @@ message InterfaceVersion
 //
 message Vector3d
 {
-    // The x coordinate
+    // The x coordinate.
 	//
     optional double x = 1;
 
-    // The y coordinate
+    // The y coordinate.
 	//
     optional double y = 2;
 
-    // The z coordinate
+    // The z coordinate.
 	//
     optional double z = 3;
 }
@@ -43,11 +52,11 @@ message Vector3d
 //
 message Vector2d
 {
-    // The x coordinate
+    // The x coordinate.
 	//
     optional double x = 1;
 
-    // The y coordinate
+    // The y coordinate.
 	//
     optional double y = 2;
 }
@@ -79,12 +88,12 @@ message Dimension3d
     // The width of the bounding box.
 	//
     optional double width = 1;
-
+	
     // The length of the bounding box.
 	//
     optional double length = 2;
-
-    //The height of the bounding box.
+	
+    // The height of the bounding box.
 	//
     optional double height = 3;
 }
@@ -116,11 +125,11 @@ message Orientation3d
     // The roll angle/rate/acceleration.
 	//
     optional double roll = 1;
-
+	
     // The pitch angle/rate/acceleration.
 	//
     optional double pitch = 2;
-
+	
     // The yaw angle/rate/acceleration.
 	//
     optional double yaw = 3;
@@ -220,7 +229,7 @@ message BaseStationary
 //
 message BaseMoving
 {
-    // The 3D dimension of the object (bounding box):
+    // The 3D dimension of the object (bounding box).
 	//
     optional Dimension3d dimension = 1;
 

osi_detectedlandmark.proto

@@ -48,18 +48,22 @@ message DetectedTrafficSign
 	//	
     enum Geometry
     {
-        // Geometry of the traffic sign is unknown.
+        // Geometry of the traffic sign is unknown (must not be used in ground truth).
 		//	
 		GEOMETRY_UNKNOWN = 0;
+		
         // Geometry of the traffic sign is unspecified (but known).
 		//	
         GEOMETRY_OTHER = 1;
+		
         // Traffic sign has a triangular geometry.
 		//	
         GEOMETRY_TRIANGLE = 2;
+		
         // Traffic sign has a circular geometry.
 		//	
         GEOMETRY_CIRCLE = 3;
+		
         // Traffic sign has a square geometry.
 		//	
         GEOMETRY_SQUARE = 4;
@@ -69,15 +73,18 @@ message DetectedTrafficSign
 	//
     enum MeasurementState
     {
-        // Measurement state is unknown.
+        // Measurement state is unknown (must not be used in ground truth).
 		//
         MEASUREMENT_STATE_UNKNOWN = 0;
+		
         // Measurement state is unspecified (but known, i.e. value is not part of this enum list).
 		//
         MEASUREMENT_STATE_OTHER = 1;
+		
         // Traffic sign has been measured by the sensor in the current timestep.
 		//
         MEASUREMENT_STATE_MEASURED = 2;
+		
         // Traffic sign has not been measured by the sensor in the current timestep. Values provided by tracking only.
 		//
         MEASUREMENT_STATE_PREDICTED = 3;

osi_detectedobject.proto

@@ -74,33 +74,43 @@ message DetectedObject
         // within the bounding volume unknown to the sensor. If this value is set, the center of the bounding box should
         // be used as reference point by convention, unless the specific use case requires otherwise.
         REFERENCE_POINT_UNKNOWN = 0;
+		
         // Other (unspecified but known) reference point.
 		//
         REFERENCE_POINT_OTHER = 1;
+		
         // Center of the bounding box.
 		//
         REFERENCE_POINT_CENTER = 2;
+		
         // Middle-Left of the bounding box.
 		//
         REFERENCE_POINT_MIDDLE_LEFT = 3;
+		
         // Middle-Right of the bounding box.
 		//
         REFERENCE_POINT_MIDDLE_RIGHT = 4;
+		
         // Rear-Middle of the bounding box.
 		//
         REFERENCE_POINT_REAR_MIDDLE = 5;
+		
         // Rear-Left of the bounding box.
 		//
         REFERENCE_POINT_REAR_LEFT = 6;
+		
         // Rear-Right of the bounding box.
 		//
         REFERENCE_POINT_REAR_RIGHT = 7;
+		
         // Front-Middle of the bounding box.
 		//
         REFERENCE_POINT_FRONT_MIDDLE = 8;
+		
         // Front-Left of the bounding box.
 		//
         REFERENCE_POINT_FRONT_LEFT = 9;
+		
         // Front-Right of the bounding box.
 		//
         REFERENCE_POINT_FRONT_RIGHT = 10;
@@ -114,21 +124,27 @@ message DetectedObject
         // Probability that the object has unknown type. Range [0,1].
 		//
         optional double prob_unknown = 1;
+		
         // Probability that the object is a car. Range [0,1].
 		//
         optional double prob_car = 2;
+		
         // Probability that the object is a truck. Range [0,1].
 		//
         optional double prob_truck = 3;
+		
         // Probability that the object is a motorbike. Range [0,1].
 		//
         optional double prob_motorbike = 4;
+		
         // Probability that the object is a bicycle. Range [0,1].
 		//
         optional double prob_bicycle = 5;
+		
         // Probability that the object is a pedestrian. Range [0,1].
 		//
         optional double prob_pedestrian = 6;
+		
         // Probability that the object is a stationary object. Range [0,1].
 		//
         optional double prob_stationary = 7;

osi_environment.proto

@@ -57,18 +57,23 @@ message EnvironmentalConditions
         // Ambient illumination is unknown (must not be used in ground truth).
 		//
         AMBIENT_ILLUMINATION_UNKNOWN = 0;
+		
         // Other (unspecified but known) ambient illumination.
 		//
         AMBIENT_ILLUMINATION_OTHER = 1;
+		
         // Ambient illumination index is "bright".
         // E.g. daytime with sunshine.
         AMBIENT_ILLUMINATION_BRIGHT = 2;
+		
         // Ambient illumination index is "medium".
         // E.g. daytime with overcast sky.
         AMBIENT_ILLUMINATION_MEDIUM = 3;
+		
         // Ambient illumination index is "low".
         // E.g. during twilight (dawn/dusk) or in a tunnel.
         AMBIENT_ILLUMINATION_LOW = 4;
+		
         // Ambient illumination index is "dark".
         // E.g. night time, no sunlight.
         AMBIENT_ILLUMINATION_DARK = 5;

osi_groundtruth.proto

@@ -39,7 +39,6 @@ message GroundTruth
     // The data timestamp of the simulation environment. Zero time is arbitrary but must be identical for all messages.
     // Zero time does not need to coincide with the unix epoch. Recommended is the starting time point of the
     // simulation.
-    //
     optional Timestamp timestamp = 2;
 
     // A list of vehicles.