Updated doc comments (#34)

Co-authored-by: Steven Maillet <25911635+smaillet@users.noreply.github.com>

Author: smaillet

src/Ubiquity.NET.Versioning/CSemVer.cs

@@ -228,12 +228,15 @@ public string ToString( string? format, IFormatProvider? formatProvider )
         /// <para>A file version is a quad of 4 <see cref="UInt16"/> values. This is convertible to a <see cref="UInt64"/> in the following
         /// pattern:
         /// (bits are numbered with MSB as the highest numeric value [Actual ordering depends on platform endianess])
-        ///    bits 48-63: MAJOR
-        ///    bits 32-47: MINOR
-        ///    bits 16-31: BUILD
-        ///    bits 0-15:  REVISION
+        /// <list type="table">
+        ///     <listheader><term>Field</term><term>Description</term></listheader>
+        ///     <item><term>bits 48-63</term><description> Major part of Build number</description></item>
+        ///     <item><term>bits 32-47</term><description> Minor part of Build number</description></item>
+        ///     <item><term>bits 16-31</term><description> Build part of Build number</description></item>
+        ///     <item><term>bits 0-15</term><description> Revision part of Build number (Odd Numbers indicate a CI build</description></item>
+        /// </list>
         /// </para>
-        /// <para>A file version cast as a <see cref="UInt64"/> is ***NOT*** the same as an Ordered version number. The file version
+        /// <para>A file version cast as a <see cref="UInt64"/> is <i><b>NOT</b></i> the same as an Ordered version number. The file version
         /// includes a "bit" for the status as a CI Build. Thus a "file version" as a <see cref="UInt64"/> is the ordered version shifted
         /// left by one bit and the LSB indicates if it is a CI build</para>
         /// </remarks>

src/Ubiquity.NET.Versioning/CiBuildInfo.cs

@@ -49,7 +49,7 @@ public override string ToString( )
         /// <param name="formatProvider">[ignored] formatting uses a well-known pattern that is independent of any localization</param>
         /// <returns>String format of the build information</returns>
         /// <remarks>
-        /// This API Always supports two distinct format options based on the CSemVer-CI spec.
+        /// This API supports two distinct format options based on the CSemVer-CI spec.
         /// <list>
         /// <item><term>P</term><description>Pre-release format using a single '.' as the leading delimiter</description></item>
         /// <item><term>R</term><description>Release format using a double dash '--' as the leading delimiter</description></item>

src/Ubiquity.NET.Versioning/FileVersionQuad.cs

@@ -21,8 +21,21 @@ namespace Ubiquity.NET.Versioning
     /// <para>A standard .NET <see cref="Version"/> is very similar except that the bit width of each
     /// field is larger AND they are signed values. That is, every <see cref="FileVersionQuad"/> can
     /// produce a valid .NET <see cref="Version"/>. However, not every <see cref="Version"/> can result
-    /// in a valid <see cref="FileVersionQuad"/>.
+    /// in a valid <see cref="FileVersionQuad"/>.</para>
+    /// <para>A file version is a quad of 4 <see cref="UInt16"/> values. This is convertible to a <see cref="UInt64"/> in the
+    /// following pattern:
+    /// (bits are numbered with MSB as the highest numeric value [Actual byte ordering depends on platform endianess])
+    /// <list type="table">
+    ///     <listheader><term>Field</term><term>Description</term></listheader>
+    ///     <item><term>bits 48-63</term><description> Major part of Build number</description></item>
+    ///     <item><term>bits 32-47</term><description> Minor part of Build number</description></item>
+    ///     <item><term>bits 16-31</term><description> Build part of Build number</description></item>
+    ///     <item><term>bits 0-15</term><description> Revision part of Build number (Odd Numbers indicate a CI build)</description></item>
+    /// </list>
     /// </para>
+    /// <para>A file version cast as a <see cref="UInt64"/> is <i><b>NOT</b></i> the same as an Ordered version number.
+    /// The file version includes a "bit" for the status as a CI Build. Thus, a "file version" as a <see cref="UInt64"/> is the
+    /// ordered version shifted left by one bit and the LSB indicates if it is a CI build</para>
     /// </remarks>
     public readonly record struct FileVersionQuad( UInt16 Major, UInt16 Minor, UInt16 Build, UInt16 Revision )
         : IComparable<FileVersionQuad>