Skip to content

Commit 741d9bd

Browse files
committed
System.Collections docs
1 parent a4dc410 commit 741d9bd

File tree

5 files changed

+30
-13
lines changed

5 files changed

+30
-13
lines changed

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)[/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)[/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">

0 commit comments

Comments
 (0)