Skip to content

Commit 6950f06

Browse files
committed
redo formatting on three cbor files
1 parent 3d45ed1 commit 6950f06

File tree

3 files changed

+37
-23
lines changed

3 files changed

+37
-23
lines changed

Diff for: xml/System.Formats.Cbor/CborConformanceMode.xml

+33-11
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,15 @@
4040
<para>Ensures that the CBOR data is canonical, as specified in RFC7049 section 3.9.</para>
4141
<para>Extends strict conformance with the following requirements:</para>
4242
<list type="bullet">
43-
<item>Integers must be encoded as small as possible.</item>
44-
<item>Maps (major type 5) must contain keys sorted by encoding.</item>
45-
<item>Indefinite-length items must be made into definite-length items.</item>
43+
<item>
44+
<description>Integers must be encoded as small as possible.</description>
45+
</item>
46+
<item>
47+
<description>Maps (major type 5) must contain keys sorted by encoding.</description>
48+
</item>
49+
<item>
50+
<description>Indefinite-length items must be made into definite-length items.</description>
51+
</item>
4652
</list>
4753
</summary>
4854
<remarks>To be added.</remarks>
@@ -70,11 +76,21 @@
7076
<para>Ensures that the CBOR data is canonical, as specified by the CTAP v2.0 standard, section 6.</para>
7177
<para>Extends strict conformance with the following requirements:</para>
7278
<list type="bullet">
73-
<item>Maps (major type 5) must contain keys sorted by encoding.</item>
74-
<item>Indefinite-length items must be made into definite-length items.</item>
75-
<item>Integers must be encoded as small as possible.</item>
76-
<item>The representations of any floating-point values are not changed.</item>
77-
<item>CBOR tags (major type 6) are not permitted.</item>
79+
<item>
80+
<description>Maps (major type 5) must contain keys sorted by encoding.</description>
81+
</item>
82+
<item>
83+
<description>Indefinite-length items must be made into definite-length items.</description>
84+
</item>
85+
<item>
86+
<description>Integers must be encoded as small as possible.</description>
87+
</item>
88+
<item>
89+
<description>The representations of any floating-point values are not changed.</description>
90+
</item>
91+
<item>
92+
<description>CBOR tags (major type 6) are not permitted.</description>
93+
</item>
7894
</list>
7995
</summary>
8096
<remarks>To be added.</remarks>
@@ -124,9 +140,15 @@
124140
<para>Ensures that the CBOR data adheres to strict mode, as specified in RFC7049 section 3.10.</para>
125141
<para>Extends lax conformance with the following requirements:</para>
126142
<list type="bullet">
127-
<item>Maps (major type 5) must not contain duplicate keys.</item>
128-
<item>Simple values (major type 7) must be encoded as small a possible and exclude the reserved values 24-31.</item>
129-
<item>UTF-8 string encodings must be valid.</item>
143+
<item>
144+
<description>Maps (major type 5) must not contain duplicate keys.</description>
145+
</item>
146+
<item>
147+
<description>Simple values (major type 7) must be encoded as small a possible and exclude the reserved values 24-31.</description>
148+
</item>
149+
<item>
150+
<description>UTF-8 string encodings must be valid.</description>
151+
</item>
130152
</list>
131153
</summary>
132154
<remarks>To be added.</remarks>

Diff for: xml/System.Formats.Cbor/CborContentException.xml

+3-10
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@
4343
</Parameters>
4444
<Docs>
4545
<param name="message">The error message that explains the reason for the exception.</param>
46-
<summary>
47-
Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class, using the provided message.
48-
</summary>
46+
<summary>Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class, using the provided message.</summary>
4947
<remarks>To be added.</remarks>
5048
</Docs>
5149
</Member>
@@ -69,9 +67,7 @@
6967
<Docs>
7068
<param name="info">The object that holds the serialized object data.</param>
7169
<param name="context">The contextual information about the source or destination.</param>
72-
<summary>
73-
Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class with serialized data.
74-
</summary>
70+
<summary>Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class with serialized data.</summary>
7571
<remarks>To be added.</remarks>
7672
</Docs>
7773
</Member>
@@ -95,10 +91,7 @@
9591
<Docs>
9692
<param name="message">The error message that explains the reason for the exception.</param>
9793
<param name="inner">The exception that is the cause of the current exception.</param>
98-
<summary>
99-
Initializes a new instance of the <see cref="T:System.Formats.Cbor.CborContentException" /> class,
100-
using the provided message and exception that is the cause of this exception.
101-
</summary>
94+
<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>
10295
<remarks>To be added.</remarks>
10396
</Docs>
10497
</Member>

Diff for: xml/System.Formats.Cbor/CborReaderState.xml

+1-2
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,7 @@
185185
<Docs>
186186
<summary>
187187
<para>Indicates that the reader has completed reading a full CBOR document.</para>
188-
<para>If <see cref="P:System.Formats.Cbor.CborReader.AllowMultipleRootLevelValues" /> is set to <see langword="false" />,
189-
the reader will report this value even if the buffer contains trailing bytes.</para>
188+
<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>
190189
</summary>
191190
</Docs>
192191
</Member>

0 commit comments

Comments
 (0)