From 13eb22696973d1cd424061f477c8a1e409405c83 Mon Sep 17 00:00:00 2001 From: Buyaa Namnan Date: Tue, 8 Oct 2024 16:16:55 -0700 Subject: [PATCH 1/2] Add remaining missing .NET 9 docs for System.Collections --- ...ncurrentDictionary`2+AlternateLookup`1.xml | 2 ++ .../FrozenDictionary`2+AlternateLookup`1.xml | 2 ++ .../FrozenSet`1+AlternateLookup`1.xml | 1 + .../Dictionary`2+AlternateLookup`1.xml | 6 ++++-- .../Dictionary`2.xml | 19 ++++++++++--------- .../HashSet`1+AlternateLookup`1.xml | 1 + xml/System.Collections.Generic/HashSet`1.xml | 18 +++++++++--------- 7 files changed, 29 insertions(+), 20 deletions(-) diff --git a/xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml b/xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml index b1fc4e7d9bb..db517281625 100644 --- a/xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml +++ b/xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml @@ -32,6 +32,8 @@ + The type of the keys in the dictionary. + The type of the values in the dictionary. The alternate type of a key for performing lookups. Provides a type that may be used to perform operations on a diff --git a/xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml b/xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml index 94eb94600dd..da6fdde54ba 100644 --- a/xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml +++ b/xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml @@ -36,6 +36,8 @@ + The type of the keys in the dictionary. + The type of the values in the dictionary. The alternate type of a key for performing lookups. Provides a type that may be used to perform operations on a diff --git a/xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml b/xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml index c23782600df..50477340e18 100644 --- a/xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml +++ b/xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml @@ -42,6 +42,7 @@ + The type of the values in this set. The alternate type of a key for performing lookups. Provides a type that may be used to perform operations on a diff --git a/xml/System.Collections.Generic/Dictionary`2+AlternateLookup`1.xml b/xml/System.Collections.Generic/Dictionary`2+AlternateLookup`1.xml index 758a01fc686..c46f8350ae6 100644 --- a/xml/System.Collections.Generic/Dictionary`2+AlternateLookup`1.xml +++ b/xml/System.Collections.Generic/Dictionary`2+AlternateLookup`1.xml @@ -32,6 +32,8 @@ + The type of the keys in the dictionary. + The type of the values in the dictionary. The alternate type of a key for performing lookups. Provides a type that can be used to perform operations on a using a as a key instead of a . To be added. @@ -227,7 +229,7 @@ The alternate key of the value to get. 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. Gets the value associated with the specified alternate key. - To be added. + if an entry was found; otherwise, . To be added. is . @@ -258,7 +260,7 @@ 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. 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. Gets the value associated with the specified alternate key. - To be added. + if an entry was found; otherwise, . To be added. is . diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index 8eff5ef4ab2..87016a343c3 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -1302,10 +1302,11 @@ - To be added. - To be added. - To be added. - To be added. + The alternate type of a key for performing lookups. + Gets an instance of a type that may be used to perform operations on the current using a as a key instead of a . + The created lookup instance. + The dictionary must be using a comparer that implements with and . If it doesn't, an exception will be thrown. + The dictionary's comparer is not compatible with . @@ -3410,11 +3411,11 @@ Unlike the method, this - To be added. - To be added. - To be added. - To be added. - To be added. + The alternate type of a key for performing lookups. + The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false. + Gets an instance of a type that may be used to perform operations on the current using a as a key instead of a . + if a lookup could be created; otherwise, . + The dictionary must be using a comparer that implements with and . If it doesn't, the method will return false. diff --git a/xml/System.Collections.Generic/HashSet`1+AlternateLookup`1.xml b/xml/System.Collections.Generic/HashSet`1+AlternateLookup`1.xml index de947375376..ad92030127f 100644 --- a/xml/System.Collections.Generic/HashSet`1+AlternateLookup`1.xml +++ b/xml/System.Collections.Generic/HashSet`1+AlternateLookup`1.xml @@ -31,6 +31,7 @@ + The type of elements in the hash set. The alternate type of instance for performing lookups. Provides a type that can be used to perform operations on a using a instead of a . To be added. diff --git a/xml/System.Collections.Generic/HashSet`1.xml b/xml/System.Collections.Generic/HashSet`1.xml index bb730289027..87672b38f14 100644 --- a/xml/System.Collections.Generic/HashSet`1.xml +++ b/xml/System.Collections.Generic/HashSet`1.xml @@ -1309,10 +1309,10 @@ The following example demonstrates how to merge two disparate sets. This example - To be added. - To be added. - To be added. - To be added. + The alternate type of instance for performing lookups. + Gets an instance of a type that may be used to perform operations on the current using a instead of a . + The created lookup instance. + The set must be using a comparer that implements with and . If it doesn't, an exception will be thrown. @@ -2623,11 +2623,11 @@ The following example demonstrates how to merge two disparate sets. This example - To be added. - To be added. - To be added. - To be added. - To be added. + The alternate type of instance for performing lookups. + The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false. + Gets an instance of a type that may be used to perform operations on the current using a instead of a . + if a lookup could be created; otherwise, . + The set must be using a comparer that implements with and . If it doesn't, the method returns false. From 167cbc99dfddec4a0aeeecab24a44d9e9711e688 Mon Sep 17 00:00:00 2001 From: Buyaa Namnan Date: Wed, 9 Oct 2024 08:54:43 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Collections.Generic/Dictionary`2.xml | 8 ++++---- xml/System.Collections.Generic/HashSet`1.xml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index 87016a343c3..70550e4d8dc 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -1303,9 +1303,9 @@ The alternate type of a key for performing lookups. - Gets an instance of a type that may be used to perform operations on the current using a as a key instead of a . + Gets an instance of a type that can be used to perform operations on the current using a as a key instead of a . The created lookup instance. - The dictionary must be using a comparer that implements with and . If it doesn't, an exception will be thrown. + The dictionary must use a comparer that implements with and . If it doesn't, an exception is thrown. The dictionary's comparer is not compatible with . @@ -3413,9 +3413,9 @@ Unlike the method, this The alternate type of a key for performing lookups. The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false. - Gets an instance of a type that may be used to perform operations on the current using a as a key instead of a . + Gets an instance of a type that can be used to perform operations on the current using a as a key instead of a . if a lookup could be created; otherwise, . - The dictionary must be using a comparer that implements with and . If it doesn't, the method will return false. + The dictionary must use a comparer that implements with and . If it doesn't, the method returns . diff --git a/xml/System.Collections.Generic/HashSet`1.xml b/xml/System.Collections.Generic/HashSet`1.xml index 87672b38f14..44d24628002 100644 --- a/xml/System.Collections.Generic/HashSet`1.xml +++ b/xml/System.Collections.Generic/HashSet`1.xml @@ -1310,9 +1310,9 @@ The following example demonstrates how to merge two disparate sets. This example The alternate type of instance for performing lookups. - Gets an instance of a type that may be used to perform operations on the current using a instead of a . + Gets an instance of a type that can be used to perform operations on the current using a instead of a . The created lookup instance. - The set must be using a comparer that implements with and . If it doesn't, an exception will be thrown. + The set must use a comparer that implements with and . If it doesn't, an exception is thrown. @@ -2625,9 +2625,9 @@ The following example demonstrates how to merge two disparate sets. This example The alternate type of instance for performing lookups. The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false. - Gets an instance of a type that may be used to perform operations on the current using a instead of a . + Gets an instance of a type that can be used to perform operations on the current using a instead of a . if a lookup could be created; otherwise, . - The set must be using a comparer that implements with and . If it doesn't, the method returns false. + The set must use a comparer that implements with and . If it doesn't, the method returns .