Skip to content

Commit 1d8d650

Browse files
ericstjericstj
committed
System.Text.Json docs
1 parent 09563c4 commit 1d8d650

19 files changed

+311
-147
lines changed

‎xml/System.Text.Json.Nodes/JsonArray.xml‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -634,10 +634,12 @@ It is safe to perform multiple concurrent read operations on a <xref:System.Text
634634
</Parameter>
635635
</Parameters>
636636
<Docs>
637-
<param name="match">To be added.</param>
638-
<summary>To be added.</summary>
639-
<returns>To be added.</returns>
637+
<param name="match">The predicate that defines the conditions of the elements to remove.</param>
638+
<summary>Removes all the elements that match the conditions defined by the specified predicate.</summary>
639+
<returns>The number of elements removed from the <see cref="T:System.Text.Json.Nodes.JsonArray" />.</returns>
640640
<remarks>To be added.</remarks>
641+
<exception cref="T:System.ArgumentNullException">
642+
<paramref name="match" /> is <see langword="null" />.</exception>
641643
</Docs>
642644
</Member>
643645
<Member MemberName="RemoveAt">
@@ -693,10 +695,14 @@ It is safe to perform multiple concurrent read operations on a <xref:System.Text
693695
<Parameter Name="count" Type="System.Int32" Index="1" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
694696
</Parameters>
695697
<Docs>
696-
<param name="index">To be added.</param>
697-
<param name="count">To be added.</param>
698-
<summary>To be added.</summary>
698+
<param name="index">The zero-based starting index of the range of elements to remove.</param>
699+
<param name="count">The number of elements to remove.</param>
700+
<summary>Removes a range of elements from the <see cref="T:System.Text.Json.Nodes.JsonArray" />.</summary>
699701
<remarks>To be added.</remarks>
702+
<exception cref="T:System.ArgumentOutOfRangeException">
703+
<paramref name="index" /> or <paramref name="count" /> is less than 0.</exception>
704+
<exception cref="T:System.ArgumentException">
705+
<paramref name="index" /> and <paramref name="count" /> do not denote a valid range of elements in the <see cref="T:System.Text.Json.Nodes.JsonArray" />.</exception>
700706
</Docs>
701707
</Member>
702708
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Text.Json.Nodes.JsonNode&gt;.CopyTo">
@@ -838,6 +844,7 @@ This member is an explicit interface member implementation. It can be used only
838844
<summary>Writes the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
839845
<remarks>To be added.</remarks>
840846
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
847+
<inheritdoc />
841848
</Docs>
842849
</Member>
843850
</Members>

‎xml/System.Text.Json.Nodes/JsonNode.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616
<Base>
1717
<BaseTypeName>System.Object</BaseTypeName>
1818
</Base>
19-
<Interfaces>
20-
</Interfaces>
19+
<Interfaces></Interfaces>
2120
<Attributes>
2221
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp">
2322
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
@@ -27,6 +26,7 @@
2726
<Docs>
2827
<summary>The base class that represents a single node within a mutable JSON document.</summary>
2928
<remarks>To be added.</remarks>
29+
<seealso cref="P:System.Text.Json.JsonSerializerOptions.UnknownTypeHandling" />
3030
</Docs>
3131
<Members>
3232
<Member MemberName="AsArray">
@@ -289,6 +289,7 @@ The underlying value of a <xref:System.Text.Json.Nodes.JsonValue> after deserial
289289
</remarks>
290290
<exception cref="T:System.FormatException">The current <see cref="T:System.Text.Json.Nodes.JsonNode" /> cannot be represented as a {TValue}.</exception>
291291
<exception cref="T:System.InvalidOperationException">The current <see cref="T:System.Text.Json.Nodes.JsonNode" /> is not a <see cref="T:System.Text.Json.Nodes.JsonValue" /> or is not compatible with {TValue}.</exception>
292+
<seealso cref="M:System.Text.Json.Nodes.JsonValue.TryGetValue``1(``0@)" />
292293
</Docs>
293294
</Member>
294295
<Member MemberName="GetValueKind">

