Skip to content

Commit 92d0aaa

Browse files
buyaa-ngewarren
buyaa-n
and
gewarren
authored
Add remaining missing .NET 9 docs for System.Collections (#10520)
* Add remaining missing .NET 9 docs for System.Collections * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent ca580c2 commit 92d0aaa

File tree

7 files changed

+29
-20
lines changed

7 files changed

+29
-20
lines changed

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
</Attribute>
3333
</Attributes>
3434
<Docs>
35+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
36+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
3537
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
3638
<summary>
3739
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /></para>

‎xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636
</Attribute>
3737
</Attributes>
3838
<Docs>
39+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
40+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
3941
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
4042
<summary>
4143
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /></para>

‎xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
</Attribute>
4343
</Attributes>
4444
<Docs>
45+
<typeparam name="T">The type of the values in this set.</typeparam>
4546
<typeparam name="TAlternate">The alternate type of a key for performing lookups.</typeparam>
4647
<summary>
4748
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /></para>

‎xml/System.Collections.Generic/Dictionary`2+AlternateLookup`1.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
</Attribute>
3333
</Attributes>
3434
<Docs>
35+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
36+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
3537
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
3638
<summary>Provides a type that can be used to perform operations on a <see cref="T:System.Collections.Generic.Dictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</summary>
3739
<remarks>To be added.</remarks>
@@ -227,7 +229,7 @@
227229
<param name="key">The alternate key of the value to get.</param>
228230
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.</param>
229231
<summary>Gets the value associated with the specified alternate key.</summary>
230-
<returns>To be added.</returns>
232+
<returns><see langword="true"/> if an entry was found; otherwise, <see langword="false"/>.</returns>
231233
<remarks>To be added.</remarks>
232234
<exception cref="T:System.ArgumentNullException">
233235
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -258,7 +260,7 @@
258260
<param name="actualKey">When this method returns, contains the actual key associated with the alternate key, if the key is found; otherwise, the default value for the type of the key parameter.</param>
259261
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.</param>
260262
<summary>Gets the value associated with the specified alternate key.</summary>
261-
<returns>To be added.</returns>
263+
<returns><see langword="true"/> if an entry was found; otherwise, <see langword="false"/>.</returns>
262264
<remarks>To be added.</remarks>
263265
<exception cref="T:System.ArgumentNullException">
264266
<paramref name="key" /> is <see langword="null" />.</exception>

‎xml/System.Collections.Generic/Dictionary`2.xml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1302,10 +1302,11 @@
13021302
</TypeParameters>
13031303
<Parameters />
13041304
<Docs>
1305-
<typeparam name="TAlternateKey">To be added.</typeparam>
1306-
<summary>To be added.</summary>
1307-
<returns>To be added.</returns>
1308-
<remarks>To be added.</remarks>
1305+
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
1306+
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.Dictionary`2"/> using a <typeparamref name="TAlternateKey"/> as a key instead of a <typeparamref name="TKey"/>.</summary>
1307+
<returns>The created lookup instance.</returns>
1308+
<remarks>The dictionary must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with <typeparamref name="TAlternateKey"/> and <typeparamref name="TKey"/>. If it doesn't, an exception is thrown.</remarks>
1309+
<exception cref="T:System.InvalidOperationException">The dictionary's comparer is not compatible with <typeparamref name="TAlternateKey"/>.</exception>
13091310
</Docs>
13101311
</Member>
13111312
<Member MemberName="GetEnumerator">
@@ -3410,11 +3411,11 @@ Unlike the <xref:System.Collections.Generic.Dictionary%602.Add%2A> method, this
34103411
</Parameter>
34113412
</Parameters>
34123413
<Docs>
3413-
<typeparam name="TAlternateKey">To be added.</typeparam>
3414-
<param name="lookup">To be added.</param>
3415-
<summary>To be added.</summary>
3416-
<returns>To be added.</returns>
3417-
<remarks>To be added.</remarks>
3414+
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
3415+
<param name="lookup">The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false.</param>
3416+
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.Dictionary`2"/> using a <typeparamref name="TAlternateKey"/> as a key instead of a <typeparamref name="TKey"/>.</summary>
3417+
<returns><see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
3418+
<remarks>The dictionary must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with <typeparamref name="TAlternateKey"/> and <typeparamref name="TKey"/>. If it doesn't, the method returns <see langword="false" />.</remarks>
34183419
</Docs>
34193420
</Member>
34203421
<Member MemberName="TryGetValue">

‎xml/System.Collections.Generic/HashSet`1+AlternateLookup`1.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
</Attribute>
3232
</Attributes>
3333
<Docs>
34+
<typeparam name="T">The type of elements in the hash set.</typeparam>
3435
<typeparam name="TAlternate">The alternate type of instance for performing lookups.</typeparam>
3536
<summary>Provides a type that can be used to perform operations on a <see cref="T:System.Collections.Generic.HashSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</summary>
3637
<remarks>To be added.</remarks>

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,10 +1309,10 @@ The following example demonstrates how to merge two disparate sets. This example
13091309
</TypeParameters>
13101310
<Parameters />
13111311
<Docs>
1312-
<typeparam name="TAlternate">To be added.</typeparam>
1313-
<summary>To be added.</summary>
1314-
<returns>To be added.</returns>
1315-
<remarks>To be added.</remarks>
1312+
<typeparam name="TAlternate">The alternate type of instance for performing lookups.</typeparam>
1313+
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1"/> using a <typeparamref name="TAlternate"/> instead of a <typeparamref name="T"/>.</summary>
1314+
<returns>The created lookup instance.</returns>
1315+
<remarks>The set must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with <typeparamref name="TAlternate"/> and <typeparamref name="T"/>. If it doesn't, an exception is thrown.</remarks>
13161316
</Docs>
13171317
</Member>
13181318
<Member MemberName="GetEnumerator">
@@ -2623,11 +2623,11 @@ The following example demonstrates how to merge two disparate sets. This example
26232623
</Parameter>
26242624
</Parameters>
26252625
<Docs>
2626-
<typeparam name="TAlternate">To be added.</typeparam>
2627-
<param name="lookup">To be added.</param>
2628-
<summary>To be added.</summary>
2629-
<returns>To be added.</returns>
2630-
<remarks>To be added.</remarks>
2626+
<typeparam name="TAlternate">The alternate type of instance for performing lookups.</typeparam>
2627+
<param name="lookup">The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false.</param>
2628+
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1"/> using a <typeparamref name="TAlternate"/> instead of a <typeparamref name="T"/>.</summary>
2629+
<returns><see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
2630+
<remarks>The set must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with <typeparamref name="TAlternate"/> and <typeparamref name="T"/>. If it doesn't, the method returns <see langword="false" />.</remarks>
26312631
</Docs>
26322632
</Member>
26332633
<Member MemberName="TryGetValue">

0 commit comments

Comments
 (0)