Remove doxygen link bugs

carsten-kuebler · carsten-kuebler · commit 434561b35f1a · 2018-04-18T14:59:13.000+02:00
remove link bugs and use homogenous notations.
diff --git a/doxygen_config.cmake.in b/doxygen_config.cmake.in
@@ -15,8 +15,12 @@ IMAGE_PATH             = "@CMAKE_CURRENT_SOURCE_DIR@/doc/images"
 # A Doxygen filter for .proto files has to be added under the directory doc/.
 # proto2cpp.py is an external script. See README.md for more informations.
 JAVADOC_AUTOBRIEF      = NO
-EXTENSION_MAPPING      = proto=C
+EXTENSION_MAPPING      = proto=C++
 FILE_PATTERNS          = *.proto
 INPUT_FILTER           = "python @FILTER_PROTO2CPP_PY_PATH@/proto2cpp.py"
 HAVE_DOT               = YES
 HIDE_UNDOC_RELATIONS   = NO
+
+# If someone wants UML diagrams in the documentation, the next parameter must 
+# be commented in.
+#UML_LOOK               = YES
diff --git a/osi_common.proto b/osi_common.proto
@@ -135,7 +135,7 @@ message Dimension3d
 //
 // <tt>Rotation_yaw_pitch_roll = Rotation_roll*Rotation_pitch*Rotation_yaw</tt>
 //
-// <tt>vector_global_coord_system := Inverse_Rotation_yaw_pitch_roll(</tt><tt>Orientation3d</tt><tt>)*(vector_local_coord_system) + local_origin.position</tt>
+// <tt>vector_global_coord_system := Inverse_Rotation_yaw_pitch_roll(</tt><tt>Orientation3d</tt><tt>)*(vector_local_coord_system) + local_origin::position</tt>
 
 //
 // \attention This definition changed in OSI version 3.0.0. Previous OSI
@@ -249,7 +249,7 @@ message Spherical3d
 // All coordinates and orientations from ground truth objects are relative to
 // the global ground truth frame. All coordinates and orientations
 // from detected objects are relative to the host vehicle frame (see:
