Skip to content

Commit ee75c3e

Browse files
eiriktsarpaliseiriktsarpalis
authored
Merge pull request #6960 from dotnet/upd.collections
Doc updates for collections
2 parents 2723e91 + 07540cf commit ee75c3e

8 files changed

+220
-95
lines changed

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -719,9 +719,20 @@
719719
<ReturnType>System.Collections.Generic.IEqualityComparer&lt;TKey&gt;</ReturnType>
720720
</ReturnValue>
721721
<Docs>
722-
<summary>To be added.</summary>
723-
<value>To be added.</value>
724-
<remarks>To be added.</remarks>
722+
<summary>Gets the <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> that is used to determine equality of keys for the dictionary.</summary>
723+
<value>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> generic interface implementation that is used to determine equality of keys for the current <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> and to provide hash values for the keys.</value>
724+
<remarks>
725+
<format type="text/markdown"><![CDATA[
726+
727+
## Remarks
728+
729+
<xref:System.Collections.Concurrent.ConcurrentDictionary`2> requires an equality implementation to determine
730+
whether keys are equal. You can specify an implementation of the <xref:System.Collections.Generic.IEqualityComparer`1>
731+
generic interface by using a constructor that accepts a comparer parameter;
732+
if you do not specify one, the default generic equality comparer <xref:System.Collections.Generic.EqualityComparer`1.Default> is used.
733+
734+
]]></format>
735+
</remarks>
725736
</Docs>
726737
</Member>
727738
<Member MemberName="ContainsKey">

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1418,8 +1418,9 @@
14181418
<Parameter Name="capacity" Type="System.Int32" Index="0" FrameworkAlternate="net-6.0" />
14191419
</Parameters>
14201420
<Docs>
1421-
<param name="capacity">To be added.</param>
1422-
<summary>To be added.</summary>
1421+
<param name="capacity">The minimum capacity to ensure.</param>
1422+
<summary>Ensures that the capacity of this list is at least the specified <paramref name="capacity" />.
1423+
If the current capacity of the list is less than specified <paramref name="capacity" />, the capacity is increased by continuously twice current capacity until it is at least the specified <paramref name="capacity" />.</summary>
14231424
<returns>To be added.</returns>
14241425
<remarks>To be added.</remarks>
14251426
</Docs>

‎xml/System.Collections.Generic/PriorityQueue`2+UnorderedItemsCollection+Enumerator.xml

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
</Interface>
2929
</Interfaces>
3030
<Docs>
31-
<summary>To be added.</summary>
31+
<summary>Enumerates the element and priority pairs of a <see cref="T:System.Collections.Generic.PriorityQueue`2" />, without any ordering guarantees.</summary>
3232
<remarks>To be added.</remarks>
3333
</Docs>
3434
<Members>
@@ -57,7 +57,7 @@
5757
<ReturnType>System.ValueTuple&lt;TElement,TPriority&gt;</ReturnType>
5858
</ReturnValue>
5959
<Docs>
60-
<summary>To be added.</summary>
60+
<summary>Gets the element at the current position of the enumerator.</summary>
6161
<value>To be added.</value>
6262
<remarks>To be added.</remarks>
6363
</Docs>
@@ -82,7 +82,7 @@
8282
</ReturnValue>
8383
<Parameters />
8484
<Docs>
85-
<summary>To be added.</summary>
85+
<summary>Releases all resources used by the <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator" />.</summary>
8686
<remarks>To be added.</remarks>
8787
</Docs>
8888
</Member>
@@ -106,8 +106,9 @@
106106
</ReturnValue>
107107
<Parameters />
108108
<Docs>
109-
<summary>To be added.</summary>
110-
<returns>To be added.</returns>
109+
<summary>Advances the enumerator to the next element of the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</summary>
110+
<returns>
111+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
111112
<remarks>To be added.</remarks>
112113
</Docs>
113114
</Member>
@@ -136,8 +137,8 @@
136137
<ReturnType>System.ValueTuple&lt;TElement,TPriority&gt;</ReturnType>
137138
</ReturnValue>
138139
<Docs>
139-
<summary>To be added.</summary>
140-
<value>To be added.</value>
140+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
141+
<value>The element in the collection at the current position of the enumerator.</value>
141142
<remarks>To be added.</remarks>
142143
</Docs>
143144
</Member>
@@ -160,9 +161,17 @@
160161
<ReturnType>System.Object</ReturnType>
161162
</ReturnValue>
162163
<Docs>
163-
<summary>To be added.</summary>
164-
<value>To be added.</value>
165-
<remarks>To be added.</remarks>
164+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
165+
<value>The element in the collection at the current position of the enumerator.</value>
166+
<remarks>
167+
<format type="text/markdown"><![CDATA[
168+
169+
## Remarks
170+
171+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
172+
173+
]]></format>
174+
</remarks>
166175
</Docs>
167176
</Member>
168177
<Member MemberName="System.Collections.IEnumerator.Reset">
@@ -185,8 +194,16 @@
185194
</ReturnValue>
186195
<Parameters />
187196
<Docs>
188-
<summary>To be added.</summary>
189-
<remarks>To be added.</remarks>
197+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
198+
<remarks>
199+
<format type="text/markdown"><![CDATA[
200+
201+
## Remarks
202+
203+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
204+
205+
]]></format>
206+
</remarks>
190207
</Docs>
191208
</Member>
192209
</Members>

‎xml/System.Collections.Generic/PriorityQueue`2+UnorderedItemsCollection.xml

Lines changed: 44 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</Interface>
3535
</Interfaces>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>Enumerates the contents of a <see cref="T:System.Collections.Generic.PriorityQueue`2" />, without any ordering guarantees.</summary>
3838
<remarks>To be added.</remarks>
3939
</Docs>
4040
<Members>
@@ -58,8 +58,8 @@
5858
<ReturnType>System.Int32</ReturnType>
5959
</ReturnValue>
6060
<Docs>
61-
<summary>To be added.</summary>
62-
<value>To be added.</value>
61+
<summary>Gets the number of elements in the collection.</summary>
62+
<value>The number of elements in the collection.</value>
6363
<remarks>To be added.</remarks>
6464
</Docs>
6565
</Member>
@@ -80,8 +80,8 @@
8080
</ReturnValue>
8181
<Parameters />
8282
<Docs>
83-
<summary>To be added.</summary>
84-
<returns>To be added.</returns>
83+
<summary>Returns an enumerator that iterates through the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</summary>
84+
<returns>An <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator" /> for the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</returns>
8585
<remarks>To be added.</remarks>
8686
</Docs>
8787
</Member>
@@ -111,8 +111,8 @@
111111
</ReturnValue>
112112
<Parameters />
113113
<Docs>
114-
<summary>To be added.</summary>
115-
<returns>To be added.</returns>
114+
<summary>Returns an enumerator that iterates through the collection.</summary>
115+
<returns>An enumerator that can be used to iterate through the collection.</returns>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>
@@ -139,9 +139,9 @@
139139
<Parameter Name="index" Type="System.Int32" />
140140
</Parameters>
141141
<Docs>
142-
<param name="array">To be added.</param>
143-
<param name="index">To be added.</param>
144-
<summary>To be added.</summary>
142+
<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.ICollection" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
143+
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
144+
<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>
145145
<remarks>To be added.</remarks>
146146
</Docs>
147147
</Member>
@@ -164,9 +164,18 @@
164164
<ReturnType>System.Boolean</ReturnType>
165165
</ReturnValue>
166166
<Docs>
167-
<summary>To be added.</summary>
168-
<value>To be added.</value>
169-
<remarks>To be added.</remarks>
167+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
168+
<value>
169+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
170+
<remarks>
171+
<format type="text/markdown"><![CDATA[
172+
173+
## Remarks
174+
175+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
176+
177+
]]></format>
178+
</remarks>
170179
</Docs>
171180
</Member>
172181
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -188,9 +197,17 @@
188197
<ReturnType>System.Object</ReturnType>
189198
</ReturnValue>
190199
<Docs>
191-
<summary>To be added.</summary>
192-
<value>To be added.</value>
193-
<remarks>To be added.</remarks>
200+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
201+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
202+
<remarks>
203+
<format type="text/markdown"><![CDATA[
204+
205+
## Remarks
206+
207+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
208+
209+
]]></format>
210+
</remarks>
194211
</Docs>
195212
</Member>
196213
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -213,9 +230,17 @@
213230
</ReturnValue>
214231
<Parameters />
215232
<Docs>
216-
<summary>To be added.</summary>
217-
<returns>To be added.</returns>
218-
<remarks>To be added.</remarks>
233+
<summary>Returns an enumerator that iterates through a collection.</summary>
234+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
235+
<remarks>
236+
<format type="text/markdown"><![CDATA[
237+
238+
## Remarks
239+
240+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
241+
242+
]]></format>
243+
</remarks>
219244
</Docs>
220245
</Member>
221246
</Members>

0 commit comments

Comments
 (0)