‎xml/System.Text.Json.Nodes/JsonObject.xml‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,11 +1030,14 @@ This member is an explicit interface member implementation. It can be used only
10301030
</Parameter>
10311031
</Parameters>
10321032
<Docs>
1033-
<param name="propertyName">To be added.</param>
1034-
<param name="value">To be added.</param>
1035-
<summary>To be added.</summary>
1036-
<returns>To be added.</returns>
1033+
<param name="propertyName">The property name of the element to add.</param>
1034+
<param name="value">The value of the element to add.</param>
1035+
<summary>Adds an element with the provided name and value to the <see cref="T:System.Text.Json.Nodes.JsonObject" />, if a property named <paramref name="propertyName" /> doesn't already exist.</summary>
1036+
<returns>
1037+
<see langword="true" /> if the property didn't exist and the element was added; otherwise, <see langword="false" />.</returns>
10371038
<remarks>To be added.</remarks>
1039+
<exception cref="T:System.ArgumentNullException">
1040+
<paramref name="propertyName" /> is <see langword="null" />.</exception>
10381041
</Docs>
10391042
</Member>
10401043
<Member MemberName="TryAdd">
@@ -1065,12 +1068,15 @@ This member is an explicit interface member implementation. It can be used only
10651068
<Parameter Name="index" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
10661069
</Parameters>
10671070
<Docs>
1068-
<param name="propertyName">To be added.</param>
1069-
<param name="value">To be added.</param>
1070-
<param name="index">To be added.</param>
1071-
<summary>To be added.</summary>
1072-
<returns>To be added.</returns>
1071+
<param name="propertyName">The property name of the element to add.</param>
1072+
<param name="value">The value of the element to add.</param>
1073+
<param name="index">The index of the added or existing <paramref name="propertyName" />. This is always a valid index into the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</param>
1074+
<summary>Adds an element with the provided name and value to the <see cref="T:System.Text.Json.Nodes.JsonObject" />, if a property named <paramref name="propertyName" /> doesn't already exist.</summary>
1075+
<returns>
1076+
<see langword="true" /> if the property didn't exist and the element was added; otherwise, <see langword="false" />.</returns>
10731077
<remarks>To be added.</remarks>
1078+
<exception cref="T:System.ArgumentNullException">
1079+
<paramref name="propertyName" /> is <see langword="null" />.</exception>
10741080
</Docs>
10751081
</Member>
10761082
<Member MemberName="TryGetPropertyValue">
@@ -1110,6 +1116,8 @@ This member is an explicit interface member implementation. It can be used only
11101116
<returns>
11111117
<see langword="true" /> if a property with the specified name was found; otherwise, <see langword="false" />.</returns>
11121118
<remarks>To be added.</remarks>
1119+
<exception cref="T:System.ArgumentNullException">
1120+
<paramref name="propertyName" /> is <see langword="null" />.</exception>
11131121
</Docs>
11141122
</Member>
11151123
<Member MemberName="TryGetPropertyValue">
@@ -1140,12 +1148,17 @@ This member is an explicit interface member implementation. It can be used only
11401148
<Parameter Name="index" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
11411149
</Parameters>
11421150
<Docs>
1143-
<param name="propertyName">To be added.</param>
1144-
<param name="jsonNode">To be added.</param>
1145-
<param name="index">To be added.</param>
1146-
<summary>To be added.</summary>
1147-
<returns>To be added.</returns>
1151+
<param name="propertyName">The property name of the value to get.</param>
1152+
<param name="jsonNode">
1153+
<para>When this method returns, it contains the value associated with the specified property name, if the property name is found; otherwise <see langword="null" />.</para>
1154+
</param>
1155+
<param name="index">The index of <paramref name="propertyName" /> if found; otherwise, -1.</param>
1156+
<summary>Gets the value associated with the specified property name.</summary>
1157+
<returns>
1158+
<see langword="true" /> if the <see cref="T:System.Text.Json.Nodes.JsonObject" /> contains an element with the specified property name; otherwise, <see langword="false" />.</returns>
11481159
<remarks>To be added.</remarks>
1160+
<exception cref="T:System.ArgumentNullException">
1161+
<paramref name="propertyName" /> is <see langword="null" />.</exception>
11491162
</Docs>
11501163
</Member>
11511164
<Member MemberName="WriteTo">
@@ -1183,6 +1196,7 @@ This member is an explicit interface member implementation. It can be used only
11831196
<summary>Writes the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
11841197
<remarks>To be added.</remarks>
11851198
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
1199+
<inheritdoc />
11861200
</Docs>
11871201
</Member>
11881202
</Members>

‎xml/System.Text.Json.Nodes/JsonValue.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1270,6 +1270,7 @@ The underlying value of a <xref:System.Text.Json.Nodes.JsonValue> after deserial
12701270
12711271
]]></format>
12721272
</remarks>
1273+
<seealso cref="M:System.Text.Json.Nodes.JsonNode.GetValue``1" />
12731274
</Docs>
12741275
</Member>
12751276
</Members>

