Skip to content

Commit 0adbe58

Browse files
ericstjgewarren
ericstj
and
gewarren
authored
Net10 docs update (#11847)
* System.CodeDom docs * System.Collections docs * System.Diagnostics.CodeAnalysis docs * System.Globalization docs * System.IO docs * System.Net.Http docs * System.Numerics.Tensors docs * System.Numerics docs * System.Reflection docs * System.Runtime.CompilerServices docs * System.Runtime.ExceptionServices docs * System.Runtime.InteropServices docs * System.Runtime.Intrinsics docs * System.Security.Cryptography docs * System.Text.Json docs * System.Text docs * System.Threading docs * System docs * Workaround https://dev.azure.com/ceapex/Engineering/_workitems/edit/1082237 * Workaround https://dev.azure.com/ceapex/Engineering/_workitems/edit/1055155/?view=edit * Undo changes that added inheritdoc for internal type ISimdVector`2 * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * memory extensions * system.security.cryptography * cryptography angle bracket and para cleanup * memoryextensions param description improvements * self review * final fix * fix build errors * fix build error * Update xml/System.Runtime.CompilerServices/ExtensionMarkerAttribute.xml * Apply feedback from review * Fix langword references * Fix a couple more syntax issues. * Fix up mangled function signatures in Sve --------- Co-authored-by: Genevieve Warren <[email protected]>
1 parent 04bcfa7 commit 0adbe58

File tree

191 files changed

+11572
-5101
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+11572
-5101
lines changed

‎xml/System.CodeDom.Compiler/IndentedTextWriter.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,7 @@
350350
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
351351
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous dispose operation.</returns>
352352
<remarks>To be added.</remarks>
353+
<inheritdoc />
353354
</Docs>
354355
</Member>
355356
<Member MemberName="Encoding">
@@ -486,6 +487,7 @@
486487
<summary>Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously and causes any buffered data to be written to the underlying device.</summary>
487488
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.</returns>
488489
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.CodeDom.Compiler.IndentedTextWriter.Flush" />.</remarks>
490+
<inheritdoc />
489491
</Docs>
490492
</Member>
491493
<Member MemberName="FlushAsync">
@@ -2682,6 +2684,7 @@
26822684
<summary>Asynchronously writes the line terminator to the underlying <see cref="T:System.IO.TextWriter" />.</summary>
26832685
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous line writing operation.</returns>
26842686
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.CodeDom.Compiler.IndentedTextWriter.WriteLine" />.</remarks>
2687+
<inheritdoc />
26852688
</Docs>
26862689
</Member>
26872690
<Member MemberName="WriteLineAsync">

‎xml/System.Collections.Generic/CollectionExtensions.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,15 @@
179179
<Parameter Name="set" Type="System.Collections.Generic.ISet&lt;T&gt;" Index="0" FrameworkAlternate="net-10.0" RefType="this" />
180180
</Parameters>
181181
<Docs>
182-
<typeparam name="T">To be added.</typeparam>
183-
<param name="set">To be added.</param>
184-
<summary>To be added.</summary>
185-
<returns>To be added.</returns>
182+
<typeparam name="T">The type of elements in the set.</typeparam>
183+
<param name="set">The set to wrap.</param>
184+
<summary>
185+
<para>Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlySet`1" /> wrapper for the specified set.</para>
186+
</summary>
187+
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.ISet`1" />.</returns>
186188
<remarks>To be added.</remarks>
189+
<exception cref="T:System.ArgumentNullException">
190+
<paramref name="set" /> is <see langword="null" />.</exception>
187191
</Docs>
188192
</Member>
189193
<Member MemberName="AsReadOnly&lt;TKey,TValue&gt;">

‎xml/System.Collections.Generic/Queue`1.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1200,6 +1200,7 @@
12001200
]]></format>
12011201
</remarks>
12021202
<altmember cref="P:System.Collections.ICollection.SyncRoot" />
1203+
<inheritdoc cref="P:System.Collections.ICollection.IsSynchronized" />
12031204
</Docs>
12041205
</Member>
12051206
<Member MemberName="System.Collections.ICollection.SyncRoot">

‎xml/System.Collections.ObjectModel/ReadOnlyCollection.xml‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Provides static methods for read-only collections.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -68,10 +68,13 @@
6868
</Parameter>
6969
</Parameters>
7070
<Docs>
71-
<typeparam name="T">To be added.</typeparam>
72-
<param name="values">To be added.</param>
73-
<summary>To be added.</summary>
74-
<returns>To be added.</returns>
71+
<typeparam name="T">The type of elements in the collection.</typeparam>
72+
<param name="values">The span of values to include in the collection.</param>
73+
<summary>
74+
<para>Creates a new <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> from the specified span of values.</para>
75+
<para>This method (simplifies collection initialization)[https://learn.microsoft.com/dotnet/csharp/language-reference/operators/collection-expressions] to create a new <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> with the specified values.</para>
76+
</summary>
77+
<returns>A new <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> containing the specified values.</returns>
7578
<remarks>To be added.</remarks>
7679
</Docs>
7780
</Member>
@@ -119,10 +122,13 @@
119122
</Parameter>
120123
</Parameters>
121124
<Docs>
122-
<typeparam name="T">To be added.</typeparam>
123-
<param name="values">To be added.</param>
124-
<summary>To be added.</summary>
125-
<returns>To be added.</returns>
125+
<typeparam name="T">The type of elements in the collection.</typeparam>
126+
<param name="values">The span of values to include in the collection.</param>
127+
<summary>
128+
<para>Creates a new <see cref="T:System.Collections.ObjectModel.ReadOnlySet`1" /> from the specified span of values.</para>
129+
<para>This method (simplifies collection initialization)[https://learn.microsoft.com/dotnet/csharp/language-reference/operators/collection-expressions] to create a new <see cref="T:System.Collections.ObjectModel.ReadOnlySet`1" /> with the specified values.</para>
130+
</summary>
131+
<returns>A new <see cref="T:System.Collections.ObjectModel.ReadOnlySet`1" /> containing the specified values.</returns>
126132
<remarks>To be added.</remarks>
127133
</Docs>
128134
</Member>

‎xml/System.Collections.ObjectModel/ReadOnlySet`1.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
<returns>
126126
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
127127
<remarks>To be added.</remarks>
128+
<inheritdoc />
128129
</Docs>
129130
</Member>
130131
<Member MemberName="Count">
@@ -790,6 +791,7 @@
790791
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
791792
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
792793
<remarks>To be added.</remarks>
794+
<inheritdoc />
793795
</Docs>
794796
</Member>
795797
<Member MemberName="System.Collections.ICollection.IsSynchronized">
@@ -819,6 +821,7 @@
819821
<value>
820822
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
821823
<remarks>This member is an explicit interface member implementation. It can be used only when the &lt;xref:System.Collections.ObjectModel.ReadOnlySet`1&gt; instance is cast to an &lt;xref:System.Collections.ICollection&gt; interface.</remarks>
824+
<inheritdoc />
822825
</Docs>
823826
</Member>
824827
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -847,6 +850,7 @@
847850
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
848851
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
849852
<remarks>This member is an explicit interface member implementation. It can be used only when the &lt;xref:System.Collections.ObjectModel.ReadOnlySet`1&gt; instance is cast to an &lt;xref:System.Collections.ICollection&gt; interface.</remarks>
853+
<inheritdoc />
850854
</Docs>
851855
</Member>
852856
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -876,6 +880,7 @@
876880
<summary>Returns an enumerator that iterates through a collection.</summary>
877881
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
878882
<remarks>This member is an explicit interface member implementation. It can be used only when the &lt;xref:System.Collections.ObjectModel.ReadOnlySet`1&gt; instance is cast to an &lt;xref:System.Collections.IEnumerable&gt; interface.</remarks>
883+
<inheritdoc />
879884
</Docs>
880885
</Member>
881886
</Members>

‎xml/System.Collections/BitArray.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -639,6 +639,7 @@
639639
The number of elements in the source <see cref="T:System.Collections.BitArray" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
640640
<exception cref="T:System.InvalidCastException">The type of the source <see cref="T:System.Collections.BitArray" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>
641641
<altmember cref="T:System.Array" />
642+
<inheritdoc />
642643
</Docs>
643644
</Member>
644645
<Member MemberName="Count">

‎xml/System.Diagnostics.CodeAnalysis/DynamicallyAccessedMemberTypes.xml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
</ReturnValue>
7979
<MemberValue>1064967</MemberValue>
8080
<Docs>
81-
<summary>To be added.</summary>
81+
<summary>Specifies all constructors, including those inherited from base classes.</summary>
8282
</Docs>
8383
</Member>
8484
<Member MemberName="AllEvents">
@@ -98,7 +98,7 @@
9898
</ReturnValue>
9999
<MemberValue>530432</MemberValue>
100100
<Docs>
101-
<summary>To be added.</summary>
101+
<summary>Specifies all events, including those inherited from base classes.</summary>
102102
</Docs>
103103
</Member>
104104
<Member MemberName="AllFields">
@@ -118,7 +118,7 @@
118118
</ReturnValue>
119119
<MemberValue>65632</MemberValue>
120120
<Docs>
121-
<summary>To be added.</summary>
121+
<summary>Specifies all fields, including those inherited from base classes.</summary>
122122
</Docs>
123123
</Member>
124124
<Member MemberName="AllMethods">
@@ -138,7 +138,7 @@
138138
</ReturnValue>
139139
<MemberValue>32792</MemberValue>
140140
<Docs>
141-
<summary>To be added.</summary>
141+
<summary>Specifies all methods, including those inherited from base classes.</summary>
142142
</Docs>
143143
</Member>
144144
<Member MemberName="AllNestedTypes">
@@ -158,7 +158,7 @@
158158
</ReturnValue>
159159
<MemberValue>2228608</MemberValue>
160160
<Docs>
161-
<summary>To be added.</summary>
161+
<summary>Specifies all nested types, including those inherited from base classes.</summary>
162162
</Docs>
163163
</Member>
164164
<Member MemberName="AllProperties">
@@ -178,7 +178,7 @@
178178
</ReturnValue>
179179
<MemberValue>263680</MemberValue>
180180
<Docs>
181-
<summary>To be added.</summary>
181+
<summary>Specifies all properties, including those inherited from base classes.</summary>
182182
</Docs>
183183
</Member>
184184
<Member MemberName="Interfaces">
@@ -274,7 +274,7 @@
274274
</ReturnValue>
275275
<MemberValue>16388</MemberValue>
276276
<Docs>
277-
<summary>To be added.</summary>
277+
<summary>Specifies all non-public constructors, including those inherited from base classes.</summary>
278278
</Docs>
279279
</Member>
280280
<Member MemberName="NonPublicEvents">
@@ -320,7 +320,7 @@
320320
</ReturnValue>
321321
<MemberValue>528384</MemberValue>
322322
<Docs>
323-
<summary>To be added.</summary>
323+
<summary>Specifies all non-public events, including those inherited from base classes.</summary>
324324
</Docs>
325325
</Member>
326326
<Member MemberName="NonPublicFields">
@@ -366,7 +366,7 @@
366366
</ReturnValue>
367367
<MemberValue>65600</MemberValue>
368368
<Docs>
369-
<summary>To be added.</summary>
369+
<summary>Specifies all non-public fields, including those inherited from base classes.</summary>
370370
</Docs>
371371
</Member>
372372
<Member MemberName="NonPublicMethods">
@@ -412,7 +412,7 @@
412412
</ReturnValue>
413413
<MemberValue>32784</MemberValue>
414414
<Docs>
415-
<summary>To be added.</summary>
415+
<summary>Specifies all non-public methods, including those inherited from base classes.</summary>
416416
</Docs>
417417
</Member>
418418
<Member MemberName="NonPublicNestedTypes">
@@ -458,7 +458,7 @@
458458
</ReturnValue>
459459
<MemberValue>131328</MemberValue>
460460
<Docs>
461-
<summary>To be added.</summary>
461+
<summary>Specifies all non-public nested types, including those inherited from base classes.</summary>
462462
</Docs>
463463
</Member>
464464
<Member MemberName="NonPublicProperties">
@@ -504,7 +504,7 @@
504504
</ReturnValue>
505505
<MemberValue>263168</MemberValue>
506506
<Docs>
507-
<summary>To be added.</summary>
507+
<summary>Specifies all non-public properties, including those inherited from base classes.</summary>
508508
</Docs>
509509
</Member>
510510
<Member MemberName="PublicConstructors">
@@ -550,7 +550,7 @@
550550
</ReturnValue>
551551
<MemberValue>1048579</MemberValue>
552552
<Docs>
553-
<summary>To be added.</summary>
553+
<summary>Specifies all public constructors, including those inherited from base classes.</summary>
554554
</Docs>
555555
</Member>
556556
<Member MemberName="PublicEvents">
@@ -674,7 +674,7 @@
674674
</ReturnValue>
675675
<MemberValue>2097280</MemberValue>
676676
<Docs>
677-
<summary>To be added.</summary>
677+
<summary>Specifies all public nested types, including those inherited from base classes.</summary>
678678
</Docs>
679679
</Member>
680680
<Member MemberName="PublicParameterlessConstructor">

‎xml/System.Diagnostics.CodeAnalysis/ExperimentalAttribute.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ the warnings or errors, if needed.
116116
<ReturnType>System.String</ReturnType>
117117
</ReturnValue>
118118
<Docs>
119-
<summary>To be added.</summary>
120-
<value>To be added.</value>
121-
<remarks>To be added.</remarks>
119+
<summary>Gets or sets an optional message associated with the experimental attribute.</summary>
120+
<value>The message that provides additional information about the experimental feature.</value>
121+
<remarks>This message can be used to provide more context or guidance about the experimental feature.</remarks>
122122
</Docs>
123123
</Member>
124124
<Member MemberName="UrlFormat">

‎xml/System.Diagnostics.CodeAnalysis/RequiresDynamicCodeAttribute.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ For more information, see [Introduction to AOT warnings](/dotnet/core/deploying/
8181
<ReturnType>System.Boolean</ReturnType>
8282
</ReturnValue>
8383
<Docs>
84-
<summary>To be added.</summary>
84+
<summary>Gets or sets a value that indicates whether the annotation should apply to static members.</summary>
8585
<value>To be added.</value>
8686
<remarks>To be added.</remarks>
8787
</Docs>

‎xml/System.Diagnostics.CodeAnalysis/RequiresUnreferencedCodeAttribute.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ This attribute allows tools to understand which methods are unsafe to call when
8989
<ReturnType>System.Boolean</ReturnType>
9090
</ReturnValue>
9191
<Docs>
92-
<summary>To be added.</summary>
92+
<summary>Gets or sets a value that indicates whether the annotation should apply to static members.</summary>
9393
<value>To be added.</value>
9494
<remarks>To be added.</remarks>
9595
</Docs>

0 commit comments

Comments
 (0)