Skip to content

Commit 43144c9

Browse files
author
Prashanth Govindarajan
authored
Docs for CollectionExtensions (#4899)
* Docs for CollectionExtensions * ValueRef LinkedListNode
1 parent 91a4127 commit 43144c9

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

‎xml/System.Collections.Generic/CollectionExtensions.xml

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,11 @@
5757
<Parameter Name="self" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.DependencyModel.RuntimeAssetGroup&gt;" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
5858
</Parameters>
5959
<Docs>
60-
<param name="self">To be added.</param>
61-
<summary>To be added.</summary>
62-
<returns>To be added.</returns>
60+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
61+
<summary>Gets an enumeration of assets where each asset has an empty runtime.</summary>
62+
<returns>An enumeration of assets, each with an empty <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" />.</returns>
6363
<remarks>To be added.</remarks>
64+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="self" /> is <see langword="null" />.</exception>
6465
</Docs>
6566
</Member>
6667
<Member MemberName="GetDefaultGroup">
@@ -88,10 +89,11 @@
8889
<Parameter Name="self" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.DependencyModel.RuntimeAssetGroup&gt;" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
8990
</Parameters>
9091
<Docs>
91-
<param name="self">To be added.</param>
92-
<summary>To be added.</summary>
93-
<returns>To be added.</returns>
92+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
93+
<summary>Gets the first <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" /> with an empty <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" />.</summary>
94+
<returns>The first <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" /> with an empty <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" />, or <see langword="null" /> if none exists.</returns>
9495
<remarks>To be added.</remarks>
96+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="self" /> is <see langword="null" />.</exception>
9597
</Docs>
9698
</Member>
9799
<Member MemberName="GetDefaultRuntimeFileAssets">
@@ -119,10 +121,11 @@
119121
<Parameter Name="self" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.DependencyModel.RuntimeAssetGroup&gt;" Index="0" FrameworkAlternate="dotnet-plat-ext-5.0" RefType="this" />
120122
</Parameters>
121123
<Docs>
122-
<param name="self">To be added.</param>
123-
<summary>To be added.</summary>
124-
<returns>To be added.</returns>
124+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
125+
<summary>Gets an enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeFile" /> where each value has an empty runtime.</summary>
126+
<returns>An enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeFile" />, each with an empty <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" />.</returns>
125127
<remarks>To be added.</remarks>
128+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="self" /> is <see langword="null" />.</exception>
126129
</Docs>
127130
</Member>
128131
<Member MemberName="GetRuntimeAssets">
@@ -151,11 +154,12 @@
151154
<Parameter Name="runtime" Type="System.String" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
152155
</Parameters>
153156
<Docs>
154-
<param name="self">To be added.</param>
155-
<param name="runtime">To be added.</param>
156-
<summary>To be added.</summary>
157-
<returns>To be added.</returns>
157+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
158+
<param name="runtime">The string to search for.</param>
159+
<summary>Gets an enumeration of assets where each asset's value equals <paramref name="runtime" />.</summary>
160+
<returns>An enumeration of assets where each asset's <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" /> equals <paramref name="runtime" />.</returns>
158161
<remarks>To be added.</remarks>
162+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="self" /> is <see langword="null" />.</exception>
159163
</Docs>
160164
</Member>
161165
<Member MemberName="GetRuntimeFileAssets">
@@ -184,11 +188,12 @@
184188
<Parameter Name="runtime" Type="System.String" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
185189
</Parameters>
186190
<Docs>
187-
<param name="self">To be added.</param>
188-
<param name="runtime">To be added.</param>
189-
<summary>To be added.</summary>
190-
<returns>To be added.</returns>
191+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
192+
<param name="runtime">The string to search for.</param>
193+
<summary>Gets an enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeFile" /> where each value's <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" /> equals <paramref name="runtime" />.</summary>
194+
<returns>An enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeFile" />, where each value's <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" /> equals <paramref name="runtime" />.</returns>
191195
<remarks>To be added.</remarks>
196+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="runtime" /> is <see langword="null" /> or empty.</exception>
192197
</Docs>
193198
</Member>
194199
<Member MemberName="GetRuntimeGroup">
@@ -217,11 +222,12 @@
217222
<Parameter Name="runtime" Type="System.String" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0" />
218223
</Parameters>
219224
<Docs>
220-
<param name="self">To be added.</param>
221-
<param name="runtime">To be added.</param>
222-
<summary>To be added.</summary>
223-
<returns>To be added.</returns>
225+
<param name="self">The source enumeration of <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" />.</param>
226+
<param name="runtime">The string to search for.</param>
227+
<summary>Gets the first <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" /> where <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" /> matches <paramref name="runtime" />.</summary>
228+
<returns>The first <see cref="T:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup" /> where <see cref="P:Microsoft.Extensions.DependencyModel.RuntimeAssetGroup.Runtime" /> matches <paramref name="runtime" />, or <see langword="null" /> if none exists.</returns>
224229
<remarks>To be added.</remarks>
230+
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="runtime" /> is <see langword="null" /> or empty.</exception>
225231
</Docs>
226232
</Member>
227233
<Member MemberName="GetValueOrDefault&lt;TKey,TValue&gt;">

‎xml/System.Collections.Generic/LinkedListNode`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,8 @@
361361
<ReturnType>T</ReturnType>
362362
</ReturnValue>
363363
<Docs>
364-
<summary>To be added.</summary>
365-
<value>To be added.</value>
364+
<summary>Gets a reference to the value held by the node.</summary>
365+
<value>a reference to the value held by the node.</value>
366366
<remarks>To be added.</remarks>
367367
</Docs>
368368
</Member>

0 commit comments

Comments
 (0)