Skip to content

Commit 56710b2

Browse files
author
Ron Petrusha
authored
Update JsonException.xml
1 parent 5a071ee commit 56710b2

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

xml/System.Text.Json/JsonException.xml

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<Type Name="JsonException" FullName="System.Text.Json.JsonException"><TypeSignature Language="C#" Value="public class JsonException : Exception" />
1+
<Type Name="JsonException" FullName="System.Text.Json.JsonException">
2+
<TypeSignature Language="C#" Value="public class JsonException : Exception" />
23
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JsonException extends System.Exception" />
34
<TypeSignature Language="DocId" Value="T:System.Text.Json.JsonException" />
45
<TypeSignature Language="VB.NET" Value="Public Class JsonException&#xA;Inherits Exception" />
@@ -34,11 +35,11 @@
3435
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
3536
</Parameters>
3637
<Docs>
37-
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
38-
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
38+
<param name="info">The serialized object data about the exception being thrown.</param>
39+
<param name="context">An object that contains contextual information about the source or destination.</param>
3940
<summary>Creates a new exception object with serialized data.</summary>
4041
<remarks>To be added.</remarks>
41-
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="info" /> is <see langword="null" />.</exception>
42+
<exception cref="T:System.ArgumentNullException"><paramref name="info" /> is <see langword="null" />.</exception>
4243
</Docs>
4344
</Member>
4445
<Member MemberName=".ctor">
@@ -60,18 +61,18 @@
6061
<Parameter Name="bytePositionInLine" Type="System.Nullable&lt;System.Int64&gt;" />
6162
</Parameters>
6263
<Docs>
63-
<param name="message">The context specific error message.</param>
64+
<param name="message">The context-specific error message.</param>
6465
<param name="path">The path where the invalid JSON was encountered.</param>
65-
<param name="lineNumber">The line number at which the invalid JSON was encountered (starting at 0) when deserializing.</param>
66-
<param name="bytePositionInLine">The byte count within the current line where the invalid JSON was encountered (starting at 0).</param>
66+
<param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
67+
<param name="bytePositionInLine">The byte count within the current line (starting at 0) where the invalid JSON was encountered.</param>
6768
<summary>Creates a new exception object to relay error information to the user.</summary>
6869
<remarks>
6970
<format type="text/markdown">
7071
<![CDATA[
7172
7273
## Remarks
7374
74-
Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars.
75+
Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.
7576
7677
]]>
7778
</format>
@@ -98,19 +99,19 @@ Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 c
9899
<Parameter Name="innerException" Type="System.Exception" />
99100
</Parameters>
100101
<Docs>
101-
<param name="message">The context specific error message.</param>
102+
<param name="message">The context-specific error message.</param>
102103
<param name="path">The path where the invalid JSON was encountered.</param>
103-
<param name="lineNumber">The line number at which the invalid JSON was encountered (starting at 0) when deserializing.</param>
104-
<param name="bytePositionInLine">The byte count within the current line where the invalid JSON was encountered (starting at 0).</param>
104+
<param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
105+
<param name="bytePositionInLine">The byte count (starting at 0) within the current line where the invalid JSON was encountered.</param>
105106
<param name="innerException">The exception that caused the current exception.</param>
106-
<summary>Creates a new exception object to relay error information to the user.</summary>
107+
<summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
107108
<remarks>
108109
<format type="text/markdown">
109110
<![CDATA[
110111
111112
## Remarks
112113
113-
Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars.
114+
Note that the `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.
114115
115116
]]>
116117
</format>
@@ -133,8 +134,8 @@ Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 c
133134
<ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
134135
</ReturnValue>
135136
<Docs>
136-
<summary>The number of bytes read within the current line before the exception (starting at 0).</summary>
137-
<value>To be added.</value>
137+
<summary>Gets the zero-based number of bytes read within the current line before the exception.</summary>
138+
<value>The zero-based number of bytes read within the current line before the exception.</value>
138139
<remarks>To be added.</remarks>
139140
</Docs>
140141
</Member>
@@ -158,8 +159,8 @@ Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 c
158159
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
159160
</Parameters>
160161
<Docs>
161-
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
162-
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
162+
<param name="info">The serialized object data about the exception being thrown.</param>
163+
<param name="context">An object that contains contextual information about the source or destination.</param>
163164
<summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.</summary>
164165
<remarks>To be added.</remarks>
165166
</Docs>
@@ -180,8 +181,8 @@ Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 c
180181
<ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
181182
</ReturnValue>
182183
<Docs>
183-
<summary>The number of lines read so far before the exception (starting at 0).</summary>
184-
<value>To be added.</value>
184+
<summary>Gets the zero-based number of lines read before the exception.</summary>
185+
<value>The zero-based number of lines read before the exception.</value>
185186
<remarks>To be added.</remarks>
186187
</Docs>
187188
</Member>
@@ -201,10 +202,10 @@ Note that the <xref:bytePositionInLine> counts the number of bytes (i.e. UTF-8 c
201202
<ReturnType>System.String</ReturnType>
202203
</ReturnValue>
203204
<Docs>
204-
<summary>The path within the JSON where the exception was encountered.</summary>
205-
<value>To be added.</value>
205+
<summary>Gets The path within the JSON where the exception was encountered.</summary>
206+
<value>The path within the JSON where the exception was encountered.</value>
206207
<remarks>To be added.</remarks>
207208
</Docs>
208209
</Member>
209210
</Members>
210-
</Type>
211+
</Type>

0 commit comments

Comments
 (0)