‎xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
</AssemblyInfo>
4646
<Parameters />
4747
<Docs>
48-
<summary>To be added.</summary>
48+
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.BinaryDataJsonConverter" />.</summary>
4949
<remarks>To be added.</remarks>
5050
</Docs>
5151
</Member>

‎xml/System.Text.Json.Serialization/JsonIgnoreCondition.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
</ReturnValue>
9292
<MemberValue>5</MemberValue>
9393
<Docs>
94-
<summary>To be added.</summary>
94+
<summary>Property is ignored during deserialization</summary>
9595
</Docs>
9696
</Member>
9797
<Member MemberName="WhenWriting">
@@ -111,7 +111,7 @@
111111
</ReturnValue>
112112
<MemberValue>4</MemberValue>
113113
<Docs>
114-
<summary>To be added.</summary>
114+
<summary>Property is ignored during serialization</summary>
115115
</Docs>
116116
</Member>
117117
<Member MemberName="WhenWritingDefault">

‎xml/System.Text.Json.Serialization/JsonKnownReferenceHandler.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>The <see cref="T:System.Text.Json.Serialization.ReferenceHandler" /> to be used at run time.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>2</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>Specifies that the built-in <see cref="P:System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles" /> be used to ignore cyclic references.</summary>
3838
</Docs>
3939
</Member>
4040
<Member MemberName="Preserve">
@@ -54,7 +54,7 @@
5454
</ReturnValue>
5555
<MemberValue>1</MemberValue>
5656
<Docs>
57-
<summary>To be added.</summary>
57+
<summary>Specifies that the built-in <see cref="P:System.Text.Json.Serialization.ReferenceHandler.Preserve" /> be used to handle references.</summary>
5858
</Docs>
5959
</Member>
6060
<Member MemberName="Unspecified">
@@ -74,7 +74,7 @@
7474
</ReturnValue>
7575
<MemberValue>0</MemberValue>
7676
<Docs>
77-
<summary>To be added.</summary>
77+
<summary>Specifies that circular references should throw exceptions.</summary>
7878
</Docs>
7979
</Member>
8080
</Members>

‎xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
<ReturnType>System.Boolean</ReturnType>
9595
</ReturnValue>
9696
<Docs>
97-
<summary>To be added.</summary>
97+
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.AllowDuplicateProperties" /> when set.</summary>
9898
<value>To be added.</value>
9999
<remarks>To be added.</remarks>
100100
</Docs>
@@ -566,7 +566,7 @@
566566
<ReturnType>System.Text.Json.Serialization.JsonKnownReferenceHandler</ReturnType>
567567
</ReturnValue>
568568
<Docs>
569-
<summary>To be added.</summary>
569+
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.ReferenceHandler" /> when set.</summary>
570570
<value>To be added.</value>
571571
<remarks>To be added.</remarks>
572572
</Docs>

‎xml/System.Text.Json.Serialization/JsonStringEnumMemberNameAttribute.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
</Attribute>
2626
</Attributes>
2727
<Docs>
28-
<summary>To be added.</summary>
28+
<summary>Determines the string value that should be used when serializing an enum member.</summary>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
<Members>
@@ -46,8 +46,8 @@
4646
<Parameter Name="name" Type="System.String" />
4747
</Parameters>
4848
<Docs>
49-
<param name="name">To be added.</param>
50-
<summary>To be added.</summary>
49+
<param name="name">The name to apply to the current enum member.</param>
50+
<summary>Creates new attribute instance with a specified enum member name.</summary>
5151
<remarks>To be added.</remarks>
5252
</Docs>
5353
</Member>
@@ -68,7 +68,7 @@
6868
<ReturnType>System.String</ReturnType>
6969
</ReturnValue>
7070
<Docs>
71-
<summary>To be added.</summary>
71+
<summary>Gets the name of the enum member.</summary>
7272
<value>To be added.</value>
7373
<remarks>To be added.</remarks>
7474
</Docs>

‎xml/System.Text.Json/JsonDocument.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ For more information, see [How to use the JSON DOM, Utf8JsonReader, and Utf8Json
6666
<Docs>
6767
<summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonDocument" /> instance.</summary>
6868
<remarks>To be added.</remarks>
69+
<inheritdoc />
6970
</Docs>
7071
</Member>
7172
<Member MemberName="Parse">

0 commit comments

Comments
 (0)