Skip to content

Commit d789ea9

Browse files
eiriktsarpaliseiriktsarpalis
authored
Merge pull request dotnet#10338 from eiriktsarpalis/doc-missing-apis
Add missing System.Collections and System.Linq API docs.
2 parents 4d7beb5 + 7ec7d86 commit d789ea9

File tree

8 files changed

+105
-74
lines changed

8 files changed

+105
-74
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,8 @@
176176
<para>otherwise, the default value for the type of the value parameter.</para>
177177
</param>
178178
<summary>Gets the value associated with the specified alternate key.</summary>
179-
<returns>To be added.</returns>
179+
<returns>
180+
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
180181
<remarks>To be added.</remarks>
181182
<exception cref="T:System.ArgumentNullException">
182183
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -213,7 +214,8 @@
213214
<para>otherwise, the default value for the type of the value parameter.</para>
214215
</param>
215216
<summary>Gets the value associated with the specified alternate key.</summary>
216-
<returns>To be added.</returns>
217+
<returns>
218+
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
217219
<remarks>To be added.</remarks>
218220
<exception cref="T:System.ArgumentNullException">
219221
<paramref name="key" /> is <see langword="null" />.</exception>

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2704,11 +2704,18 @@ This member is an explicit interface member implementation. It can be used only
27042704
</Parameter>
27052705
</Parameters>
27062706
<Docs>
2707-
<typeparam name="TAlternateKey">To be added.</typeparam>
2708-
<param name="lookup">To be added.</param>
2709-
<summary>To be added.</summary>
2710-
<returns>To be added.</returns>
2711-
<remarks>To be added.</remarks>
2707+
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
2708+
<param name="lookup">The created lookup instance when the method returns <see langword="true" />, or a default instance that should not be used if the method returns <see langword="false" />.</param>
2709+
<summary>
2710+
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2"/>
2711+
using a <typeparamref name="TAlternateKey"/> as a key instead of a <typeparamref name="TKey"/>.
2712+
</summary>
2713+
<returns>
2714+
<see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
2715+
<remarks>
2716+
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with
2717+
<typeparamref name="TAlternateKey"/> and <typeparamref name="TKey"/>. If it doesn't, the method will return <see langword="false" />.
2718+
</remarks>
27122719
</Docs>
27132720
</Member>
27142721
<Member MemberName="TryGetValue">

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,8 @@
157157
<para>otherwise, the default value for the type of the value parameter.</para>
158158
</param>
159159
<summary>Gets the value associated with the specified alternate key.</summary>
160-
<returns>To be added.</returns>
160+
<returns>
161+
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
161162
<remarks>To be added.</remarks>
162163
<exception cref="T:System.ArgumentNullException">
163164
<paramref name="key" /> is <see langword="null" />.</exception>

‎xml/System.Collections.Frozen/FrozenDictionary`2.xml

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1221,11 +1221,18 @@
12211221
</Parameter>
12221222
</Parameters>
12231223
<Docs>
1224-
<typeparam name="TAlternateKey">To be added.</typeparam>
1225-
<param name="lookup">To be added.</param>
1226-
<summary>To be added.</summary>
1227-
<returns>To be added.</returns>
1228-
<remarks>To be added.</remarks>
1224+
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
1225+
<param name="lookup">The created lookup instance when the method returns <see langword="true" />, or a default instance that should not be used if the method returns <see langword="false" />.</param>
1226+
<summary>
1227+
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2"/>
1228+
using a <typeparamref name="TAlternateKey"/> as a key instead of a <typeparamref name="TKey"/>.
1229+
</summary>
1230+
<returns>
1231+
<see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
1232+
<remarks>
1233+
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with
1234+
<typeparamref name="TAlternateKey"/> and <typeparamref name="TKey"/>. If it doesn't, the method will return <see langword="false" />.
1235+
</remarks>
12291236
</Docs>
12301237
</Member>
12311238
<Member MemberName="TryGetValue">
@@ -1263,8 +1270,7 @@
12631270
<param name="key">The key of the value to get.</param>
12641271
<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 <paramref name="value" />.</param>
12651272
<summary>Gets the value associated with the specified key.</summary>
1266-
<returns>
1267-
<see langword="true" /> if the dictionary contains an element with the specified key; otherwise, <see langword="false" />.</returns>
1273+
<returns><see langword="true" /> if the dictionary contains an element with the specified key; otherwise, <see langword="false" />.</returns>
12681274
<remarks>To be added.</remarks>
12691275
</Docs>
12701276
</Member>

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -962,11 +962,18 @@
962962
</Parameter>
963963
</Parameters>
964964
<Docs>
965-
<typeparam name="TAlternate">To be added.</typeparam>
966-
<param name="lookup">To be added.</param>
967-
<summary>To be added.</summary>
968-
<returns>To be added.</returns>
969-
<remarks>To be added.</remarks>
965+
<typeparam name="TAlternate">The alternate type of a key for performing lookups.</typeparam>
966+
<param name="lookup">The created lookup instance when the method returns <see langword="true" />, or a default instance that should not be used if the method returns <see langword="false" />.</param>
967+
<summary>
968+
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1"/>
969+
using a <typeparamref name="TAlternate"/> instead of a <typeparamref name="T"/>.
970+
</summary>
971+
<returns>
972+
<see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
973+
<remarks>
974+
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with
975+
<typeparamref name="TAlternate"/> and <typeparamref name="T"/>. If it doesn't, the method will return <see langword="false" />.
976+
</remarks>
970977
</Docs>
971978
</Member>
972979
<Member MemberName="TryGetValue">

‎xml/System.Collections.Generic/OrderedDictionary`2+KeyCollection.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<Parameter Name="key" Type="TKey" />
9898
</Parameters>
9999
<Docs>
100-
<param name="key">To be added.</param>
100+
<param name="key">They key to the location in the collection.</param>
101101
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
102102
<returns>
103103
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>

‎xml/System.Linq/Enumerable.xml

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -393,17 +393,19 @@
393393
</Parameter>
394394
</Parameters>
395395
<Docs>
396-
<typeparam name="TSource">To be added.</typeparam>
397-
<typeparam name="TKey">To be added.</typeparam>
398-
<typeparam name="TAccumulate">To be added.</typeparam>
399-
<param name="source">To be added.</param>
400-
<param name="keySelector">To be added.</param>
401-
<param name="seedSelector">To be added.</param>
402-
<param name="func">To be added.</param>
403-
<param name="keyComparer">To be added.</param>
404-
<summary>To be added.</summary>
405-
<returns>To be added.</returns>
406-
<remarks>To be added.</remarks>
396+
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
397+
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
398+
<typeparam name="TAccumulate">The type of the accumulator value.</typeparam>
399+
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> to aggregate over.</param>
400+
<param name="keySelector">A function to extract the key for each element.</param>
401+
<param name="seedSelector">A factory for the initial accumulator value.</param>
402+
<param name="func">An accumulator function to be invoked on each element.</param>
403+
<param name="keyComparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys with.</param>
404+
<summary>Applies an accumulator function over a sequence, grouping results by key.</summary>
405+
<returns>An enumerable containing the aggregates corresponding to each key deriving from <paramref name="source" />.</returns>
406+
<remarks>
407+
This method is comparable to the <see cref="M:System.Linq.Enumerable.GroupBy``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})" /> methods where each grouping is being aggregated into a single value as opposed to allocating a collection for each group.
408+
</remarks>
407409
</Docs>
408410
</Member>
409411
<Member MemberName="AggregateBy&lt;TSource,TKey,TAccumulate&gt;">
@@ -466,17 +468,19 @@
466468
</Parameter>
467469
</Parameters>
468470
<Docs>
469-
<typeparam name="TSource">To be added.</typeparam>
470-
<typeparam name="TKey">To be added.</typeparam>
471-
<typeparam name="TAccumulate">To be added.</typeparam>
472-
<param name="source">To be added.</param>
473-
<param name="keySelector">To be added.</param>
474-
<param name="seed">To be added.</param>
475-
<param name="func">To be added.</param>
476-
<param name="keyComparer">To be added.</param>
477-
<summary>To be added.</summary>
478-
<returns>To be added.</returns>
479-
<remarks>To be added.</remarks>
471+
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
472+
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
473+
<typeparam name="TAccumulate">The type of the accumulator value.</typeparam>
474+
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> to aggregate over.</param>
475+
<param name="keySelector">A function to extract the key for each element.</param>
476+
<param name="seed">The initial accumulator value.</param>
477+
<param name="func">An accumulator function to be invoked on each element.</param>
478+
<param name="keyComparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys with.</param>
479+
<summary>Applies an accumulator function over a sequence, grouping results by key.</summary>
480+
<returns>An enumerable containing the aggregates corresponding to each key deriving from <paramref name="source" />.</returns>
481+
<remarks>
482+
This method is comparable to the <see cref="M:System.Linq.Enumerable.GroupBy``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})" /> methods where each grouping is being aggregated into a single value as opposed to allocating a collection for each group.
483+
</remarks>
480484
</Docs>
481485
</Member>
482486
<Member MemberName="All&lt;TSource&gt;">
@@ -2893,13 +2897,13 @@ Each chunk except the last one will be of size `size`. The last chunk will conta
28932897
</Parameter>
28942898
</Parameters>
28952899
<Docs>
2896-
<typeparam name="TSource">To be added.</typeparam>
2897-
<typeparam name="TKey">To be added.</typeparam>
2898-
<param name="source">To be added.</param>
2899-
<param name="keySelector">To be added.</param>
2900-
<param name="keyComparer">To be added.</param>
2901-
<summary>To be added.</summary>
2902-
<returns>To be added.</returns>
2900+
<typeparam name="TSource">The type of elements of <paramref name="source" />.</typeparam>
2901+
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
2902+
<param name="source">A sequence that contains elements to be counted.</param>
2903+
<param name="keySelector">A function to extract the key for each element.</param>
2904+
<param name="keyComparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys with.</param>
2905+
<summary>Returns the count of elements in the source sequence grouped by key.</summary>
2906+
<returns>An enumerable containing the frequencies of each key occurrence in <paramref name="source" />.</returns>
29032907
<remarks>To be added.</remarks>
29042908
</Docs>
29052909
</Member>
@@ -5677,7 +5681,7 @@ Only unique elements are returned.
56775681
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
56785682
<param name="source">The source enumerable providing the elements.</param>
56795683
<summary>Returns an enumerable that incorporates the element's index into a tuple.</summary>
5680-
<returns>To be added.</returns>
5684+
<returns>An enumerable that incorporates each element index into a tuple.</returns>
56815685
<remarks>To be added.</remarks>
56825686
<exception cref="T:System.ArgumentNullException">
56835687
<paramref name="source" /> is <see langword="null" />.</exception>

