comments update

malstraem · Feb 19, 2025 · 39290ca · 39290ca
1 parent 18a2b81
commit 39290ca
Show file tree

Hide file tree

Showing 51 changed files with 487 additions and 533 deletions.
diff --git a/source/library/Comments.xml b/source/library/Comments.xml
@@ -11,31 +11,29 @@
     <summary>
       <c>Theta (THETA)</c> field.
     </summary>
-    <value>Degrees and tenths of degree.</value>
+    <value>Degrees.</value>
     <remarks>See section 5.24.</remarks>
   </member>
 
   <member name="Rho">
     <summary>
       <c>Rho (RHO)</c> field.
     </summary>
-    <value>Nautical miles and tenths of mile.</value>
+    <value>Nautical miles.</value>
     <remarks>See section 5.25.</remarks>
   </member>
 
   <member name="OutboundMagneticCourse">
     <summary>
       <c>Outbound Magnetic Course (OB MAG CRS)</c> field.
     </summary>
-    <value>Degrees and tenths of degree.</value>
     <remarks>See section 5.26.</remarks>
   </member>
 
   <member name="InboundMagneticCourse">
     <summary>
       <c>Inbound Magnetic Course (IB MAG CRS)</c> field.
     </summary>
-    <value>Degrees and tenths of degree.</value>
     <remarks>See section 5.28.</remarks>
   </member>
 
@@ -50,23 +48,23 @@
     <summary>
       <c>VOR/NDB Frequency (VOR/NDB FREQ)</c> field.
     </summary>
-    <value>Kilohertz and tenths of kilohertz</value>
+    <value>Kilohertz.</value>
     <remarks>See section 5.34.</remarks>
   </member>
 
   <member name="MagneticVariation">
     <summary>
       <c>Magnetic Variation (MAG VAR, D MAG VAR)</c> field.
     </summary>
-    <value>Degrees and tenths of degree.</value>
+    <value>Degrees.</value>
     <remarks>See section 5.39.</remarks>
   </member>
 
-  <member name="TransitionAltitude">
+  <member name="Transition">
     <summary>
       <c>Transition Altitude/Level (TRANS ALTITUDE/LEVEL)</c> field.
     </summary>
-    <value>Feet or flight level.</value>
+    <value>Feet.</value>
     <remarks>See section 5.53.</remarks>
   </member>
 
@@ -93,6 +91,22 @@
    <remarks>See section 5.72.</remarks>
   </member>
 
+  <member name="FacElev">
+    <summary>
+      <c>Facility Elevation (FAC ELEV)</c> field.
+    </summary>
+    <value>Feet.</value>
+    <remarks>See section 5.92.</remarks>
+  </member>
+
+  <member name="MinorAxis">
+    <summary>
+      <c>Minor Axis Bearing (MINOR AXIS TRUE BRG)</c> field.
+    </summary>
+    <value>Degrees.</value>
+    <remarks>See section 5.100.</remarks>
+  </member>
+
   <member name="FIR">
     <summary>
       <c>FIR/UIR Identifier (FIR/UIR IDENT)</c> field.
@@ -125,7 +139,7 @@
     <summary>
       <c>ARC Radius (ARC RAD)</c> field.
     </summary>
-    <value>Nautical miles and thousands of mile.</value>
+    <value>Nautical miles.</value>
     <remarks>See section 5.204.</remarks>
   </member>
 
@@ -140,7 +154,7 @@
     <summary>
       <c>Ellipsoidal Height</c> field.
     </summary>
-    <value>Meters and tenths of meter.</value>
+    <value>Meters and tenths of a meter.</value>
     <remarks>See section 5.225.</remarks>
   </member>
 

diff --git a/source/library/records/airspace/BoundaryPoint.cs b/source/library/records/airspace/BoundaryPoint.cs
@@ -3,7 +3,7 @@ namespace Arinc424.Airspace;
 using Terms;
 
 /**<summary>
-  Fields of <c>Controlled Airspace</c> and <c>Restrictive Airspace</c>.
+Fields of <c>Controlled Airspace</c> and <c>Restrictive Airspace</c>.
 </summary>
 <remarks>Used by <see cref="ControlledVolume"/> and <see cref="RestrictiveVolume"/> like subsequence.</remarks>*/
 [DebuggerDisplay($"{{{nameof(Via)}}} - {{{nameof(Coordinates)}}}")]

