redo formatting on three cbor files

dotnet · Nov 17, 2021 · 6950f06 · 6950f06
1 parent 3d45ed1
commit 6950f06
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 23 deletions.
diff --git a/xml/System.Formats.Cbor/CborConformanceMode.xml b/xml/System.Formats.Cbor/CborConformanceMode.xml
@@ -40,9 +40,15 @@
           <para>Ensures that the CBOR data is canonical, as specified in RFC7049 section 3.9.</para>
           <para>Extends strict conformance with the following requirements:</para>
           <list type="bullet">
-            <item>Integers must be encoded as small as possible.</item>
-            <item>Maps (major type 5) must contain keys sorted by encoding.</item>
-            <item>Indefinite-length items must be made into definite-length items.</item>
+            <item>
+              <description>Integers must be encoded as small as possible.</description>
+            </item>
+            <item>
+              <description>Maps (major type 5) must contain keys sorted by encoding.</description>
+            </item>
+            <item>
+              <description>Indefinite-length items must be made into definite-length items.</description>
+            </item>
           </list>
         </summary>
         <remarks>To be added.</remarks>
@@ -70,11 +76,21 @@
           <para>Ensures that the CBOR data is canonical, as specified by the CTAP v2.0 standard, section 6.</para>
           <para>Extends strict conformance with the following requirements:</para>
           <list type="bullet">
-            <item>Maps (major type 5) must contain keys sorted by encoding.</item>
-            <item>Indefinite-length items must be made into definite-length items.</item>
-            <item>Integers must be encoded as small as possible.</item>
-            <item>The representations of any floating-point values are not changed.</item>
-            <item>CBOR tags (major type 6) are not permitted.</item>
+            <item>
+              <description>Maps (major type 5) must contain keys sorted by encoding.</description>
+            </item>
+            <item>
+              <description>Indefinite-length items must be made into definite-length items.</description>
+            </item>
+            <item>
+              <description>Integers must be encoded as small as possible.</description>
+            </item>
+            <item>
+              <description>The representations of any floating-point values are not changed.</description>
+            </item>
+            <item>
+              <description>CBOR tags (major type 6) are not permitted.</description>
+            </item>
           </list>
         </summary>
         <remarks>To be added.</remarks>
@@ -124,9 +140,15 @@
           <para>Ensures that the CBOR data adheres to strict mode, as specified in RFC7049 section 3.10.</para>
           <para>Extends lax conformance with the following requirements:</para>
           <list type="bullet">
-            <item>Maps (major type 5) must not contain duplicate keys.</item>
-            <item>Simple values (major type 7) must be encoded as small a possible and exclude the reserved values 24-31.</item>
-            <item>UTF-8 string encodings must be valid.</item>
+            <item>
+              <description>Maps (major type 5) must not contain duplicate keys.</description>
+            </item>
+            <item>
+              <description>Simple values (major type 7) must be encoded as small a possible and exclude the reserved values 24-31.</description>
+            </item>
+            <item>
+              <description>UTF-8 string encodings must be valid.</description>
+            </item>
           </list>
         </summary>
         <remarks>To be added.</remarks>

diff --git a/xml/System.Formats.Cbor/CborContentException.xml b/xml/System.Formats.Cbor/CborContentException.xml
@@ -43,9 +43,7 @@
       </Parameters>
       <Docs>
         <param name="message">The error message that explains the reason for the exception.</param>
-        <summary>
-             Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class, using the provided message.
-            </summary>
+        <summary>Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class, using the provided message.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -69,9 +67,7 @@
       <Docs>
         <param name="info">The object that holds the serialized object data.</param>
         <param name="context">The contextual information about the source or destination.</param>
-        <summary>
-              Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class with serialized data.
-            </summary>
+        <summary>Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class with serialized data.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -95,10 +91,7 @@
       <Docs>
         <param name="message">The error message that explains the reason for the exception.</param>
         <param name="inner">The exception that is the cause of the current exception.</param>
-        <summary>
-             Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class,
-             using the provided message and exception that is the cause of this exception.
-            </summary>
+        <summary>Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class, using the provided message and exception that is the cause of this exception.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Formats.Cbor/CborReaderState.xml b/xml/System.Formats.Cbor/CborReaderState.xml
@@ -185,8 +185,7 @@
       <Docs>
         <summary>
           <para>Indicates that the reader has completed reading a full CBOR document.</para>
-          <para>If <see cref="P:System.Formats.Cbor.CborReader.AllowMultipleRootLevelValues" /> is set to <see langword="false" />,
-            the reader will report this value even if the buffer contains trailing bytes.</para>
+          <para>If <see cref="T:System.Formats.Cbor.CborReader.AllowMultipleRootLevelValues" /> is set to <see langword="false" />, the reader will report this value even if the buffer contains trailing bytes.</para>
         </summary>
       </Docs>
     </Member>