Skip to content

Commit 349776f

Browse files
authored
Document System.Linq.IQueryable<TSource> (#3672)
1 parent f37171b commit 349776f

File tree

1 file changed

+46
-22
lines changed

1 file changed

+46
-22
lines changed

xml/System.Linq/Queryable.xml

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -508,12 +508,14 @@
508508
<Parameter Name="element" Type="TSource" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1;netcore-3.1" />
509509
</Parameters>
510510
<Docs>
511-
<typeparam name="TSource">To be added.</typeparam>
512-
<param name="source">To be added.</param>
513-
<param name="element">To be added.</param>
514-
<summary>To be added.</summary>
515-
<returns>To be added.</returns>
511+
<typeparam name="TSource">The type of the elements in the queryable sequence.</typeparam>
512+
<param name="source">A queryable sequence.</param>
513+
<param name="element">An element of type <typeparamref name="TSource" /> to append to <paramref name="source" />.</param>
514+
<summary>Returns a new queryable sequence that contains the elements from <paramref name="source" /> plus the specified <paramref name="element" /> appended at the end.</summary>
515+
<returns>A new queryable sequence that contains the elements from <paramref name="source" /> plus the specified <paramref name="element" /> appended at the end.</returns>
516516
<remarks>To be added.</remarks>
517+
<exception cref="T:System.ArgumentNullException">
518+
<paramref name="source" /> is <see langword="null" />.</exception>
517519
</Docs>
518520
</Member>
519521
<Member MemberName="AsQueryable">
@@ -5160,12 +5162,14 @@
51605162
<Parameter Name="element" Type="TSource" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1;netcore-3.1" />
51615163
</Parameters>
51625164
<Docs>
5163-
<typeparam name="TSource">To be added.</typeparam>
5164-
<param name="source">To be added.</param>
5165-
<param name="element">To be added.</param>
5166-
<summary>To be added.</summary>
5167-
<returns>To be added.</returns>
5165+
<typeparam name="TSource">The type of the elements in the queryable sequence.</typeparam>
5166+
<param name="source">A queryable sequence.</param>
5167+
<param name="element">An element of type <typeparamref name="TSource" /> to prepend to <paramref name="source" />.</param>
5168+
<summary>Returns a new queryable sequence that contains the elements from <paramref name="source" /> plus the specified <paramref name="element" /> prepended at the beginning.</summary>
5169+
<returns>A new queryable sequence that contains the elements from <paramref name="source" /> plus the specified <paramref name="element" /> prepended at the beginning.</returns>
51685170
<remarks>To be added.</remarks>
5171+
<exception cref="T:System.ArgumentNullException">
5172+
<paramref name="source" /> is <see langword="null" />.</exception>
51695173
</Docs>
51705174
</Member>
51715175
<Member MemberName="Reverse&lt;TSource&gt;">
@@ -6175,12 +6179,22 @@
61756179
<Parameter Name="count" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1;netcore-3.1" />
61766180
</Parameters>
61776181
<Docs>
6178-
<typeparam name="TSource">To be added.</typeparam>
6179-
<param name="source">To be added.</param>
6180-
<param name="count">To be added.</param>
6181-
<summary>To be added.</summary>
6182-
<returns>To be added.</returns>
6183-
<remarks>To be added.</remarks>
6182+
<typeparam name="TSource">The type of the elements in the queryable sequence.</typeparam>
6183+
<param name="source">A queryable sequence.</param>
6184+
<param name="count">The number of elements to omit from the end of the queryable sequence.</param>
6185+
<summary>Returns a new queryable sequence that contains the elements from <paramref name="source" /> with the last <paramref name="count" /> elements of the source queryable sequence omitted.</summary>
6186+
<returns>A new queryable sequence that contains the elements from <paramref name="source" /> minus <paramref name="count" /> elements from the end of the queryable sequence.</returns>
6187+
<remarks>
6188+
<format type="text/markdown"><![CDATA[
6189+
6190+
## Remarks
6191+
6192+
If `count` is not a positive number, this method returns an identical copy of the `source` queryable sequence.
6193+
6194+
]]></format>
6195+
</remarks>
6196+
<exception cref="T:System.ArgumentNullException">
6197+
<paramref name="source" /> is <see langword="null" />.</exception>
61846198
</Docs>
61856199
</Member>
61866200
<MemberGroup MemberName="SkipWhile&lt;TSource&gt;">
@@ -7695,12 +7709,22 @@
76957709
<Parameter Name="count" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1;netcore-3.1" />
76967710
</Parameters>
76977711
<Docs>
7698-
<typeparam name="TSource">To be added.</typeparam>
7699-
<param name="source">To be added.</param>
7700-
<param name="count">To be added.</param>
7701-
<summary>To be added.</summary>
7702-
<returns>To be added.</returns>
7703-
<remarks>To be added.</remarks>
7712+
<typeparam name="TSource">The type of the elements in the queryable sequence.</typeparam>
7713+
<param name="source">A queryable sequence instance.</param>
7714+
<param name="count">The number of elements to take from the end of the queryable sequence.</param>
7715+
<summary>Returns a new queryable sequence that contains the last <paramref name="count" /> elements from <paramref name="source" />.</summary>
7716+
<returns>A new queryable sequence that contains the last <paramref name="count" /> elements from <paramref name="source" />.</returns>
7717+
<remarks>
7718+
<format type="text/markdown"><![CDATA[
7719+
7720+
## Remarks
7721+
7722+
If `count` is not a positive number, this method returns an empty queryable sequence.
7723+
7724+
]]></format>
7725+
</remarks>
7726+
<exception cref="T:System.ArgumentNullException">
7727+
<paramref name="source" /> is <see langword="null" />.</exception>
77047728
</Docs>
77057729
</Member>
77067730
<MemberGroup MemberName="TakeWhile&lt;TSource&gt;">

0 commit comments

Comments
 (0)