diff --git a/source/library/records/airspace/ControlledVolume.cs b/source/library/records/airspace/ControlledVolume.cs
@@ -4,10 +4,10 @@ namespace Arinc424.Airspace;
 
 using Terms;
 
-/// <summary>
-/// <c>Controlled Airspace</c> primary record sequence.
-/// </summary>
-/// <remarks>Used by <see cref="ControlledSpace"/> like subsequence.</remarks>
+/**<summary>
+<c>Controlled Airspace</c> primary record sequence
+</summary>
+<remarks>Used by <see cref="ControlledSpace"/> like subsequence.</remarks>*/
 [Pipeline<Sequence<ControlledVolume, BoundaryPoint>>]
 
 [DebuggerDisplay($"{nameof(Class)} - {{{nameof(Class)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")]
@@ -17,10 +17,10 @@ public class ControlledVolume : Volume
     [Character(9)]
     public AirspaceType Type { get; set; }
 
-    /// <summary>
-    /// <c>Controlled Airspace Center (ARSP CNTR)</c> field.
-    /// </summary>
-    /// <remarks>See section 5.214.</remarks>
+    /**<summary>
+    <c>Controlled Airspace Center (ARSP CNTR)</c> field.
+    </summary>
+    <remarks>See section 5.214.</remarks>*/
     [Type(15, 16)]
     [Identifier(10, 14)]
     public IIdentity Center { get; set; }

diff --git a/source/library/records/airspace/FlightRegion.cs b/source/library/records/airspace/FlightRegion.cs
@@ -2,10 +2,10 @@
 
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// Multiple <c>FIR/UIR</c> primary record sequences.
-/// </summary>
-/// <remarks>See section 4.1.17.1.</remarks>
+/**<summary>
+Multiple <c>FIR/UIR</c> primary record sequences.
+</summary>
+<remarks>See section 4.1.17.1.</remarks>*/
 [Section('U', 'F'), Identifier(7, 10)]
 
 [Pipeline<IdentityWrap<FlightRegion, RegionVolume>>]
@@ -17,17 +17,17 @@ public class FlightRegion : Record424<RegionVolume>, IIdentity, INamed
     [Field(7, 10)]
     public string Identifier { get; set; }
 
-    /// <summary>
-    /// <c>FIR/UIR Address (ADDRESS)</c> field.
-    /// </summary>
-    /// <remarks>See section 5.151.</remarks>
+    /**<summary>
+    <c>FIR/UIR Address (ADDRESS)</c> field.
+    </summary>
+    <remarks>See section 5.151.</remarks>*/
     [Field(11, 14)]
     public string Address { get; set; }
 
-    /// <summary>
-    /// <c>FIR/UIR Name</c> field.
-    /// </summary>
-    /// <remarks>See section 5.125.</remarks>
+    /**<summary>
+    <c>FIR/UIR Name</c> field.
+    </summary>
+    <remarks>See section 5.125.</remarks>*/
     [Field(99, 123)]
     public string? Name { get; set; }
 }
