<summary>Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
<param name="item">The item to be added to the collection. The value can be a null reference.</param>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0,System.Threading.CancellationToken)">
<summary>Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
<param name="cancellationToken">A cancellation token to observe.</param>
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that owns <paramref name="cancellationToken" /> has been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.AddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0)">
<summary>Adds the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="array" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index" /> argument is less than zero.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="index" /> argument is equal to or greater than the length of the <paramref name="array" />.
- The destination array is too small to hold all of the BlockingCollection elements.
- The array rank doesn't match.
- The array type is incompatible with the type of the BlockingCollection elements.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="index" /> argument is equal to or greater than the length of the <paramref name="array" />.
+The destination array is too small to hold all of the BlockingCollection elements.
+The array rank doesn't match.
+The array type is incompatible with the type of the BlockingCollection elements.</exception>
</member>
<member name="P:System.Collections.Concurrent.BlockingCollection`1.Count">
<summary>Gets the number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
<returns>
<see langword="true" /> if <paramref name="item" /> could be added; otherwise, <see langword="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>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.Int32)">
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> within the specified time period.</summary>
<param name="item">The item to be added to the collection.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
- <returns>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>
+ <returns>
+ <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>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.Int32,System.Threading.CancellationToken)">
<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>
<param name="item">The item to be added to the collection.</param>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
<param name="cancellationToken">A cancellation token to observe.</param>
- <returns>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>
+ <returns>
+ <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>
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the underlying <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.TimeSpan)">
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
<param name="item">The item to be added to the collection.</param>
<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>
- <returns>true if the <paramref name="item" /> could be added to the collection within the specified time span; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if the <paramref name="item" /> could be added to the collection within the specified time span; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
- -or-
- The underlying collection didn't accept the item.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.
+-or-
+The underlying collection didn't accept the item.</exception>
</member>
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0)">
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
--or-
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
--or-
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.
--or-
+ <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
<see langword="true" /> if an item could be removed from the collection within the specified time; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
--or-
+ <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.
+-or-
<paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
</member>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
--or-
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
--or-
+ <paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.
--or-
+ <paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.
+-or-
The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.TryPeek(`0@)">
<summary>Attempts to return an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> without removing it.</summary>
<param name="result">When this method returns, <paramref name="result" /> contains an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> or the default value of <typeparamref name="T" /> if the operation failed.</param>
- <returns>true if an object was returned successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an object was returned successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.TryTake(`0@)">
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
<param name="result">When this method returns, <paramref name="result" /> contains the object removed from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> or the default value of <typeparamref name="T" /> if the bag is empty.</param>
- <returns>true if an object was removed successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an object was removed successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.Collections.Concurrent.ConcurrentDictionary`2">
<summary>Represents a thread-safe collection of key/value pairs that can be accessed by multiple threads concurrently.</summary>
<param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> concurrently.</param>
<param name="capacity">The initial number of elements that the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> can contain.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="concurrencyLevel" /> is less than 1.
--or-
+ <paramref name="concurrencyLevel" /> is less than 1.
+-or-
<paramref name="capacity" /> is less than 0.</exception>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than 0.</exception>
<exception cref="T:System.ArgumentException">
- <paramref name="index" /> is equal to or greater than the length of the <paramref name="array" />.
--or-
+ <paramref name="index" /> is equal to or greater than the length of the <paramref name="array" />.
+-or-
The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
</member>
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#ICollection#IsSynchronized">
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
- <paramref name="key" /> is of a type that is not assignable to the key type of the <see cref="T:System.Collections.Generic.Dictionary`2" />.
--or-
-<paramref name="value" /> is of a type that is not assignable to the type of values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.
--or-
+ <paramref name="key" /> is of a type that is not assignable to the key type of the <see cref="T:System.Collections.Generic.Dictionary`2" />.
+-or-
+<paramref name="value" /> is of a type that is not assignable to the type of values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.
+-or-
A value with the same key already exists in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</exception>
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
</member>
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> class.</summary>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> class that contains elements copied from the specified collection</summary>
+ <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> class that contains elements copied from the specified collection.</summary>
<param name="collection">The collection whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryAdd(`0)">
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
- <returns>true if the object was added successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if the object was added successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryTake(`0@)">
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">When this method returns, if the operation was successful, <paramref name="item" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
- <returns>true if an element was removed and returned successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an element was removed and returned successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> class.</summary>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> class that contains elements copied from the specified collection</summary>
+ <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> class that contains elements copied from the specified collection.</summary>
<param name="collection">The collection whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryAdd(`0)">
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
- <returns>true if the object was added successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if the object was added successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryTake(`0@)">
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">When this method returns, if the operation was successful, <paramref name="item" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
- <returns>true if an element was removed and returned successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an element was removed and returned successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPeek(`0@)">
<summary>Attempts to return an object from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> without removing it.</summary>
<param name="result">When this method returns, <paramref name="result" /> contains an object from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> or an unspecified value if the operation failed.</param>
- <returns>true if and object was returned successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if and object was returned successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPop(`0@)">
<summary>Attempts to pop and return the object at the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
<param name="result">When this method returns, if the operation was successful, <paramref name="result" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
- <returns>true if an element was removed and returned from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an element was removed and returned from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPopRange(`0[])">
<summary>Attempts to pop and return multiple objects from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> atomically.</summary>
<paramref name="startIndex" /> + <paramref name="count" /> is greater than the length of <paramref name="items" />.</exception>
</member>
<member name="T:System.Collections.Concurrent.EnumerablePartitionerOptions">
- <summary>Specifies options to control the buffering behavior of a partitioner</summary>
+ <summary>Specifies options to control the buffering behavior of a partitioner.</summary>
</member>
<member name="F:System.Collections.Concurrent.EnumerablePartitionerOptions.NoBuffering">
<summary>Create a partitioner that takes items from the source enumerable one at a time and does not use intermediate storage that can be accessed more efficiently by multiple threads. This option provides support for low latency (items will be processed as soon as they are available from the source) and provides partial support for dependencies between items (a thread cannot deadlock waiting for an item that the thread itself is responsible for processing).</summary>
</member>
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.CopyTo(`0[],System.Int32)">
<summary>Copies the elements of the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> to an <see cref="T:System.Array" />, starting at a specified index.</summary>
- <param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.
- The array must have zero-based indexing.</param>
+ <param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.
+The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.TryAdd(`0)">
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</param>
- <returns>true if the object was added successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if the object was added successfully; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentException">The <paramref name="item" /> was invalid for this collection.</exception>
</member>
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.TryTake(`0@)">
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
<param name="item">When this method returns, if the object was removed and returned successfully, <paramref name="item" /> contains the removed object. If no object was available to be removed, the value is unspecified.</param>
- <returns>true if an object was removed and returned successfully; otherwise, false.</returns>
+ <returns>
+ <see langword="true" /> if an object was removed and returned successfully; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.Collections.Concurrent.OrderablePartitioner`1">
<summary>Represents a particular manner of splitting an orderable data source into multiple partitions.</summary>
<param name="toExclusive">The upper, exclusive bound of the range.</param>
<param name="rangeSize">The size of each subrange.</param>
<returns>A partitioner.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.
- -or-
-
The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.
+-or-
+The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
</member>
<member name="M:System.Collections.Concurrent.Partitioner.Create(System.Int64,System.Int64)">
<summary>Creates a partitioner that chunks the user-specified range.</summary>
<param name="toExclusive">The upper, exclusive bound of the range.</param>
<param name="rangeSize">The size of each subrange.</param>
<returns>A partitioner.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.
- -or-
-
The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.
+-or-
+The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
</member>
<member name="M:System.Collections.Concurrent.Partitioner.Create``1(``0[],System.Boolean)">
<summary>Creates an orderable partitioner from a <see cref="T:System.Array" /> instance.</summary>
projects / platform / core / csapi / tizenfx.git / blobdiff