-// \c MovingObject.Vehicle vehicle reference point).
+// \c MovingObject::Vehicle vehicle reference point).
 //
 message BaseStationary
 {
@@ -304,7 +304,7 @@ message BaseStationary
 // All coordinates and orientations from ground truth objects are relative to
 // the global ground truth frame. All coordinates and orientations
 // from detected objects are relative to the host vehicle frame
-// (see: \c MovingObject.Vehicle vehicle reference point).
+// (see: \c MovingObject::Vehicle vehicle reference point).
 //
 message BaseMoving
 {
diff --git a/osi_detectedlane.proto b/osi_detectedlane.proto
@@ -32,7 +32,7 @@ message DetectedLane
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
@@ -70,27 +70,26 @@ message DetectedLaneBoundary
     // attribute has to be set for each instance. All other values will be
     // reused from the previous \c BoundaryPoint in the sequence or set to
     // default values if there is none or it was never set. For dashed lines,
-    // one \c BoundaryPoint has to be at the start and another at the end
+    // one \c LaneBoundary::BoundaryPoint has to be at the start and another at the end
     // of each dashed line segment. For Botts' dots lines, one
-    // \c BoundaryPoint position has to define each Botts' dot.
+    // \c LaneBoundary::BoundaryPoint position has to define each Botts' dot.
     //
-    // \attention For \c BoundaryPoint the same rules regarding maximum
-    // distance and approximation error apply as for \c Lane::centerline.
+    // \attention For \c LaneBoundary::BoundaryPoint the same rules regarding maximum
+    // distance and approximation error apply as for \c Lane::Classification::centerline.
     //
     repeated LaneBoundary.BoundaryPoint boundary_line = 3;
 
-    // The root mean squared error of the \c LaneBoundary.BoundaryPoint
-    // information from a \c LaneBoundary.
-    // For each \c #lane_boundary \c LaneBoundary::boundary_line point exact
-    // one \c #boundary_line_rmse rmse information exist.
+    // The root mean squared error of the \c LaneBoundary::BoundaryPoint.
+    // Each \c #candidate has the same \c #boundary_line points and exact
+    // one \c #boundary_line_rmse rmse confidence value is
+    // specified which is suitable for all candidates.
     //
     repeated LaneBoundary.BoundaryPoint boundary_line_rmse = 4;
 
-    // Confidence of the segments of the \c LaneBoundary.BoundaryPoint
-    // information from a \c LaneBoundary.
-    // For each \c #lane_boundary \c LaneBoundary::boundary_line point exact
+    // Confidence of the segments of the \c LaneBoundary::BoundaryPoint.
+    // Each \c #candidate has the same \c #boundary_line points and exact
     // one \c #boundary_line_confidences confidence value is
-    // specified.
+    // specified which is suitable for all candidates.
     //
     // Range: [0,1]
     //
@@ -106,7 +105,7 @@ message DetectedLaneBoundary
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
diff --git a/osi_detectedobject.proto b/osi_detectedobject.proto
@@ -124,7 +124,7 @@ message DetectedStationaryObject
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
@@ -163,7 +163,7 @@ message DetectedMovingObject
     // estimation) as used by the sensor (model).
     //
     // \note Note that the value of this field has no impact on the value of
-    // object.position, which always references the center of the object /
+    // object::position, which always references the center of the object /
     // bounding box.
     //
     optional ReferencePoint reference_point = 4;
@@ -229,7 +229,7 @@ message DetectedMovingObject
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
@@ -242,8 +242,8 @@ message DetectedMovingObject
         // Specific information about the classification of the vehicle.
         //
         //
-        // \note This field is mandatory if the \c CandidateMovingObject.type is
-        // #TYPE_VEHICLE .
+        // \note This field is mandatory if the \c CandidateMovingObject::type is
+        // \c MovingObject::TYPE_VEHICLE .
         //
         optional MovingObject.VehicleClassification vehicle_classification = 3;
 
@@ -256,7 +256,7 @@ message DetectedMovingObject
         // <tt>View_normal_base_coord_system = Inverse_Rotation(#head_pose)*Unit_vector_x</tt>
         //
         // \note This field is mandatory if the \c CandidateMovingObject.type is
-        // #TYPE_PEDESTRIAN
+        // \c MovingObject::TYPE_PEDESTRIAN
         //
         // \par References:
         // \li [1] https://en.wikipedia.org/wiki/Anatomical_terms_of_location
@@ -272,8 +272,8 @@ message DetectedMovingObject
         //
         // <tt>View_normal_base_coord_system = Inverse_Rotation(#upper_body_pose)*Unit_vector_x</tt>
         //
-        // \note This field is mandatory if the \c CandidateMovingObject.type is
-        // #TYPE_PEDESTRIAN
+        // \note This field is mandatory if the \c CandidateMovingObject::type is
+        // \c MovingObject::TYPE_PEDESTRIAN
         //
         // \par References:
         // \li [2] https://en.wikipedia.org/wiki/Anatomical_terms_of_location
diff --git a/osi_detectedoccupant.proto b/osi_detectedoccupant.proto
@@ -33,7 +33,7 @@ message DetectedOccupant
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
diff --git a/osi_detectedroadmarking.proto b/osi_detectedroadmarking.proto
@@ -60,7 +60,7 @@ message DetectedRoadMarking
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
diff --git a/osi_detectedtrafficlight.proto b/osi_detectedtrafficlight.proto
@@ -47,7 +47,7 @@ message DetectedTrafficLight
         //
         // \note The sum of all \c #probability must be one. This probability is
         // given under the condition of
-        // \c #DetectedItemHeader.existence_probability.
+        // \c DetectedItemHeader::existence_probability.
         //
         // Range: [0,1]
         //
diff --git a/osi_detectedtrafficsign.proto b/osi_detectedtrafficsign.proto
@@ -73,7 +73,7 @@ message DetectedTrafficSign
             //
             // \note The sum of all \c #probability must be one. This probability is
             // given under the condition of
-            // \c #DetectedItemHeader.existence_probability.
+            // \c DetectedItemHeader::existence_probability.
             //
             // Range: [0,1]
             //
@@ -193,7 +193,7 @@ message DetectedTrafficSign
             //
             // \note The sum of all \c #probability must be one. This probability is
             // given under the condition of
-            // \c #DetectedItemHeader.existence_probability.
+            // \c DetectedItemHeader::existence_probability.
             //
             // Range: [0,1]
             //
diff --git a/osi_featuredata.proto b/osi_featuredata.proto
@@ -60,7 +60,7 @@ message SensorDetectionHeader
 
     // Mounting position of the sensor (origin and orientation of the sensor
     // frame). Both origin and orientation are given in and with respect to the
-    // host vehicle coordinate system (see: \c MovingObject.Vehicle vehicle
+    // host vehicle coordinate system (see: \c MovingObject::Vehicle vehicle
     // reference point) [1].
     //
     // The sensor frame's x-axis is pointing in the central viewing direction of
diff --git a/osi_lane.proto b/osi_lane.proto
@@ -321,7 +321,7 @@ message LaneBoundary
     // \c BoundaryPoint position has to define each Botts' dot.
     //
     // \attention For \c BoundaryPoint the same rule for the approximation
-    // error applies as for \c Lane::centerline.
+    // error applies as for \c Lane::Classification::centerline.
     //
     repeated BoundaryPoint boundary_line = 2;
 
@@ -370,9 +370,9 @@ message LaneBoundary
         //
         optional Color color = 2;
 
-        // The ids of \c StationaryObjects which limit the corresponding lane.
-        // This field must be set if the \c LaneBoundary.type is set to
-        // #TYPE_STRUCTURE
+        // The ids of \c StationaryObject which limit the corresponding lane.
+        // This field must be set if the \c #type is set to
+        // \c #TYPE_STRUCTURE
         //
         repeated Identifier limiting_structure_id = 3;
 
diff --git a/osi_object.proto b/osi_object.proto
@@ -253,8 +253,8 @@ message StationaryObject
 // moving object (animal, pedestrian, etc), but not a stationary
 // object (\c TrafficLight, \c TrafficSign, or \c StationaryObject).
 //
-// \note The field \c MovingObject.vehicle_extension has to be
-// filled if the \c MovingObject.Type is a vehicle.
+// \note The field \c MovingObject::vehicle_extension has to be
+// filled if the \c MovingObject::Type is a vehicle.
 //
 message MovingObject
 {
@@ -283,15 +283,15 @@ message MovingObject
 
     // Specific information about the vehicle.
     //
-    // \note This field is mandatory if the \c MovingObject.type is
+    // \note This field is mandatory if the \c #type is
     // #TYPE_VEHICLE .
     //
     optional VehicleAttributes vehicle_attributes = 5;
 
     // Specific information about the classification of the vehicle.
     //
     //
-    // \note This field is mandatory if the \c MovingObject.type is
+    // \note This field is mandatory if the \c #type is
     // #TYPE_VEHICLE .
     //
     optional VehicleClassification vehicle_classification = 6;
@@ -327,12 +327,12 @@ message MovingObject
     // This is an extension to the \c MovingObject with additional attributes,
     // such as type and lights. The origin of the rear (front) axis coordinate
     // system in world coordinates is calculated as:
-    // base.position + R * bbcenter_to_rear (front)
+    // \c MovingObject::base \c. \c BaseMoving::position + R * \c MovingObject::VehicleAttributes::bbcenter_to_rear (front)
     // for the host vehicle (R rotates from vehicle to world frame, i.e. inverse
-    // orientation of base.orientation).
+    // orientation of \c MovingObject::base \c. \c BaseMoving::orientation).
     //
     // For all vehicles, including host vehicles, the position given in
-    // base.position points to the center of the vehicle's bounding box.
+    //  \c MovingObject::base \c. \c BaseMoving::position points to the center of the vehicle's bounding box.
     //
     // The vehicle object coordinates are defined as x-axis is the direction from
     // rear to front of the vehicle, y-axis corresponds to rear axle and z-axis
@@ -364,13 +364,13 @@ message MovingObject
         //
         optional uint32 number_wheels = 3;
 
-        // The vector pointing from the bounding box center point (base.position) to
+        // The vector pointing from the bounding box center point (\c MovingObject::base \c. \c BaseMoving::position) to
         // the middle (in x, y and z) of the rear axle under neutral load
         // conditions. In object coordinates.
         //
         optional Vector3d bbcenter_to_rear = 4;
 
-        // The vector pointing from the bounding box center point (base.position) to
+        // The vector pointing from the bounding box center point (\c MovingObject::base \c. \c BaseMoving::position) to
         // the middle (in x, y and z) of the front axle under neutral load
         // conditions. In object coordinates.
         //
diff --git a/osi_sensordata.proto b/osi_sensordata.proto
@@ -172,9 +172,12 @@ message SensorData
     //
     // \note This field is usually static during the simulation.
     // \note The origin of vehicle's coordinate system in world frame is
-    // ( \c MovingObject.Vehicle::base.position + Inverse_Rotation_yaw_pitch_roll(\c MovingObject.Vehicle::base.orientation) * \c MovingObject.Vehicle::bbcenter_to_rear) .
-    // The orientation of the vehicle's coordinate system is equal to the orientation
-    // of the vehicle's bounding box \c MovingObject.Vehicle::base.orientation.
+    // ( \c MovingObject::base \c. \c BaseMoving::position + Inverse_Rotation_yaw_pitch_roll(
+    // \c MovingObject::base \c. \c BaseMoving::orientation) * 
+    // \c MovingObject::VehicleAttributes::bbcenter_to_rear) .
+    // The orientation of the vehicle's coordinate system is equal to the
+    // orientation of the vehicle's bounding box \c MovingObject::base \c. 
+    // \c BaseMoving::orientation.
     //
     optional MountingPosition mounting_position = 6;
 
diff --git a/osi_sensorview.proto b/osi_sensorview.proto
@@ -77,9 +77,12 @@ message SensorView
     //
     // \note This field is usually static during the simulation.
     // \note The origin of vehicle's coordinate system in world frame is
-    // ( \c MovingObject.Vehicle::base.position + Inverse_Rotation_yaw_pitch_roll(\c MovingObject.Vehicle::base.orientation) * \c MovingObject.Vehicle::bbcenter_to_rear) .
-    // The orientation of the vehicle's coordinate system is equal to the orientation
-    // of the vehicle's bounding box \c MovingObject.Vehicle::base.orientation.
+    // ( \c MovingObject::base \c. \c BaseMoving::position + Inverse_Rotation_yaw_pitch_roll(
+    // \c MovingObject::base \c. \c BaseMoving::orientation) * 
+    // \c MovingObject::VehicleAttributes::bbcenter_to_rear) .
+    // The orientation of the vehicle's coordinate system is equal to the
+    // orientation of the vehicle's bounding box \c MovingObject::base \c. 
+    // \c BaseMoving::orientation.
     //
     optional MountingPosition mounting_position = 4;
 
diff --git a/osi_sensorviewconfiguration.proto b/osi_sensorviewconfiguration.proto
diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto
