Skip to content

Automatic port of System.Collections.Immutable #3946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 6, 2020
Merged

Automatic port of System.Collections.Immutable #3946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a03a413
Automatic port of System.Collections.Immutable
carlossanlop Feb 27, 2020
ad24cd1
suggestions by mairaw
carlossanlop Feb 28, 2020
5257b1b
Apply suggestions from code review
carlossanlop Mar 2, 2020
0e036e3
overwrite -> replace
carlossanlop Mar 2, 2020
5469124
Apply suggestions from code review
carlossanlop Mar 2, 2020
951c8b8
Reverting bad documentation to "To be added"
carlossanlop Mar 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,8 +700,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the collection is read-only.</summary>
<value>
<see langword="true" /> if the collection is read-only; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -730,8 +731,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a collection containing the keys of the generic dictionary.</summary>
<value>A collection containing the keys of the object that implements the generic dictionary.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -760,8 +761,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a collection containing the values in the generic dictionary.</summary>
<value>A collection containing the values in the object that implements the generic dictionary.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -790,8 +791,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
41 changes: 21 additions & 20 deletions xml/System.Collections.Immutable/ImmutableDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,9 +816,9 @@
<Parameter Name="value" Type="TValue" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<param name="key">The object to use as the key of the element to add.</param>
<param name="value">The object to use as the value of the element to add.</param>
<summary>Adds an element with the provided key and value to the immutable dictionary.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -850,9 +850,9 @@
<Parameter Name="key" Type="TKey" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="key">The type of the key.</param>
<summary>Gets or sets the <typeparamref name="TValue" /> with the specified key.</summary>
<value>An object of type <typeparamref name="TValue" /> associated with the <paramref name="key" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -881,8 +881,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the keys.</summary>
<value>A collection containing the keys.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -913,9 +913,10 @@
<Parameter Name="key" Type="TKey" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="key">The key of the element to remove.</param>
<summary>Removes the element with the specified key from the generic dictionary.</summary>
<returns>
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="key" /> was not found in the original generic dictionary.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -944,8 +945,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the values.</summary>
<value>A collection containing the values.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -974,8 +975,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1571,8 +1572,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Retrieves an empty dictionary that has the same ordering and key-value comparison rules as this dictionary instance.</summary>
<returns>The immutable dictionary instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1704,9 +1705,9 @@
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;&gt;" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">The key-value pairs to set on the map. Any keys that conflict with existing keys will replace the previous values.</param>
<summary>Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary.</summary>
<returns>A copy of the immutable dictionary with updated key-value pairs.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,8 +676,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether this instance is read-only.</summary>
<value>Always <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
47 changes: 24 additions & 23 deletions xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,9 +798,9 @@
<Parameter Name="value" Type="TValue" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<param name="key">The object to use as the key of the element to add.</param>
<param name="value">The object to use as the value of the element to add.</param>
<summary>Adds an element with the provided key and value to the generic dictionary.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -833,8 +833,8 @@
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the <typeparamref name="TValue" /> with the specified key.</summary>
<value>An object of type <typeparamref name="TValue" /> associated with the <paramref name="key" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -863,8 +863,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the keys.</summary>
<value>A collection containing the keys.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -895,9 +895,10 @@
<Parameter Name="key" Type="TKey" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="key">The key of the element to remove.</param>
<summary>Removes the element with the specified key from the generic dictionary.</summary>
<returns>
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="key" /> was not found in the original generic dictionary.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -926,8 +927,8 @@
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the values.</summary>
<value>A collection containing the values.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -956,8 +957,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1491,7 +1492,7 @@
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1524,7 +1525,7 @@
<Docs>
<param name="pairs">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1554,7 +1555,7 @@
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1587,7 +1588,7 @@
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1620,7 +1621,7 @@
<Docs>
<param name="keys">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1655,7 +1656,7 @@
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1686,9 +1687,9 @@
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;&gt;" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">A set of key-value pairs to set on the map.</param>
<summary>Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary.</summary>
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down