‎xml/System.Linq/Queryable.xml

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -421,17 +421,19 @@
421421
</Parameter>
422422
</Parameters>
423423
<Docs>
424-
<typeparam name="TSource">To be added.</typeparam>
425-
<typeparam name="TKey">To be added.</typeparam>
426-
<typeparam name="TAccumulate">To be added.</typeparam>
427-
<param name="source">To be added.</param>
428-
<param name="keySelector">To be added.</param>
429-
<param name="seedSelector">To be added.</param>
430-
<param name="func">To be added.</param>
431-
<param name="keyComparer">To be added.</param>
432-
<summary>To be added.</summary>
433-
<returns>To be added.</returns>
434-
<remarks>To be added.</remarks>
424+
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
425+
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
426+
<typeparam name="TAccumulate">The type of the accumulator value.</typeparam>
427+
<param name="source">An <see cref="T:System.Linq.IQueryable`1" /> to aggregate over.</param>
428+
<param name="keySelector">A function to extract the key for each element.</param>
429+
<param name="seedSelector">A factory for the initial accumulator value.</param>
430+
<param name="func">An accumulator function to be invoked on each element.</param>
431+
<param name="keyComparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys with.</param>
432+
<summary>Applies an accumulator function over a sequence, grouping results by key.</summary>
433+
<returns>An enumerable containing the aggregates corresponding to each key deriving from <paramref name="source" />.</returns>
434+
<remarks>
435+
This method is comparable to the <see cref="M:System.Linq.Queryable.GroupBy``2(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,``1}})" /> methods where each grouping is being aggregated into a single value as opposed to allocating a collection for each group.
436+
</remarks>
435437
</Docs>
436438
</Member>
437439
<Member MemberName="AggregateBy&lt;TSource,TKey,TAccumulate&gt;">
@@ -494,17 +496,19 @@
494496
</Parameter>
495497
</Parameters>
496498
<Docs>
497-
<typeparam name="TSource">To be added.</typeparam>
498-
<typeparam name="TKey">To be added.</typeparam>
499-
<typeparam name="TAccumulate">To be added.</typeparam>
500-
<param name="source">To be added.</param>
501-
<param name="keySelector">To be added.</param>
502-
<param name="seed">To be added.</param>
503-
<param name="func">To be added.</param>
504-
<param name="keyComparer">To be added.</param>
505-
<summary>To be added.</summary>
506-
<returns>To be added.</returns>
507-
<remarks>To be added.</remarks>
499+
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
500+
<typeparam name="TKey">The type of the key returned by <paramref name="keySelector" />.</typeparam>
501+
<typeparam name="TAccumulate">The type of the accumulator value.</typeparam>
502+
<param name="source">An <see cref="T:System.Linq.IQueryable`1" /> to aggregate over.</param>
503+
<param name="keySelector">A function to extract the key for each element.</param>
504+
<param name="seed">The initial accumulator value.</param>
505+
<param name="func">An accumulator function to be invoked on each element.</param>
506+
<param name="keyComparer">An <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> to compare keys with.</param>
507+
<summary>Applies an accumulator function over a sequence, grouping results by key.</summary>
508+
<returns>An enumerable containing the aggregates corresponding to each key deriving from <paramref name="source" />.</returns>
509+
<remarks>
510+
This method is comparable to the <see cref="M:System.Linq.Queryable.GroupBy``2(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,``1}})" /> methods where each grouping is being aggregated into a single value as opposed to allocating a collection for each group.
511+
</remarks>
508512
</Docs>
509513
</Member>
510514
<Member MemberName="All&lt;TSource&gt;">
@@ -5834,7 +5838,7 @@ The last chunk will contain the remaining elements and may be of a smaller size.
58345838
<typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
58355839
<param name="source">An <see cref="T:System.Linq.IQueryable`1" /> to return an element from.</param>
58365840
<summary>Return index and the associated item.</summary>
5837-
<returns>To be added.</returns>
5841+
<returns>An enumerable that incorporates each element index into a tuple.</returns>
58385842
<remarks>To be added.</remarks>
58395843
<exception cref="T:System.ArgumentNullException">
58405844
<paramref name="source" /> is <see langword="null" />.</exception>

0 commit comments

Comments
 (0)