Skip to content

Commit f33aab6

Browse files
authored
Explain event waited for specified number of ms (#5434)
1 parent 9b06d19 commit f33aab6

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

xml/System.Collections.Concurrent/BlockingCollection`1.xml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1334,8 +1334,8 @@ This member is an explicit interface member implementation. It can be used only
13341334
</ReturnValue>
13351335
<Parameters />
13361336
<Docs>
1337-
<summary>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
1338-
<returns>The item removed from the collection.</returns>
1337+
<summary>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
1338+
<returns>The item that was removed from the collection.</returns>
13391339
<remarks>
13401340
<format type="text/markdown"><![CDATA[
13411341
@@ -1386,9 +1386,9 @@ This member is an explicit interface member implementation. It can be used only
13861386
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
13871387
</Parameters>
13881388
<Docs>
1389-
<param name="cancellationToken">Object that can be used to cancel the take operation.</param>
1389+
<param name="cancellationToken">A token that can be used to cancel the "take" operation.</param>
13901390
<summary>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
1391-
<returns>The item removed from the collection.</returns>
1391+
<returns>The item that was removed from the collection.</returns>
13921392
<remarks>
13931393
<format type="text/markdown"><![CDATA[
13941394
@@ -1461,7 +1461,7 @@ This member is an explicit interface member implementation. It can be used only
14611461
</Parameters>
14621462
<Docs>
14631463
<param name="collections">The array of collections.</param>
1464-
<param name="item">The item removed from one of the collections.</param>
1464+
<param name="item">The item that was removed from one of the collections.</param>
14651465
<summary>Takes an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
14661466
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed.</returns>
14671467
<remarks>
@@ -1524,7 +1524,7 @@ This member is an explicit interface member implementation. It can be used only
15241524
</Parameters>
15251525
<Docs>
15261526
<param name="collections">The array of collections.</param>
1527-
<param name="item">The item removed from one of the collections.</param>
1527+
<param name="item">The item that was removed from one of the collections.</param>
15281528
<param name="cancellationToken">A cancellation token to observe.</param>
15291529
<summary>Takes an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances while observing the specified cancellation token.</summary>
15301530
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed.</returns>
@@ -1695,7 +1695,7 @@ This member is an explicit interface member implementation. It can be used only
16951695
</Parameters>
16961696
<Docs>
16971697
<param name="item">The item to be added to the collection.</param>
1698-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
1698+
<param name="millisecondsTimeout">The number of milliseconds to wait for the collection to accept the item, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
16991699
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> within the specified time period.</summary>
17001700
<returns>
17011701
<see langword="true" /> if the <paramref name="item" /> could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an <see cref="T:System.InvalidOperationException" /> is thrown.</returns>
@@ -1800,7 +1800,7 @@ This member is an explicit interface member implementation. It can be used only
18001800
</Parameters>
18011801
<Docs>
18021802
<param name="item">The item to be added to the collection.</param>
1803-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
1803+
<param name="millisecondsTimeout">The number of milliseconds to wait for the collection to accept the item, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
18041804
<param name="cancellationToken">A cancellation token to observe.</param>
18051805
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> within the specified time period, while observing a cancellation token.</summary>
18061806
<returns>
@@ -1915,7 +1915,7 @@ This member is an explicit interface member implementation. It can be used only
19151915
<Docs>
19161916
<param name="collections">The array of collections.</param>
19171917
<param name="item">The item to be added to one of the collections.</param>
1918-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
1918+
<param name="millisecondsTimeout">The number of milliseconds to wait for the collection to accept the item, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
19191919
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
19201920
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
19211921
<remarks>To be added.</remarks>
@@ -2033,7 +2033,7 @@ This member is an explicit interface member implementation. It can be used only
20332033
<Docs>
20342034
<param name="collections">The array of collections.</param>
20352035
<param name="item">The item to be added to one of the collections.</param>
2036-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
2036+
<param name="millisecondsTimeout">The number of milliseconds to wait for the collection to accept the item, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
20372037
<param name="cancellationToken">A cancellation token to observe.</param>
20382038
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
20392039
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
@@ -2164,7 +2164,7 @@ This member is an explicit interface member implementation. It can be used only
21642164
</Parameters>
21652165
<Docs>
21662166
<param name="item">The item to be removed from the collection.</param>
2167-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
2167+
<param name="millisecondsTimeout">The number of milliseconds to wait for the item to be removed, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
21682168
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period.</summary>
21692169
<returns>
21702170
<see langword="true" /> if an item could be removed from the collection within the specified time; otherwise, <see langword="false" />.</returns>
@@ -2219,10 +2219,10 @@ This member is an explicit interface member implementation. It can be used only
22192219
</Parameters>
22202220
<Docs>
22212221
<param name="item">The item to be removed from the collection.</param>
2222-
<param name="timeout">An object that represents the number of milliseconds to wait, or an object that represents -1 milliseconds to wait indefinitely.</param>
2222+
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait for the item to be removed, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
22232223
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period.</summary>
22242224
<returns>
2225-
<see langword="true" /> if an item could be removed from the collection within the specified time; otherwise, <see langword="false" />.</returns>
2225+
<see langword="true" /> if an item could be removed from the collection within the specified time; otherwise, <see langword="false" />.</returns>
22262226
<remarks>
22272227
<format type="text/markdown"><![CDATA[
22282228
@@ -2279,7 +2279,7 @@ This member is an explicit interface member implementation. It can be used only
22792279
</Parameters>
22802280
<Docs>
22812281
<param name="item">The item to be removed from the collection.</param>
2282-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
2282+
<param name="millisecondsTimeout">The number of milliseconds to wait for the item to be removed, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
22832283
<param name="cancellationToken">A cancellation token to observe.</param>
22842284
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period while observing a cancellation token.</summary>
22852285
<returns>
@@ -2354,7 +2354,7 @@ This member is an explicit interface member implementation. It can be used only
23542354
</Parameters>
23552355
<Docs>
23562356
<param name="collections">The array of collections.</param>
2357-
<param name="item">The item removed from one of the collections.</param>
2357+
<param name="item">The item that was removed from one of the collections.</param>
23582358
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
23592359
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
23602360
<remarks>
@@ -2418,9 +2418,9 @@ This member is an explicit interface member implementation. It can be used only
24182418
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
24192419
</Parameters>
24202420
<Docs>
2421-
<param name="collections">The array of collections.</param>
2422-
<param name="item">The item removed from one of the collections.</param>
2423-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
2421+
<param name="collections">The array of collections to remove an item from.</param>
2422+
<param name="item">The item that was removed from one of the collections.</param>
2423+
<param name="millisecondsTimeout">The number of milliseconds to wait for the item to be removed, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
24242424
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
24252425
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
24262426
<remarks>
@@ -2482,7 +2482,7 @@ This member is an explicit interface member implementation. It can be used only
24822482
</Parameters>
24832483
<Docs>
24842484
<param name="collections">The array of collections.</param>
2485-
<param name="item">The item removed from one of the collections.</param>
2485+
<param name="item">The item that was removed from one of the collections.</param>
24862486
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
24872487
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
24882488
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
@@ -2545,9 +2545,9 @@ This member is an explicit interface member implementation. It can be used only
25452545
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
25462546
</Parameters>
25472547
<Docs>
2548-
<param name="collections">The array of collections.</param>
2549-
<param name="item">The item removed from one of the collections.</param>
2550-
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
2548+
<param name="collections">The array of collections to remove an item from.</param>
2549+
<param name="item">The item that was removed from one of the collections.</param>
2550+
<param name="millisecondsTimeout">The number of milliseconds to wait for the item to be removed, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
25512551
<param name="cancellationToken">A cancellation token to observe.</param>
25522552
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
25532553
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>

0 commit comments

Comments
 (0)