Skip to content
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

Jump to bottom

Port System.Collections API docs. #9196

Merged
merged 3 commits into from
Aug 22, 2023
Merged

Port System.Collections API docs. #9196

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
334bdc5
Port System.Collections API docs.
eiriktsarpalis Aug 17, 2023
033783b
Try to fix warning using O:
carlossanlop Aug 18, 2023
b451ce9
Apply suggestions from code review
carlossanlop Aug 22, 2023
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
48 changes: 24 additions & 24 deletions xml/System.Collections.Frozen/FrozenDictionary.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides a set of initialization methods for instances of the <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -72,13 +72,13 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="TKey">To be added.</typeparam>
<typeparam name="TValue">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="comparer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
<param name="source">The key/value pairs to use to populate the dictionary.</param>
<param name="comparer">The comparer implementation to use to compare keys for equality. If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Creates a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> with the specified key/value pairs.</summary>
<returns>A <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> that contains the specified keys and values.</returns>
<remarks>If the same key appears multiple times in the input, the latter one in the sequence takes precedence. This differs from <see cref="O:System.Linq.Enumerable.ToDictionary" />, with which multiple duplicate keys will result in an exception.</remarks>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
</Docs>
</Member>
<Member MemberName="ToFrozenDictionary&lt;TSource,TKey&gt;">
Expand Down Expand Up @@ -119,13 +119,13 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="TSource">To be added.</typeparam>
<typeparam name="TKey">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="keySelector">To be added.</param>
<param name="comparer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> from which to create a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" />.</param>
<param name="keySelector">A function to extract a key from each element.</param>
<param name="comparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys.</param>
<summary>Creates a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> from an <see cref="T:System.Collections.Generic.IEnumerable`1" /> according to specified key selector function.</summary>
<returns>A <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> that contains the keys and values selected from the input sequence.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -176,15 +176,15 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="TSource">To be added.</typeparam>
<typeparam name="TKey">To be added.</typeparam>
<typeparam name="TElement">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="keySelector">To be added.</param>
<param name="elementSelector">To be added.</param>
<param name="comparer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
<typeparam name="TElement">The type of the value returned by <paramref name="elementSelector" />.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> from which to create a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" />.</param>
<param name="keySelector">A function to extract a key from each element.</param>
<param name="elementSelector">A transform function to produce a result element value from each element.</param>
<param name="comparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys.</param>
<summary>Creates a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> from an <see cref="T:System.Collections.Generic.IEnumerable`1" /> according to specified key selector and element selector functions.</summary>
<returns>A <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> that contains the keys and values selected from the input sequence.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
7 changes: 6 additions & 1 deletion xml/System.Collections.Frozen/FrozenDictionary`2+Enumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Enumerates the elements of a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -77,6 +77,7 @@
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc cref="P:System.Collections.Generic.IEnumerator`1.Current" />
</Docs>
</Member>
<Member MemberName="MoveNext">
Expand All @@ -102,6 +103,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Collections.IEnumerator.MoveNext" />
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Current">
Expand Down Expand Up @@ -132,6 +134,7 @@
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Reset">
Expand All @@ -156,6 +159,7 @@
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="System.IDisposable.Dispose">
Expand All @@ -180,6 +184,7 @@
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
Loading
Loading