feat(docs): Patch asn.1 doc comments even more

autogen/asn.1/cpm_2_1_1.asn

@@ -253,7 +253,7 @@ PerceivedObjectContainer ::= SEQUENCE {
     ...
 }
 
-/** @brief Perceived Objects
+/**
  * This DF provides a list of perceived objects represented in the coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction.
 */
 PerceivedObjects::= SEQUENCE SIZE(0..255, ...) OF PerceivedObject (WITH COMPONENTS {... ,objectId PRESENT})

autogen/asn.1/ivim_2_1_1.asn

@@ -21,9 +21,8 @@ FROM IVI { iso (1) standard (0) ivi (19321) version2 (2) }
 ItsPduHeader
 FROM ITS-Container { itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (102894) cdd (2) version (2)};
 
--- In vehicle information Message Message
-
--- @brief In vehicle information Message Root
+-- In vehicle information Message Root
+--
 -- This DF includes DEs for the IVIM protocolVersion, the IVI message type identifier _messageID_,
 -- the station identifier _stationID_ of the originating ITS-S and the IVI data from ISO TS 19321.
 IVIM ::= SEQUENCE {

scripts/asn1-patches/cpm_2_1_1-part3.patch

@@ -0,0 +1,13 @@
+diff --git a/autogen/asn.1/cpm_2_1_1-part3.asn b/autogen/asn.1/cpm_2_1_1-part3.asn
+index 146bbd7..b152b79 100644
+--- a/autogen/asn.1/cpm_2_1_1-part3.asn
++++ b/autogen/asn.1/cpm_2_1_1-part3.asn
+@@ -26,7 +26,7 @@ PerceivedObjectContainer ::= SEQUENCE {
+     ...
+ }
+
+-/** @brief Perceived Objects
++/**
+  * This DF provides a list of perceived objects represented in the coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction.
+ */
+ PerceivedObjects::= SEQUENCE SIZE(0..255, ...) OF PerceivedObject (WITH COMPONENTS {... ,objectId PRESENT})

scripts/asn1-patches/dsrc_2_2_1.patch → scripts/asn1-patches/dsrc_2_2_1-part1.patch

@@ -1,7 +1,7 @@
-diff --git a/autogen/asn.1/dsrc_2_2_1.asn b/autogen/asn.1/dsrc_2_2_1.asn
+diff --git a/autogen/asn.1/dsrc_2_2_1-part1.asn b/autogen/asn.1/dsrc_2_2_1-part1.asn
 index be97e59..86ca46b 100644
---- a/autogen/asn.1/dsrc_2_2_1.asn
-+++ b/autogen/asn.1/dsrc_2_2_1.asn
+--- a/autogen/asn.1/dsrc_2_2_1-part1.asn
++++ b/autogen/asn.1/dsrc_2_2_1-part1.asn
 @@ -1382,7 +1382,9 @@ RequestorDescription ::= SEQUENCE {
    transitSchedule   DeltaTime OPTIONAL,
    regional          SEQUENCE (SIZE(1..4)) OF RegionalExtension {{Reg-RequestorDescription}} OPTIONAL,

scripts/asn1-patches/ivim_2_1_1-part1.patch

@@ -0,0 +1,16 @@
+diff --git a/autogen/asn.1/ivim_2_1_1-part1.asn b/autogen/asn.1/ivim_2_1_1-part1.asn
+index fafdc1f..a542164 100644
+--- a/autogen/asn.1/ivim_2_1_1-part1.asn
++++ b/autogen/asn.1/ivim_2_1_1-part1.asn
+@@ -21,9 +21,8 @@ FROM IVI { iso (1) standard (0) ivi (19321) version2 (2) }
+ ItsPduHeader
+ FROM ITS-Container { itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (102894) cdd (2) version (2)};
+
+--- In vehicle information Message Message
+-
+--- @brief In vehicle information Message Root
++-- In vehicle information Message Root
++--
+ -- This DF includes DEs for the IVIM protocolVersion, the IVI message type identifier _messageID_,
+ -- the station identifier _stationID_ of the originating ITS-S and the IVI data from ISO TS 19321.
+ IVIM ::= SEQUENCE {

scripts/recompile-asn1.sh

@@ -71,8 +71,9 @@ for file in $rootdir/src/standards/*_*.rs; do
     # remove `*` at the beginning of lines
     sed -i '' -E 's/#\[doc = "\*[[:space:]]?/#\[doc = "/' $file
 
-    # enforce newlines before "@attrs"
-    sed -i '' -E 's/#\[doc = "@/#\[doc = "\\n@/' $file
+    # convert @field into lists and enforce newlines before other "@attrs"
+    sed -i '' -E 's/#\[doc = "@field/#\[doc = "- @field/' $file
+    sed -i '' -E 's/#\[doc = "@/#\[doc = "\\n\\n@/' $file
 
     # add `ignore` to code blocks
     sed -i '' -E 's/#\[doc = "```"/#\[doc = "```text"/' $file

src/standards/cpm_2_1_1.rs

@@ -24,7 +24,7 @@ pub mod cpm_originating_station_containers {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field mapReference: identifies the MAPEM containing the topology information reference in the Perceived Object Container"]
+    #[doc = "- @field mapReference: identifies the MAPEM containing the topology information reference in the Perceived Object Container"]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -43,13 +43,13 @@ pub mod cpm_originating_station_containers {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field orientationAngle: the angle and angle accuracy of the absolute orientation of the disseminating vehicle in the WGS84 coordinate system with respect to true North."]
+    #[doc = "- @field orientationAngle: the angle and angle accuracy of the absolute orientation of the disseminating vehicle in the WGS84 coordinate system with respect to true North."]
     #[doc = ""]
-    #[doc = "\n@field pitchAngle: the optional angle and angle accuracy between the ground plane and the current orientation of the vehicle's x-axis with respect to the ground plane about the y-axis according to the ISO 8855."]
+    #[doc = "- @field pitchAngle: the optional angle and angle accuracy between the ground plane and the current orientation of the vehicle's x-axis with respect to the ground plane about the y-axis according to the ISO 8855."]
     #[doc = ""]
-    #[doc = "\n@field rollAngle: the optional angle and angle accuracy between the ground plane and the current orientation of a vehicle's y-axis with respect to the ground plane about the x-axis according to the ISO 8855"]
+    #[doc = "- @field rollAngle: the optional angle and angle accuracy between the ground plane and the current orientation of a vehicle's y-axis with respect to the ground plane about the x-axis according to the ISO 8855"]
     #[doc = ""]
-    #[doc = "\n@field trailerData: information about the trailer dimensions and orientation in case a trailer is present."]
+    #[doc = "- @field trailerData: information about the trailer dimensions and orientation in case a trailer is present."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -120,9 +120,9 @@ pub mod cpm_pdu_descriptions {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field header: the common message header for the facilities layer message. "]
+    #[doc = "- @field header: the common message header for the facilities layer message. "]
     #[doc = ""]
-    #[doc = "\n@field payload: the payload of the message. "]
+    #[doc = "- @field payload: the payload of the message. "]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -152,9 +152,9 @@ pub mod cpm_pdu_descriptions {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field managementContainer: the management container. "]
+    #[doc = "- @field managementContainer: the management container. "]
     #[doc = ""]
-    #[doc = "\n@field cpmContainers: the list of CPM containers, including its container type identifier and including either one or none of originatingVehicleContainer and/or originatingRsuContainer. "]
+    #[doc = "- @field cpmContainers: the list of CPM containers, including its container type identifier and including either one or none of originatingVehicleContainer and/or originatingRsuContainer. "]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -182,13 +182,13 @@ pub mod cpm_pdu_descriptions {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field referenceTime: the reference time for all time related information in the CPM."]
+    #[doc = "- @field referenceTime: the reference time for all time related information in the CPM."]
     #[doc = ""]
-    #[doc = "\n@field messageRateRange: the planned or expected range of the CPM generation rate."]
+    #[doc = "- @field messageRateRange: the planned or expected range of the CPM generation rate."]
     #[doc = ""]
-    #[doc = "\n@field segmentationInfo: information regarding the message segmentation on facility layer."]
+    #[doc = "- @field segmentationInfo: information regarding the message segmentation on facility layer."]
     #[doc = ""]
-    #[doc = "\n@field referencePosition: the reference position for all position related information in the CPM."]
+    #[doc = "- @field referencePosition: the reference position for all position related information in the CPM."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -223,9 +223,9 @@ pub mod cpm_pdu_descriptions {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field messageRateMin: the minimum planned or expected message rate."]
+    #[doc = "- @field messageRateMin: the minimum planned or expected message rate."]
     #[doc = ""]
-    #[doc = "\n@field messageRateMax: the maximum planned or expected message rate."]
+    #[doc = "- @field messageRateMax: the maximum planned or expected message rate."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -248,9 +248,9 @@ pub mod cpm_pdu_descriptions {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field containerId: the identifier of the container type."]
+    #[doc = "- @field containerId: the identifier of the container type."]
     #[doc = ""]
-    #[doc = "\n@field containerData: the container content consistent with the container type."]
+    #[doc = "- @field containerData: the container content consistent with the container type."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -301,9 +301,9 @@ pub mod cpm_perceived_object_container {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field numberOfPerceivedObjects: the total number of perceived objects at the time of generating the message. "]
+    #[doc = "- @field numberOfPerceivedObjects: the total number of perceived objects at the time of generating the message. "]
     #[doc = ""]
-    #[doc = "\n@field perceivedObjects: the list of perceived objects."]
+    #[doc = "- @field perceivedObjects: the list of perceived objects."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -325,7 +325,7 @@ pub mod cpm_perceived_object_container {
             }
         }
     }
-    #[doc = "\n@brief Perceived Objects"]
+
     #[doc = "This DF provides a list of perceived objects represented in the coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction."]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(delegate, size("0..=255", extensible))]
@@ -362,19 +362,19 @@ pub mod cpm_perception_region_container {
     #[doc = "This DF represents the actual perception capabilities available to the transmitting ITS-S, offering additional (often dynamic) details to the information provided in the sensor information container."]
     #[doc = ""]
     #[doc = "It shall include the following components: "]
-    #[doc = "\n@field measurementDeltaTime: difference between the time of estimation of the perception region and the reference time. Positive values indicates that the provided information refers to a point in time after the reference time."]
+    #[doc = "- @field measurementDeltaTime: difference between the time of estimation of the perception region and the reference time. Positive values indicates that the provided information refers to a point in time after the reference time."]
     #[doc = ""]
-    #[doc = "\n@field perceptionRegionConfidence: the perception confidence."]
+    #[doc = "- @field perceptionRegionConfidence: the perception confidence."]
     #[doc = ""]
-    #[doc = "\n@field perceptionRegionShape: specification of the shape of the perception region."]
+    #[doc = "- @field perceptionRegionShape: specification of the shape of the perception region."]
     #[doc = ""]
-    #[doc = "\n@field shadowingApplies: indicates if the standard shadowing approach applies to the described perception region."]
+    #[doc = "- @field shadowingApplies: indicates if the standard shadowing approach applies to the described perception region."]
     #[doc = ""]
-    #[doc = "\n@field sensorIdList: the optional list of identifiers of the sensors which are involved in perceiving the region."]
+    #[doc = "- @field sensorIdList: the optional list of identifiers of the sensors which are involved in perceiving the region."]
     #[doc = ""]
-    #[doc = "\n@field numberOfPerceivedObjects: the optional number of perceived objects contained in the perception region specified in the component perceptionRegionShape. "]
+    #[doc = "- @field numberOfPerceivedObjects: the optional number of perceived objects contained in the perception region specified in the component perceptionRegionShape. "]
     #[doc = ""]
-    #[doc = "\n@field perceivedObjectIds: the optional list of identifiers of the objects specified in the Perceived Object Container that are contained in the perception region specified in the component perceptionRegionShape."]
+    #[doc = "- @field perceivedObjectIds: the optional list of identifiers of the objects specified in the Perceived Object Container that are contained in the perception region specified in the component perceptionRegionShape."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]
@@ -441,16 +441,16 @@ pub mod cpm_sensor_information_container {
     #[doc = ""]
     #[doc = "It shall include the following components: "]
     #[doc = ""]
-    #[doc = "\n@field sensorId: identifier of the sensor or data fusion system used to relate the perceived object in the Perceived Object Container to the sensor that detected it."]
+    #[doc = "- @field sensorId: identifier of the sensor or data fusion system used to relate the perceived object in the Perceived Object Container to the sensor that detected it."]
     #[doc = "this identifier shall uniquely identify the sensor inside the CPM, but may be changed from one CPM to the next."]
     #[doc = ""]
-    #[doc = "\n@field sensorType: the type of the sensor."]
+    #[doc = "- @field sensorType: the type of the sensor."]
     #[doc = ""]
-    #[doc = "\n@field perceptionRegionShape: the perception region of the sensor."]
+    #[doc = "- @field perceptionRegionShape: the perception region of the sensor."]
     #[doc = ""]
-    #[doc = "\n@field perceptionRegionConfidence: the homogeneous perception region confidence that can be assumed for the entire perception region shape of this sensor. "]
+    #[doc = "- @field perceptionRegionConfidence: the homogeneous perception region confidence that can be assumed for the entire perception region shape of this sensor. "]
     #[doc = ""]
-    #[doc = "\n@field shadowingApplies: indicates if the standard shadowing approach applies to the described perception region."]
+    #[doc = "- @field shadowingApplies: indicates if the standard shadowing approach applies to the described perception region."]
     #[doc = ""]
     #[derive(AsnType, Debug, Clone, Decode, Encode, PartialEq, Eq, Hash)]
     #[rasn(automatic_tags)]