Skip to content

Commit fa5e64c

Browse files
authored
Add note about deprecation of System.Json (dotnet#8111)
1 parent ff8f40e commit fa5e64c

File tree

7 files changed

+809
-117
lines changed

7 files changed

+809
-117
lines changed

includes/system-json.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!NOTE]
2+
> The <xref:System.Json?displayProperty=fullName> namespace was designed for Silverlight, which is no longer supported. For processing JSON, we recommend using APIs in the <xref:System.Text.Json> namespace instead.

xml/System.Json/JsonArray.xml

Lines changed: 133 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@
3838
</Interfaces>
3939
<Docs>
4040
<summary>To be added.</summary>
41-
<remarks>To be added.</remarks>
41+
<remarks>
42+
43+
## Remarks
44+
45+
[!INCLUDE[system-json](~/includes/system-json.md)]
46+
47+
</remarks>
4248
</Docs>
4349
<Members>
4450
<Member MemberName=".ctor">
@@ -63,7 +69,13 @@
6369
<Docs>
6470
<param name="items">To be added.</param>
6571
<summary>To be added.</summary>
66-
<remarks>To be added.</remarks>
72+
<remarks>
73+
74+
## Remarks
75+
76+
[!INCLUDE[system-json](~/includes/system-json.md)]
77+
78+
</remarks>
6779
</Docs>
6880
</Member>
6981
<Member MemberName=".ctor">
@@ -95,7 +107,13 @@
95107
<Docs>
96108
<param name="items">To be added.</param>
97109
<summary>To be added.</summary>
98-
<remarks>To be added.</remarks>
110+
<remarks>
111+
112+
## Remarks
113+
114+
[!INCLUDE[system-json](~/includes/system-json.md)]
115+
116+
</remarks>
99117
</Docs>
100118
</Member>
101119
<Member MemberName="Add">
@@ -126,7 +144,13 @@
126144
<Docs>
127145
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
128146
<summary>Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
129-
<remarks>To be added.</remarks>
147+
<remarks>
148+
149+
## Remarks
150+
151+
[!INCLUDE[system-json](~/includes/system-json.md)]
152+
153+
</remarks>
130154
</Docs>
131155
</Member>
132156
<Member MemberName="AddRange">
@@ -154,7 +178,13 @@
154178
<Docs>
155179
<param name="items">To be added.</param>
156180
<summary>To be added.</summary>
157-
<remarks>To be added.</remarks>
181+
<remarks>
182+
183+
## Remarks
184+
185+
[!INCLUDE[system-json](~/includes/system-json.md)]
186+
187+
</remarks>
158188
</Docs>
159189
</Member>
160190
<Member MemberName="AddRange">
@@ -189,7 +219,13 @@
189219
<Docs>
190220
<param name="items">To be added.</param>
191221
<summary>To be added.</summary>
192-
<remarks>To be added.</remarks>
222+
<remarks>
223+
224+
## Remarks
225+
226+
[!INCLUDE[system-json](~/includes/system-json.md)]
227+
228+
</remarks>
193229
</Docs>
194230
</Member>
195231
<Member MemberName="Clear">
@@ -217,7 +253,13 @@
217253
<Parameters />
218254
<Docs>
219255
<summary>Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
220-
<remarks>To be added.</remarks>
256+
<remarks>
257+
258+
## Remarks
259+
260+
[!INCLUDE[system-json](~/includes/system-json.md)]
261+
262+
</remarks>
221263
</Docs>
222264
</Member>
223265
<Member MemberName="Contains">
@@ -250,7 +292,13 @@
250292
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
251293
<returns>
252294
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
253-
<remarks>To be added.</remarks>
295+
<remarks>
296+
297+
## Remarks
298+
299+
[!INCLUDE[system-json](~/includes/system-json.md)]
300+
301+
</remarks>
254302
</Docs>
255303
</Member>
256304
<Member MemberName="CopyTo">
@@ -283,7 +331,13 @@
283331
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
284332
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
285333
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
286-
<remarks>To be added.</remarks>
334+
<remarks>
335+
336+
## Remarks
337+
338+
[!INCLUDE[system-json](~/includes/system-json.md)]
339+
340+
</remarks>
287341
</Docs>
288342
</Member>
289343
<Member MemberName="Count">
@@ -311,7 +365,13 @@
311365
<Docs>
312366
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
313367
<value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
314-
<remarks>To be added.</remarks>
368+
<remarks>
369+
370+
## Remarks
371+
372+
[!INCLUDE[system-json](~/includes/system-json.md)]
373+
374+
</remarks>
315375
</Docs>
316376
</Member>
317377
<Member MemberName="IndexOf">
@@ -343,7 +403,13 @@
343403
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.</param>
344404
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.</summary>
345405
<returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns>
346-
<remarks>To be added.</remarks>
406+
<remarks>
407+
408+
## Remarks
409+
410+
[!INCLUDE[system-json](~/includes/system-json.md)]
411+
412+
</remarks>
347413
</Docs>
348414
</Member>
349415
<Member MemberName="Insert">
@@ -376,7 +442,13 @@
376442
<param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
377443
<param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.</param>
378444
<summary>Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.</summary>
379-
<remarks>To be added.</remarks>
445+
<remarks>
446+
447+
## Remarks
448+
449+
[!INCLUDE[system-json](~/includes/system-json.md)]
450+
451+
</remarks>
380452
</Docs>
381453
</Member>
382454
<Member MemberName="IsReadOnly">
@@ -405,7 +477,13 @@
405477
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
406478
<value>
407479
<see langword="true" /> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <see langword="false" />.</value>
408-
<remarks>To be added.</remarks>
480+
<remarks>
481+
482+
## Remarks
483+
484+
[!INCLUDE[system-json](~/includes/system-json.md)]
485+
486+
</remarks>
409487
</Docs>
410488
</Member>
411489
<Member MemberName="Item">
@@ -437,7 +515,13 @@
437515
<param name="index">The zero-based index of the element to get or set.</param>
438516
<summary>Gets or sets the element at the specified index.</summary>
439517
<value>The element at the specified index.</value>
440-
<remarks>To be added.</remarks>
518+
<remarks>
519+
520+
## Remarks
521+
522+
[!INCLUDE[system-json](~/includes/system-json.md)]
523+
524+
</remarks>
441525
</Docs>
442526
</Member>
443527
<Member MemberName="JsonType">
@@ -462,7 +546,13 @@
462546
<Docs>
463547
<summary>To be added.</summary>
464548
<value>To be added.</value>
465-
<remarks>To be added.</remarks>
549+
<remarks>
550+
551+
## Remarks
552+
553+
[!INCLUDE[system-json](~/includes/system-json.md)]
554+
555+
</remarks>
466556
</Docs>
467557
</Member>
468558
<Member MemberName="Remove">
@@ -495,7 +585,13 @@
495585
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
496586
<returns>
497587
<see langword="true" /> if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
498-
<remarks>To be added.</remarks>
588+
<remarks>
589+
590+
## Remarks
591+
592+
[!INCLUDE[system-json](~/includes/system-json.md)]
593+
594+
</remarks>
499595
</Docs>
500596
</Member>
501597
<Member MemberName="RemoveAt">
@@ -526,7 +622,13 @@
526622
<Docs>
527623
<param name="index">The zero-based index of the item to remove.</param>
528624
<summary>Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.</summary>
529-
<remarks>To be added.</remarks>
625+
<remarks>
626+
627+
## Remarks
628+
629+
[!INCLUDE[system-json](~/includes/system-json.md)]
630+
631+
</remarks>
530632
</Docs>
531633
</Member>
532634
<Member MemberName="Save">
@@ -554,7 +656,13 @@
554656
<Docs>
555657
<param name="stream">To be added.</param>
556658
<summary>To be added.</summary>
557-
<remarks>To be added.</remarks>
659+
<remarks>
660+
661+
## Remarks
662+
663+
[!INCLUDE[system-json](~/includes/system-json.md)]
664+
665+
</remarks>
558666
</Docs>
559667
</Member>
560668
<Member MemberName="System.Collections.Generic.IEnumerable&lt;System.Json.JsonValue&gt;.GetEnumerator">
@@ -583,7 +691,13 @@
583691
<Docs>
584692
<summary>Returns an enumerator that iterates through the collection.</summary>
585693
<returns>An enumerator that can be used to iterate through the collection.</returns>
586-
<remarks>To be added.</remarks>
694+
<remarks>
695+
696+
## Remarks
697+
698+
[!INCLUDE[system-json](~/includes/system-json.md)]
699+
700+
</remarks>
587701
</Docs>
588702
</Member>
589703
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">

0 commit comments

Comments
 (0)