Skip to content

Commit 6bbc5dd

Browse files
carlossanlopmairaw
authored andcommitted
Document various isolated System.Text.Json elements (#2910)
* Document various isolated System.Text.Json elements * Update JsonStringEnumConverter.xml * Update JsonElement.xml
1 parent e196386 commit 6bbc5dd

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

xml/System.Text.Json.Serialization/JsonStringEnumConverter.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ Reading is case insensitive. Writing can be customized by using a <xref:System.T
8484
<Parameter Name="typeToConvert" Type="System.Type" />
8585
</Parameters>
8686
<Docs>
87-
<param name="typeToConvert">To be added.</param>
88-
<summary>To be added.</summary>
89-
<returns>To be added.</returns>
87+
<param name="typeToConvert">The type to be checked.</param>
88+
<summary>Determines whether the specified type can be converted to an enum.</summary>
89+
<returns><see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>
@@ -109,9 +109,9 @@ Reading is case insensitive. Writing can be customized by using a <xref:System.T
109109
<Parameter Name="typeToConvert" Type="System.Type" />
110110
</Parameters>
111111
<Docs>
112-
<param name="typeToConvert">To be added.</param>
113-
<summary>To be added.</summary>
114-
<returns>To be added.</returns>
112+
<param name="typeToConvert">The type to convert.</param>
113+
<summary>Create a converter for the specified type.</summary>
114+
<returns>An instance of <see cref="T:System.Text.Json.Serialization.JsonConverter"/> of type T, where T is compatible with <paramref name="typeToConvert"/>.</returns>
115115
<remarks>To be added.</remarks>
116116
</Docs>
117117
</Member>

xml/System.Text.Json/JsonElement.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -837,9 +837,9 @@ This method does not parse the contents of a JSON string value.
837837
<Parameter Name="index" Type="System.Int32" />
838838
</Parameters>
839839
<Docs>
840-
<param name="index">To be added.</param>
841-
<summary>Gets the value at a specified index when the current value is an <see cref="F:System.Text.Json.JsonValueKind.Array" />.</summary>
842-
<value>To be added.</value>
840+
<param name="index">The item index.</param>
841+
<summary>Gets the value at the specified index if the current value is an <see cref="F:System.Text.Json.JsonValueKind.Array" />.</summary>
842+
<value>The value at the specified index.</value>
843843
<remarks>To be added.</remarks>
844844
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Array" />.</exception>
845845
<exception cref="T:System.IndexOutOfRangeException"><paramref name="index" /> is not in the range [0, <see cref="M:System.Text.Json.JsonElement.GetArrayLength" />()).</exception>

xml/System.Text.Json/JsonEncodedText.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ This type can be used to cache and store known strings used for writing JSON ahe
108108
<Docs>
109109
<param name="value">The value to be transformed as JSON encoded text.</param>
110110
<summary>Encodes the string text value as a JSON string.</summary>
111-
<returns>To be added.</returns>
111+
<returns>The string encoded as a JSON string.</returns>
112112
<remarks>To be added.</remarks>
113113
<exception cref="T:System.ArgumentNullException"><paramref name="value" /> is <see langword="null" />.</exception>
114114
<exception cref="T:System.ArgumentException"><paramref name="value" /> is too large or contains invalid UTF-16 characters.</exception>
@@ -154,7 +154,7 @@ This type can be used to cache and store known strings used for writing JSON ahe
154154
<Parameter Name="obj" Type="System.Object" />
155155
</Parameters>
156156
<Docs>
157-
<param name="obj">To be added.</param>
157+
<param name="obj">The object to compare to this instance.</param>
158158
<summary>Determines whether this instance and a specified object, which must also be a <see cref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
159159
<returns><see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
160160
<remarks>
@@ -190,7 +190,7 @@ If `obj` is `null`, the method returns `false`.
190190
<Parameter Name="other" Type="System.Text.Json.JsonEncodedText" />
191191
</Parameters>
192192
<Docs>
193-
<param name="other">To be added.</param>
193+
<param name="other">The object to compare to this instance.</param>
194194
<summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
195195
<returns><see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
196196
<remarks>

0 commit comments

Comments
 (0)