diff --git a/source/library/records/airspace/RegionPoint.cs b/source/library/records/airspace/RegionPoint.cs
@@ -1,9 +1,9 @@
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// Fields of <c>FIR/UIR</c>.
-/// </summary>
-/// <remarks>Used by <see cref="RegionVolume"/> like subsequence.</remarks>
+/**<summary>
+Fields of <c>FIR/UIR</c>.
+</summary>
+<remarks>Used by <see cref="RegionVolume"/> like subsequence.</remarks>*/
 public class RegionPoint : BoundaryPoint
 {
     /// <include file='Comments.xml' path="doc/member[@name='FIR']/*"/>

diff --git a/source/library/records/airspace/RegionVolume.cs b/source/library/records/airspace/RegionVolume.cs
@@ -3,10 +3,10 @@
 
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// <c>FIR/UIR</c> primary record sequence.
-/// </summary>
-/// <remarks>Used by <see cref="FlightRegion"/> like subsequence.</remarks>
+/**<summary>
+<c>FIR/UIR</c> primary record sequence.
+</summary>
+<remarks>Used by <see cref="FlightRegion"/> like subsequence.</remarks>*/
 [Continuous(20), Pipeline<Sequence<RegionVolume, RegionPoint>>]
 
 [DebuggerDisplay($"{{{nameof(Type)},nq}}")]
@@ -27,10 +27,10 @@ public class RegionVolume : Record424<RegionPoint>
     [Character(30)]
     public Terms.AltitudeReportUnit AltitudeReportUnit { get; set; }
 
-    /// <summary>
-    /// <c>FIR/UIR Entry Report (ENTRY)</c> character.
-    /// </summary>
-    /// <remarks>See section 5.124.</remarks>
+    /**<summary>
+    <c>FIR/UIR Entry Report (ENTRY)</c> character.
+    </summary>
+    <remarks>See section 5.124.</remarks>*/
     [Character(31)]
     public Bool IsEntryReport { get; set; }
 

diff --git a/source/library/records/airspace/RestrictiveVolume.cs b/source/library/records/airspace/RestrictiveVolume.cs
@@ -2,10 +2,10 @@
 
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// <c>Restrictive Airspace</c> primary record sequence.
-/// </summary>
-/// <remarks>Used by <see cref="RestrictiveSpace"/> like subsequence.</remarks>
+/**<summary>
+<c>Restrictive Airspace</c> primary record sequence.
+</summary>
+<remarks>Used by <see cref="RestrictiveSpace"/> like subsequence.</remarks>*/
 [Pipeline<Sequence<RestrictiveVolume, BoundaryPoint>>]
 
 [DebuggerDisplay($"{{{nameof(Type)},nq}}")]

diff --git a/source/library/records/airspace/Spaces.cs b/source/library/records/airspace/Spaces.cs
@@ -2,28 +2,28 @@
 
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// Multiple <c>Controlled Airspace</c> primary record sequences.
-/// </summary>
-/// <remarks>See section 4.1.25.1.</remarks>
+/**<summary>
+Multiple <c>Controlled Airspace</c> primary record sequences.
+</summary>
+<remarks>See section 4.1.25.1.</remarks>*/
 [Section('U', 'C'), Pipeline<ControlledConcatenate>]
 
 [DebuggerDisplay($"{{{nameof(Icao)},nq}}, {{{nameof(Name)},nq}}")]
 public class ControlledSpace : Space<ControlledVolume>;
 
-/// <summary>
-/// Multiple <c>Restrictive Airspace</c> primary record sequences.
-/// </summary>
-/// <remarks>See section 4.1.18.1.</remarks>
+/**<summary>
+Multiple <c>Restrictive Airspace</c> primary record sequences.
+</summary>
+<remarks>See section 4.1.18.1.</remarks>*/
 [Section('U', 'R'), Pipeline<RestrictiveWrap>]
 
 [DebuggerDisplay($"{{{nameof(Icao)},nq}}, {{{nameof(Identifier)},nq}}")]
 public class RestrictiveSpace : Space<RestrictiveVolume>, IIdentity
 {
-    /// <summary>
-    /// <c>Restrictive Airspace Designation</c> field.
-    /// </summary>
-    /// <remarks>See section 5.129.</remarks>
+    /**<summary>
+    <c>Restrictive Airspace Designation</c> field.
+    </summary>
+    <remarks>See section 5.129.</remarks>*/
     [Field(10, 19)]
     public string Identifier { get; set; }
 }
diff --git a/source/library/records/airspace/Space{TVolume}.cs b/source/library/records/airspace/Space{TVolume}.cs
@@ -8,8 +8,8 @@ public abstract class Space<TVolume> : Record424<TVolume>, IIcao, INamed where T
     public Icao Icao { get; set; }
 
     /**<summary>
-      <c>Restrictive Airspace Name</c> for <see cref="RestrictiveSpace"/> and
-      <c>Controlled Airspace Name (ARSP NAME)</c> for <see cref="ControlledSpace"/> field.
+    <c>Restrictive Airspace Name</c> for <see cref="RestrictiveSpace"/> and
+    <c>Controlled Airspace Name (ARSP NAME)</c> for <see cref="ControlledSpace"/> field.
     </summary>
     <remarks>See section 5.126 and 5.216.</remarks>*/
     [Field(94, 123)]

diff --git a/source/library/records/airspace/Volume.cs b/source/library/records/airspace/Volume.cs
@@ -1,8 +1,6 @@
 namespace Arinc424.Airspace;
 
-/// <summary>
-/// Space volume with low and up limits.
-/// </summary>
+/// <summary>Space volume with low and up limits.</summary>
 [Icao(7, 8)]
 public abstract class Volume : Record424<BoundaryPoint>, IMultiple
 {
@@ -17,9 +15,7 @@ public abstract class Volume : Record424<BoundaryPoint>, IMultiple
     [Character(27)]
     public TimeCode TimeCode { get; set; }
 
-    /// <summary>
-    /// <c>NOTAM</c> character.
-    /// </summary>
+    /// <summary><c>NOTAM</c> character.</summary>
     /// <remarks>See section 5.132.</remarks>
     [Character(28)]
     public char Notam { get; set; }

diff --git a/source/library/records/comms/AirwayCommunication.cs b/source/library/records/comms/AirwayCommunication.cs
@@ -2,8 +2,10 @@ namespace Arinc424.Comms;
 
 using Processing;
 
-/// <summary><c>Enroute Communications</c> primary record sequence.</summary>
-/// <remarks>See section 4.1.23.1.</remarks>
+/**<summary>
+<c>Enroute Communications</c> primary record sequence.
+</summary>
+<remarks>See section 4.1.23.1.</remarks>*/
 [Section('E', 'V'), Continuous(56)]
 
 [Pipeline<Sequence<AirwayCommunication, AirwayTransmitter>>(Start = Supplement.V19)]

diff --git a/source/library/records/comms/AirwayTransmitter.cs b/source/library/records/comms/AirwayTransmitter.cs
@@ -1,7 +1,7 @@
 namespace Arinc424.Comms;
 
 /**<summary>
-  Fields of <c>Enroute Communications</c>.
+Fields of <c>Enroute Communications</c>.
 </summary>
 <remarks>Used by <see cref="AirwayCommunication"/> like subsequence.</remarks>*/
 [DebuggerDisplay($"{{{nameof(Narrative)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")]

diff --git a/source/library/records/comms/PortTransmitter.cs b/source/library/records/comms/PortTransmitter.cs
@@ -3,21 +3,21 @@ namespace Arinc424.Comms;
 using Terms;
 
 /**<summary>
-  Fields of <c>Airport Communications</c> and <c>Heliport Communications</c>.
+Fields of <c>Airport Communications</c> and <c>Heliport Communications</c>.
 </summary>
 <remarks>Used by <see cref="PortCommunication"/> like subsequence.</remarks>*/
 [DebuggerDisplay($"{{{nameof(CallSign)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")]
 public class PortTransmitter : Transmitter
 {
     /**<summary>
-      <c>Multi-Sector Indicator (MSEC IND)</c> character.
+    <c>Multi-Sector Indicator (MSEC IND)</c> character.
     </summary>
     <remarks>See section 5.286.</remarks>*/
     [Character(68, Start = Supplement.V19)]
     public Bool IsMultiSector { get; set; }
 
     /**<summary>
-      <c>Sectorization (SECTOR)</c> field.
+    <c>Sectorization (SECTOR)</c> field.
     </summary>
     <remarks>See section 5.183.</remarks>*/
     [Field(63, 68), Field(69, 74, Start = Supplement.V19)]
@@ -33,7 +33,7 @@ public class PortTransmitter : Transmitter
     public DistanceLimitation Limitation { get; set; }
 
     /**<summary>
-      <c>Communications Distance (COMM DIST)</c> field.
+    <c>Communications Distance (COMM DIST)</c> field.
     </summary>
     <value>Nautical miles.</value>
     <remarks>See section 5.188.</remarks>*/

diff --git a/source/library/records/comms/Transmitter.cs b/source/library/records/comms/Transmitter.cs
@@ -47,9 +47,9 @@ public abstract class Transmitter : Geo, ISequenced
     public AltitudeDescription AltitudeDescription { get; set; }
 
     /**<summary>
-      <c>Communication Altitude (COMM ALTITUDE)</c> field.
+    <c>Communication Altitude (COMM ALTITUDE)</c> field.
     </summary>
-    <value>Hundredth of feet.</value>
+    <value>Feet.</value>
     <remarks>See section 5.184.</remarks>*/
     [Field(70, 74), Field(84, 86, Start = Supplement.V19)]
     [Field<AirwayTransmitter>(94, 98)]