From f98df66a1c6300add05e50d0b1a11d03eecce1e5 Mon Sep 17 00:00:00 2001 From: Layomi Akinrinade Date: Thu, 16 Apr 2020 22:43:40 -0700 Subject: [PATCH 1/4] Add missing docs for System.Collections[.Generic] --- .../Dictionary`2.xml | 21 ++++---- .../KeyValuePair`2.xml | 8 +-- xml/System.Collections.Generic/Queue`1.xml | 16 +++--- .../ReferenceEqualityComparer.xml | 53 +++++++++++++----- xml/System.Collections.Generic/Stack`1.xml | 16 +++--- xml/System.Collections/BitArray.xml | 54 +++++++++++++++---- xml/System.Collections/DictionaryEntry.xml | 8 +-- 7 files changed, 120 insertions(+), 56 deletions(-) diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index aa1e1157769..327aa958f7e 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -1,4 +1,4 @@ - + @@ -331,8 +331,8 @@ - To be added. - To be added. + The whose elements are copied to the new . + Initializes a new instance of the class that contains elements copied from the specified . To be added. @@ -567,9 +567,9 @@ - To be added. - To be added. - To be added. + The whose elements are copied to the new . + The implementation to use when comparing keys, or to use the default for the type of the key. + Initializes a new instance of the class that contains elements copied from the specified and uses the specified . To be added. @@ -1506,10 +1506,11 @@ - To be added. - To be added. - To be added. - To be added. + The key of the element to remove. + The removed element. + Removes the value with the specified key from the , and copies the element to the parameter. + + if the element is successfully found and removed; otherwise, . To be added. diff --git a/xml/System.Collections.Generic/KeyValuePair`2.xml b/xml/System.Collections.Generic/KeyValuePair`2.xml index 9b639718393..ad93f15f07d 100644 --- a/xml/System.Collections.Generic/KeyValuePair`2.xml +++ b/xml/System.Collections.Generic/KeyValuePair`2.xml @@ -1,4 +1,4 @@ - + @@ -159,9 +159,9 @@ - To be added. - To be added. - To be added. + The key of the current . + The value of the current . + Deconstructs the current . To be added. diff --git a/xml/System.Collections.Generic/Queue`1.xml b/xml/System.Collections.Generic/Queue`1.xml index 1eaa2b34c92..5bfd1665086 100644 --- a/xml/System.Collections.Generic/Queue`1.xml +++ b/xml/System.Collections.Generic/Queue`1.xml @@ -1,4 +1,4 @@ - + @@ -1333,9 +1333,10 @@ finally { - To be added. - To be added. - To be added. + The removed object. + Removes the object at the beginning of the , and copies it to the parameter. + + if the object is successfully removed; if the is empty. To be added. @@ -1368,9 +1369,10 @@ finally { - To be added. - To be added. - To be added. + If present, the object at the beginning of the ; otherwise, the default value of . + Returns a value that indicates whether there is an object at the beginning of the , and if one is present, copies it to the parameter. The object is not removed from the . + + if there is an object at the beginning of the ; if the is empty. To be added. diff --git a/xml/System.Collections.Generic/ReferenceEqualityComparer.xml b/xml/System.Collections.Generic/ReferenceEqualityComparer.xml index 8e15b17a4d8..628aa5c7f03 100644 --- a/xml/System.Collections.Generic/ReferenceEqualityComparer.xml +++ b/xml/System.Collections.Generic/ReferenceEqualityComparer.xml @@ -1,4 +1,4 @@ - + @@ -21,8 +21,16 @@ - To be added. - To be added. + An that uses reference equality () instead of value equality () when comparing two object instances. + + type cannot be instantiated. Instead, use the property to access the singleton instance of this type. + + ]]> + @@ -49,11 +57,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first object to compare. + The second object to compare. + Determines whether two object references refer to the same object instance. + + if both and refer to the same object instance or if both are ; otherwise, . + + . + It is not necessarily equivalent to calling . + + ]]> + @@ -79,10 +97,19 @@ - To be added. - To be added. - To be added. - To be added. + The object for which to retrieve the hash code. + Returns a hash code for the specified object. The returned hash code is based on the object identity, not on the contents of the object. + A hash code for the identity of . + + . + It is not necessarily equivalent to calling . + + ]]> + @@ -101,7 +128,7 @@ System.Collections.Generic.ReferenceEqualityComparer - To be added. + Gets the singleton instance. To be added. To be added. diff --git a/xml/System.Collections.Generic/Stack`1.xml b/xml/System.Collections.Generic/Stack`1.xml index dda42c227b2..6481f1b6745 100644 --- a/xml/System.Collections.Generic/Stack`1.xml +++ b/xml/System.Collections.Generic/Stack`1.xml @@ -1,4 +1,4 @@ - + @@ -1367,9 +1367,10 @@ finally { - To be added. - To be added. - To be added. + If present, the object at the top of the ; otherwise, the default value of . + Returns a value that indicates whether there is an object at the top of the , and if one is present, copies it to the parameter. The object is not removed from the . + + if there is an object at the top of the ; if the is empty. To be added. @@ -1402,9 +1403,10 @@ finally { - To be added. - To be added. - To be added. + If present, the object at the top of the ; otherwise, the default value of . + Returns a value that indicates whether there is an object at the top of the , and if one is present, copies it to the parameter, and removes it from the . + + if there is an object at the top of the ; if the is empty. To be added. diff --git a/xml/System.Collections/BitArray.xml b/xml/System.Collections/BitArray.xml index b5629e3de43..1052a913740 100644 --- a/xml/System.Collections/BitArray.xml +++ b/xml/System.Collections/BitArray.xml @@ -1,4 +1,4 @@ - + @@ -959,10 +959,18 @@ - To be added. - To be added. - To be added. - To be added. + The number of shifts to make for each bit. + Shifts all the bit values of the current to the left on bits. + The current . + + is updated and returned. + + ]]> + @@ -1165,10 +1173,18 @@ - To be added. - To be added. - To be added. - To be added. + The number of shifts to make for each bit. + Shifts all the bit values of the current to the right on bits. + The current . + + is updated and returned. + + ]]> + @@ -1454,7 +1470,15 @@ Gets a value that indicates whether access to the is synchronized (thread safe). true if access to the is synchronized (thread safe); otherwise, false. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1485,7 +1509,15 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Collections/DictionaryEntry.xml b/xml/System.Collections/DictionaryEntry.xml index c580fb6d720..37b9d281028 100644 --- a/xml/System.Collections/DictionaryEntry.xml +++ b/xml/System.Collections/DictionaryEntry.xml @@ -1,4 +1,4 @@ - + @@ -165,9 +165,9 @@ The - To be added. - To be added. - To be added. + The key of the current . + The value of the current . + Deconstructs the current . To be added. From d67a3243e2198752d176ec98cfcdec796280df4b Mon Sep 17 00:00:00 2001 From: Layomi Akinrinade Date: Mon, 20 Apr 2020 11:38:42 -0700 Subject: [PATCH 2/4] Add exceptions --- xml/System.Collections.Generic/Dictionary`2.xml | 3 +++ xml/System.Collections.Generic/Queue`1.xml | 1 + xml/System.Collections/BitArray.xml | 2 ++ 3 files changed, 6 insertions(+) diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index 327aa958f7e..8f65bd42e36 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -334,6 +334,7 @@ The whose elements are copied to the new . Initializes a new instance of the class that contains elements copied from the specified . To be added. + contains one or more duplicated keys. @@ -571,6 +572,7 @@ The implementation to use when comparing keys, or to use the default for the type of the key. Initializes a new instance of the class that contains elements copied from the specified and uses the specified . To be added. + contains one or more duplicated keys. @@ -1512,6 +1514,7 @@ if the element is successfully found and removed; otherwise, . To be added. + is . diff --git a/xml/System.Collections.Generic/Queue`1.xml b/xml/System.Collections.Generic/Queue`1.xml index 5bfd1665086..58a35f8227f 100644 --- a/xml/System.Collections.Generic/Queue`1.xml +++ b/xml/System.Collections.Generic/Queue`1.xml @@ -1338,6 +1338,7 @@ finally { if the object is successfully removed; if the is empty. To be added. + is . diff --git a/xml/System.Collections/BitArray.xml b/xml/System.Collections/BitArray.xml index 1052a913740..e6bb7257940 100644 --- a/xml/System.Collections/BitArray.xml +++ b/xml/System.Collections/BitArray.xml @@ -971,6 +971,7 @@ The current is updated and returned. ]]> + is less than zero. @@ -1185,6 +1186,7 @@ The current is updated and returned. ]]> + is less than zero. From e42c4c83cca53bd5a1bf5a777c2ac09e4a26c2d1 Mon Sep 17 00:00:00 2001 From: Layomi Akinrinade Date: Tue, 21 Apr 2020 18:05:57 -0700 Subject: [PATCH 3/4] Add System. prefix to exceptions --- xml/System.Collections.Generic/Dictionary`2.xml | 6 +++--- xml/System.Collections.Generic/Queue`1.xml | 2 +- xml/System.Collections/BitArray.xml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index 8f65bd42e36..b7e8ca240d1 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -334,7 +334,7 @@ The whose elements are copied to the new . Initializes a new instance of the class that contains elements copied from the specified . To be added. - contains one or more duplicated keys. + contains one or more duplicated keys. @@ -572,7 +572,7 @@ The implementation to use when comparing keys, or to use the default for the type of the key. Initializes a new instance of the class that contains elements copied from the specified and uses the specified . To be added. - contains one or more duplicated keys. + contains one or more duplicated keys. @@ -1514,7 +1514,7 @@ if the element is successfully found and removed; otherwise, . To be added. - is . + is . diff --git a/xml/System.Collections.Generic/Queue`1.xml b/xml/System.Collections.Generic/Queue`1.xml index 58a35f8227f..2dcf615760e 100644 --- a/xml/System.Collections.Generic/Queue`1.xml +++ b/xml/System.Collections.Generic/Queue`1.xml @@ -1338,7 +1338,7 @@ finally { if the object is successfully removed; if the is empty. To be added. - is . + is . diff --git a/xml/System.Collections/BitArray.xml b/xml/System.Collections/BitArray.xml index e6bb7257940..0491d5a33ef 100644 --- a/xml/System.Collections/BitArray.xml +++ b/xml/System.Collections/BitArray.xml @@ -971,7 +971,7 @@ The current is updated and returned. ]]> - is less than zero. + is less than zero. @@ -1186,7 +1186,7 @@ The current is updated and returned. ]]> - is less than zero. + is less than zero. From 3c59e62b7783c80641a83a8973dcfb64b53b10f8 Mon Sep 17 00:00:00 2001 From: Layomi Akinrinade Date: Mon, 27 Apr 2020 17:42:17 -0700 Subject: [PATCH 4/4] Address feedback - use tool to port exceptions --- xml/System.Collections.Generic/Dictionary`2.xml | 13 ++++++++++--- xml/System.Collections.Generic/Queue`1.xml | 3 ++- xml/System.Collections/BitArray.xml | 6 ++++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index b7e8ca240d1..11ae9b70cee 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -334,7 +334,10 @@ The whose elements are copied to the new . Initializes a new instance of the class that contains elements copied from the specified . To be added. - contains one or more duplicated keys. + + is . + + contains one or more duplicated keys. @@ -572,7 +575,10 @@ The implementation to use when comparing keys, or to use the default for the type of the key. Initializes a new instance of the class that contains elements copied from the specified and uses the specified . To be added. - contains one or more duplicated keys. + + is . + + contains one or more duplicated keys. @@ -1514,7 +1520,8 @@ if the element is successfully found and removed; otherwise, . To be added. - is . + + is . diff --git a/xml/System.Collections.Generic/Queue`1.xml b/xml/System.Collections.Generic/Queue`1.xml index 2dcf615760e..fa28bdb7faf 100644 --- a/xml/System.Collections.Generic/Queue`1.xml +++ b/xml/System.Collections.Generic/Queue`1.xml @@ -1338,7 +1338,8 @@ finally { if the object is successfully removed; if the is empty. To be added. - is . + + is . diff --git a/xml/System.Collections/BitArray.xml b/xml/System.Collections/BitArray.xml index 0491d5a33ef..ad259ba6a1f 100644 --- a/xml/System.Collections/BitArray.xml +++ b/xml/System.Collections/BitArray.xml @@ -971,7 +971,8 @@ The current is updated and returned. ]]> - is less than zero. + + is less than zero. @@ -1186,7 +1187,8 @@ The current is updated and returned. ]]> - is less than zero. + + is less than zero.