<Rule Id="CA1066" Action="None" /> <!-- Type should implement IEquatable -->
<Rule Id="CA1067" Action="None" /> <!-- Override Object.Equals(object) when implementing IEquatable -->
<Rule Id="CA1068" Action="None" /> <!-- CancellationToken parameters must come last -->
- <Rule Id="CA1200" Action="None" /> <!-- Avoid using cref tags with a prefix -->
<Rule Id="CA1303" Action="None" /> <!-- Do not pass literals as localized parameters -->
<Rule Id="CA1304" Action="None" /> <!-- Specify CultureInfo -->
<Rule Id="CA1305" Action="None" /> <!-- Specify IFormatProvider -->
namespace System.Collections.Generic
{
/// <summary>
- /// Represents a position within a <see cref="T:System.Collections.Generic.LargeArrayBuilder`1"/>.
+ /// Represents a position within a <see cref="System.Collections.Generic.LargeArrayBuilder{T}"/>.
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
internal readonly struct CopyPosition
}
/// <summary>
- /// Represents a position at the start of a <see cref="T:System.Collections.Generic.LargeArrayBuilder`1"/>.
+ /// Represents a position at the start of a <see cref="System.Collections.Generic.LargeArrayBuilder{T}"/>.
/// </summary>
public static CopyPosition Start => default(CopyPosition);
/// </summary>
/// <param name="payloadBuffer">The buffer into which payload data should be written.</param>
/// <param name="cancellationToken">The CancellationToken used to cancel the websocket.</param>
- /// <param name="resultGetter">Used to get the result. Allows the same method to be used with both <see cref="WebSocketReceiveResult"/> and <see cref="T:System.Net.WebSockets.ValueWebSocketReceiveResult"/>.</param>
+ /// <param name="resultGetter">Used to get the result. Allows the same method to be used with both WebSocketReceiveResult and ValueWebSocketReceiveResult.</param>
/// <returns>Information about the received message.</returns>
private async ValueTask<TWebSocketReceiveResult> ReceiveAsyncPrivate<TWebSocketReceiveResultGetter, TWebSocketReceiveResult>(
Memory<byte> payloadBuffer,
{
/// <summary>
/// Provides blocking and bounding capabilities for thread-safe collections that
- /// implement <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// implement <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
/// </summary>
/// <remarks>
- /// <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/> represents a collection
+ /// <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/> represents a collection
/// that allows for thread-safe adding and removing of data.
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> is used as a wrapper
- /// for an <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/> instance, allowing
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> is used as a wrapper
+ /// for an <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/> instance, allowing
/// removal attempts from the collection to block until data is available to be removed. Similarly,
- /// a <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> can be created to enforce
+ /// a <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> can be created to enforce
/// an upper-bound on the number of data elements allowed in the
- /// <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>; addition attempts to the
+ /// <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>; addition attempts to the
/// collection may then block until space is available to store the added items. In this manner,
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> is similar to a traditional
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> is similar to a traditional
/// blocking queue data structure, except that the underlying data storage mechanism is abstracted
- /// away as an <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// away as an <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
/// </remarks>
/// <typeparam name="T">Specifies the type of elements in the collection.</typeparam>
[DebuggerTypeProxy(typeof(BlockingCollectionDebugView<>))]
private const int COMPLETE_ADDING_ON_MASK = unchecked((int)0x80000000);
#region Properties
- /// <summary>Gets the bounded capacity of this <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</summary>
+ /// <summary>Gets the bounded capacity of this <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</summary>
/// <value>The bounded capacity of this collection, or -1 if no bound was supplied.</value>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public int BoundedCapacity
{
get
}
}
- /// <summary>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked as complete for adding.</summary>
+ /// <summary>Gets whether this <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked as complete for adding.</summary>
/// <value>Whether this collection has been marked as complete for adding.</value>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public bool IsAddingCompleted
{
get
}
}
- /// <summary>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked as complete for adding and is empty.</summary>
+ /// <summary>Gets whether this <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked as complete for adding and is empty.</summary>
/// <value>Whether this collection has been marked as complete for adding and is empty.</value>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public bool IsCompleted
{
get
}
}
- /// <summary>Gets the number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
- /// <value>The number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.</value>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <summary>Gets the number of items contained in the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
+ /// <value>The number of items contained in the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.</value>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public int Count
{
get
}
}
- /// <summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is synchronized.</summary>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <summary>Gets a value indicating whether access to the <see cref="System.Collections.ICollection"/> is synchronized.</summary>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
bool ICollection.IsSynchronized
{
get
/// <summary>
/// Gets an object that can be used to synchronize access to the <see
- /// cref="T:System.Collections.ICollection"/>. This property is not supported.
+ /// cref="System.Collections.ICollection"/>. This property is not supported.
/// </summary>
- /// <exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
+ /// <exception cref="System.NotSupportedException">The SyncRoot property is not supported.</exception>
object ICollection.SyncRoot
{
get
/// <summary>Initializes a new instance of the
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>
/// class without an upper-bound.
/// </summary>
/// <remarks>
}
/// <summary>Initializes a new instance of the <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/>
/// class with the specified upper-bound.
/// </summary>
/// <param name="boundedCapacity">The bounded size of the collection.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity"/> is
+ /// <exception cref="System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity"/> is
/// not a positive value.</exception>
/// <remarks>
/// The default underlying collection is a <see cref="System.Collections.Concurrent.ConcurrentQueue{T}">ConcurrentQueue<T></see>.
{
}
- /// <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>
+ /// <summary>Initializes a new instance of the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>
/// class with the specified upper-bound and using the provided
- /// <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/> as its underlying data store.</summary>
+ /// <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/> as its underlying data store.</summary>
/// <param name="collection">The collection to use as the underlying data store.</param>
/// <param name="boundedCapacity">The bounded size of the collection.</param>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collection"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collection"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity"/> is not a positive value.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity"/> is not a positive value.</exception>
/// <exception cref="System.ArgumentException">The supplied <paramref name="collection"/> contains more values
/// than is permitted by <paramref name="boundedCapacity"/>.</exception>
public BlockingCollection(IProducerConsumerCollection<T> collection, int boundedCapacity)
Initialize(collection, boundedCapacity, count);
}
- /// <summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>
+ /// <summary>Initializes a new instance of the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>
/// class without an upper-bound and using the provided
- /// <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/> as its underlying data store.</summary>
+ /// <see cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/> as its underlying data store.</summary>
/// <param name="collection">The collection to use as the underlying data store.</param>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collection"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collection"/> argument is
/// null.</exception>
public BlockingCollection(IProducerConsumerCollection<T> collection)
{
/// <summary>
- /// Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Adds the item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item to be added to the collection. The value can be a null reference.</param>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
/// <remarks>
/// If a bounded capacity was specified when this instance of
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> was initialized,
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> was initialized,
/// a call to Add may block until space is available to store the provided item.
/// </remarks>
public void Add(T item)
}
/// <summary>
- /// Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Adds the item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <param name="item">The item to be added to the collection. The value can be a null reference.</param>
/// <param name="cancellationToken">A cancellation token to observe.</param>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
/// <remarks>
/// If a bounded capacity was specified when this instance of
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> was initialized,
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> was initialized,
/// a call to <see cref="Add(T,System.Threading.CancellationToken)"/> may block until space is available to store the provided item.
/// </remarks>
public void Add(T item, CancellationToken cancellationToken)
}
/// <summary>
- /// Attempts to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to add the specified item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item to be added to the collection.</param>
/// <returns>true if the <paramref name="item"/> could be added; otherwise, false.</returns>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
public bool TryAdd(T item)
{
return TryAddWithNoTimeValidation(item, 0, new CancellationToken());
}
/// <summary>
- /// Attempts to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to add the specified item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item to be added to the collection.</param>
/// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of milliseconds
/// </param>
/// <returns>true if the <paramref name="item"/> could be added to the collection within
/// the alloted time; otherwise, false.</returns>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative number
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
public bool TryAdd(T item, TimeSpan timeout)
{
ValidateTimeout(timeout);
}
/// <summary>
- /// Attempts to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to add the specified item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </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="System.Threading.Timeout.Infinite"/> (-1) to wait indefinitely.</param>
/// <returns>true if the <paramref name="item"/> could be added to the collection within
/// the alloted time; otherwise, false.</returns>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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 underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
public bool TryAdd(T item, int millisecondsTimeout)
{
ValidateMillisecondsTimeout(millisecondsTimeout);
}
/// <summary>
- /// Attempts to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to add the specified item to the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <returns>true if the <paramref name="item"/> could be added to the collection within
/// the alloted time; otherwise, false.</returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.InvalidOperationException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
+ /// <exception cref="System.InvalidOperationException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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 underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
public bool TryAdd(T item, int millisecondsTimeout, CancellationToken cancellationToken)
{
ValidateMillisecondsTimeout(millisecondsTimeout);
/// <exception cref="System.InvalidOperationException">the collection has already been marked
/// as complete with regards to additions.</exception>
/// <exception cref="System.ObjectDisposedException">If the collection has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection didn't accept the item.</exception>
private bool TryAddWithNoTimeValidation(T item, int millisecondsTimeout, CancellationToken cancellationToken)
{
CheckDisposed();
return waitForSemaphoreWasSuccessful;
}
- /// <summary>Takes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
+ /// <summary>Takes an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
/// <returns>The item removed from the collection.</returns>
- /// <exception cref="T:System.OperationCanceledException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> is empty and has been marked
+ /// <exception cref="System.OperationCanceledException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> is empty and has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection was modified
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
/// <remarks>A call to <see cref="Take()"/> may block until an item is available to be removed.</remarks>
public T Take()
{
return item;
}
- /// <summary>Takes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
+ /// <summary>Takes an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.</summary>
/// <returns>The item removed from the collection.</returns>
- /// <exception cref="T:System.OperationCanceledException">If the <see cref="CancellationToken"/> is
+ /// <exception cref="System.OperationCanceledException">If the <see cref="CancellationToken"/> is
/// canceled or the <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> is empty and has been marked
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> is empty and has been marked
/// as complete with regards to additions.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection was modified
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
/// <remarks>A call to <see cref="Take(CancellationToken)"/> may block until an item is available to be removed.</remarks>
public T Take(CancellationToken cancellationToken)
{
}
/// <summary>
- /// Attempts to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to remove an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item removed from the collection.</param>
/// <returns>true if an item could be removed; otherwise, false.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection was modified
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
public bool TryTake([MaybeNullWhen(false)] out T item)
{
return TryTake(out item, 0, CancellationToken.None);
}
/// <summary>
- /// Attempts to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to remove an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item removed from the collection.</param>
/// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of milliseconds
/// </param>
/// <returns>true if an item could be removed from the collection within
/// the alloted time; otherwise, false.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative number
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">The underlying collection was modified
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
public bool TryTake([MaybeNullWhen(false)] out T item, TimeSpan timeout)
{
ValidateTimeout(timeout);
}
/// <summary>
- /// Attempts to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to remove an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// </summary>
/// <param name="item">The item removed from the collection.</param>
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// cref="System.Threading.Timeout.Infinite"/> (-1) to wait indefinitely.</param>
/// <returns>true if an item could be removed from the collection within
/// the alloted time; otherwise, false.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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 underlying collection was modified
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
public bool TryTake([MaybeNullWhen(false)] out T item, int millisecondsTimeout)
{
ValidateMillisecondsTimeout(millisecondsTimeout);
}
/// <summary>
- /// Attempts to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/>.
+ /// Attempts to remove an item from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/>.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <returns>true if an item could be removed from the collection within
/// the alloted time; otherwise, false.</returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="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 underlying collection was modified
+ /// <exception cref="System.InvalidOperationException">The underlying collection was modified
/// outside of this <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
public bool TryTake([MaybeNullWhen(false)] out T item, int millisecondsTimeout, CancellationToken cancellationToken)
{
ValidateMillisecondsTimeout(millisecondsTimeout);
/// <summary>
/// Adds the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item to be added to one of the collections.</param>
/// <returns>The index of the collection in the <paramref name="collections"/> array to which the item was added.</returns>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>
/// If a bounded capacity was specified when all of the
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances were initialized,
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances were initialized,
/// a call to AddToAny may block until space is available in one of the collections
/// to store the provided item.
/// </remarks>
/// <summary>
/// Adds the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <param name="cancellationToken">A cancellation token to observe.</param>
/// <returns>The index of the collection in the <paramref name="collections"/> array to which the item was added.</returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>
/// If a bounded capacity was specified when all of the
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances were initialized,
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances were initialized,
/// a call to AddToAny may block until space is available in one of the collections
/// to store the provided item.
/// </remarks>
/// <summary>
/// Attempts to add the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item to be added to one of the collections.</param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
public static int TryAddToAny(BlockingCollection<T>[] collections, T item)
{
/// <summary>
/// Attempts to add the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item to be added to one of the collections.</param>
/// </param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative number
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
public static int TryAddToAny(BlockingCollection<T>[] collections, T item, TimeSpan timeout)
{
/// <summary>
/// Attempts to add the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item to be added to one of the collections.</param>
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// cref="System.Threading.Timeout.Infinite"/> (-1) to wait indefinitely.</param> /// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
public static int TryAddToAny(BlockingCollection<T>[] collections, T item, int millisecondsTimeout)
{
/// <summary>
/// Attempts to add the specified item to any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// array to which the item was added, or -1 if the item could not be added.</returns>
/// <param name="cancellationToken">A cancellation token to observe.</param>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// <exception cref="System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
public static int TryAddToAny(BlockingCollection<T>[] collections, T item, int millisecondsTimeout, CancellationToken cancellationToken)
{
}
/// <summary>
/// Takes an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item removed from one of the collections.</param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TakeFromAny may block until an item is available to be removed.</remarks>
public static int TakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item)
/// <summary>
/// Takes an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <param name="cancellationToken">A cancellation token to observe.</param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TakeFromAny may block until an item is available to be removed.</remarks>
public static int TakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item, CancellationToken cancellationToken)
/// <summary>
/// Attempts to remove an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item removed from one of the collections.</param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TryTakeFromAny may block until an item is available to be removed.</remarks>
public static int TryTakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item)
/// <summary>
/// Attempts to remove an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item removed from one of the collections.</param>
/// </param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative number
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TryTakeFromAny may block until an item is available to be removed.</remarks>
public static int TryTakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item, TimeSpan timeout)
/// <summary>
/// Attempts to remove an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// </summary>
/// <param name="collections">The array of collections.</param>
/// <param name="item">The item removed from one of the collections.</param>
/// cref="System.Threading.Timeout.Infinite"/> (-1) to wait indefinitely.</param>
/// <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>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TryTakeFromAny may block until an item is available to be removed.</remarks>
public static int TryTakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item, int millisecondsTimeout)
/// <summary>
/// Attempts to remove an item from any one of the specified
- /// <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances.
+ /// <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances.
/// A <see cref="System.OperationCanceledException"/> is thrown if the <see cref="CancellationToken"/> is
/// canceled.
/// </summary>
/// <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>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collections"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collections"/> argument is
/// null.</exception>
- /// <exception cref="T:System.ArgumentException">The <paramref name="collections"/> argument is
+ /// <exception cref="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{T}"/> instances has been disposed.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ObjectDisposedException">At least one of the <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances has been disposed.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified
+ /// <exception cref="System.InvalidOperationException">At least one of the underlying collections was modified
/// outside of its <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException">The count of <paramref name="collections"/> is greater than the maximum size of
/// 62 for STA and 63 for MTA.</exception>
/// <remarks>A call to TryTakeFromAny may block until an item is available to be removed.</remarks>
public static int TryTakeFromAny(BlockingCollection<T>[] collections, [MaybeNull] out T item, int millisecondsTimeout, CancellationToken cancellationToken)
}
/// <summary>
- /// Marks the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instances
+ /// Marks the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instances
/// as not accepting any more additions.
/// </summary>
/// <remarks>
/// After a collection has been marked as complete for adding, adding to the collection is not permitted
/// and attempts to remove from the collection will not wait when the collection is empty.
/// </remarks>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public void CompleteAdding()
{
CheckDisposed();
/// <summary>
- /// Releases resources used by the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.
+ /// Releases resources used by the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.
/// </summary>
public void Dispose()
{
}
/// <summary>
- /// Releases resources used by the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance.
+ /// Releases resources used by the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance.
/// </summary>
/// <param name="disposing">Whether being disposed explicitly (true) or due to a finalizer (false).</param>
protected virtual void Dispose(bool disposing)
}
}
- /// <summary>Copies the items from the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance into a new array.</summary>
+ /// <summary>Copies the items from the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance into a new array.</summary>
/// <returns>An array containing copies of the elements of the collection.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
/// <remarks>
/// The copied elements are not removed from the collection.
/// </remarks>
return _collection.ToArray();
}
- /// <summary>Copies all of the items in the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance
+ /// <summary>Copies all of the items in the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance
/// to a compatible one-dimensional array, starting at the specified index of the target array.
/// </summary>
/// <param name="array">The one-dimensional array that is the destination of the elements copied from
- /// the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance. The array must have zero-based indexing.</param>
+ /// the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance. 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">The <paramref name="array"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="array"/> argument is
/// null.</exception>
/// <exception cref="System.ArgumentOutOfRangeException">The <paramref name="index"/> argument is less than zero.</exception>
/// <exception cref="System.ArgumentException">The <paramref name="index"/> argument is equal to or greater
/// than the length of the <paramref name="array"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public void CopyTo(T[] array, int index)
{
((ICollection)this).CopyTo(array, index);
}
- /// <summary>Copies all of the items in the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance
+ /// <summary>Copies all of the items in the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance
/// to a compatible one-dimensional array, starting at the specified index of the target array.
/// </summary>
/// <param name="array">The one-dimensional array that is the destination of the elements copied from
- /// the <see cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> instance. The array must have zero-based indexing.</param>
+ /// the <see cref="System.Collections.Concurrent.BlockingCollection{T}"/> instance. 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">The <paramref name="array"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="array"/> argument is
/// null.</exception>
/// <exception cref="System.ArgumentOutOfRangeException">The <paramref name="index"/> argument is less than zero.</exception>
/// <exception cref="System.ArgumentException">The <paramref name="index"/> argument is equal to or greater
/// than the length of the <paramref name="array"/>, the array is multidimensional, or the type parameter for the collection
/// cannot be cast automatically to the type of the destination array.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
void ICollection.CopyTo(Array array, int index)
{
CheckDisposed();
}
}
- /// <summary>Provides a consuming <see cref="T:System.Collections.Generics.IEnumerable{T}"/> for items in the collection.</summary>
- /// <returns>An <see cref="T:System.Collections.Generics.IEnumerable{T}"/> that removes and returns items from the collection.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <summary>Provides a consuming <see cref="System.Collections.Generic.IEnumerable{T}"/> for items in the collection.</summary>
+ /// <returns>An <see cref="System.Collections.Generic.IEnumerable{T}"/> that removes and returns items from the collection.</returns>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
public IEnumerable<T> GetConsumingEnumerable()
{
return GetConsumingEnumerable(CancellationToken.None);
}
- /// <summary>Provides a consuming <see cref="T:System.Collections.Generics.IEnumerable{T}"/> for items in the collection.
+ /// <summary>Provides a consuming <see cref="System.Collections.Generic.IEnumerable{T}"/> for items in the collection.
/// Calling MoveNext on the returned enumerable will block if there is no data available, or will
/// throw an <see cref="System.OperationCanceledException"/> if the <see cref="CancellationToken"/> is canceled.
/// </summary>
/// <param name="cancellationToken">A cancellation token to observe.</param>
- /// <returns>An <see cref="T:System.Collections.Generics.IEnumerable{T}"/> that removes and returns items from the collection.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <returns>An <see cref="System.Collections.Generic.IEnumerable{T}"/> that removes and returns items from the collection.</returns>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken"/> is canceled.</exception>
public IEnumerable<T> GetConsumingEnumerable(CancellationToken cancellationToken)
{
}
}
- /// <summary>Provides an <see cref="T:System.Collections.Generics.IEnumerator{T}"/> for items in the collection.</summary>
- /// <returns>An <see cref="T:System.Collections.Generics.IEnumerator{T}"/> for the items in the collection.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <summary>Provides an <see cref="System.Collections.Generic.IEnumerator{T}"/> for items in the collection.</summary>
+ /// <returns>An <see cref="System.Collections.Generic.IEnumerator{T}"/> for the items in the collection.</returns>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
IEnumerator<T> IEnumerable<T>.GetEnumerator()
{
CheckDisposed();
return _collection.GetEnumerator();
}
- /// <summary>Provides an <see cref="T:System.Collections.IEnumerator"/> for items in the collection.</summary>
- /// <returns>An <see cref="T:System.Collections.IEnumerator"/> for the items in the collection.</returns>
- /// <exception cref="T:System.ObjectDisposedException">The <see
- /// cref="T:System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
+ /// <summary>Provides an <see cref="System.Collections.IEnumerator"/> for items in the collection.</summary>
+ /// <returns>An <see cref="System.Collections.IEnumerator"/> for the items in the collection.</returns>
+ /// <exception cref="System.ObjectDisposedException">The <see
+ /// cref="System.Collections.Concurrent.BlockingCollection{T}"/> has been disposed.</exception>
IEnumerator IEnumerable.GetEnumerator()
{
return ((IEnumerable<T>)this).GetEnumerator();
/// <summary>
/// Copies the <see cref="ConcurrentBag{T}"/> elements to an existing
- /// one-dimensional <see cref="T:System.Array">Array</see>, starting at the specified array
+ /// one-dimensional <see cref="System.Array">Array</see>, starting at the specified array
/// index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array">Array</see> that is the
+ /// <param name="array">The one-dimensional <see cref="System.Array">Array</see> that is the
/// destination of the elements copied from the
/// <see cref="ConcurrentBag{T}"/>. The <see
- /// cref="T:System.Array">Array</see> must have zero-based indexing.</param>
+ /// cref="System.Array">Array</see> must have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// <exception cref="ArgumentNullException"><paramref name="array"/> is a null reference (Nothing in
}
/// <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.
+ /// Copies the elements of the <see cref="System.Collections.ICollection"/> to an <see
+ /// cref="System.Array"/>, starting at a particular
+ /// <see cref="System.Array"/> index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array">Array</see> that is the
+ /// <param name="array">The one-dimensional <see cref="System.Array">Array</see> that is the
/// destination of the elements copied from the
/// <see cref="ConcurrentBag{T}"/>. The <see
- /// cref="T:System.Array">Array</see> must have zero-based indexing.</param>
+ /// cref="System.Array">Array</see> must have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// <exception cref="ArgumentNullException"><paramref name="array"/> is a null reference (Nothing in
/// <paramref name="array"/> is multidimensional. -or-
/// <paramref name="array"/> does not have zero-based indexing. -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
+ /// -or- The number of elements in the source <see cref="System.Collections.ICollection"/> is
/// greater than the available space from <paramref name="index"/> to the end of the destination
/// <paramref name="array"/>. -or- The type of the source <see
- /// cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the
+ /// cref="System.Collections.ICollection"/> cannot be cast automatically to the type of the
/// destination <paramref name="array"/>.
/// </exception>
void ICollection.CopyTo(Array array, int index)
}
/// <summary>
- /// Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is
+ /// Gets a value indicating whether access to the <see cref="System.Collections.ICollection"/> is
/// synchronized with the SyncRoot.
/// </summary>
- /// <value>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized
+ /// <value>true if access to the <see cref="System.Collections.ICollection"/> is synchronized
/// with the SyncRoot; otherwise, false. For <see cref="ConcurrentBag{T}"/>, this property always
/// returns false.</value>
bool ICollection.IsSynchronized => false;
/// <summary>
/// Gets an object that can be used to synchronize access to the <see
- /// cref="T:System.Collections.ICollection"/>. This property is not supported.
+ /// cref="System.Collections.ICollection"/>. This property is not supported.
/// </summary>
- /// <exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
+ /// <exception cref="System.NotSupportedException">The SyncRoot property is not supported.</exception>
object ICollection.SyncRoot
{
get { throw new NotSupportedException(SR.ConcurrentCollection_SyncRoot_NotSupported); }
/// <param name="capacity">The initial number of elements that the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>
/// can contain.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="concurrencyLevel"/> is
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="concurrencyLevel"/> is
/// less than 1.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="capacity"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"> <paramref name="capacity"/> is less than
/// 0.</exception>
public ConcurrentDictionary(int concurrencyLevel, int capacity) : this(concurrencyLevel, capacity, false, null) { }
/// <summary>
/// Initializes a new instance of the <see cref="ConcurrentDictionary{TKey,TValue}"/>
/// class that contains elements copied from the specified <see
- /// cref="T:System.Collections.IEnumerable{KeyValuePair{TKey,TValue}}"/>, has the default concurrency
+ /// cref="System.Collections.Generic.IEnumerable{T}"/>, has the default concurrency
/// level, has the default initial capacity, and uses the default comparer for the key type.
/// </summary>
/// <param name="collection">The <see
- /// cref="T:System.Collections.IEnumerable{KeyValuePair{TKey,TValue}}"/> whose elements are copied to
+ /// cref="System.Collections.Generic.IEnumerable{T}"/> whose elements are copied to
/// the new
/// <see cref="ConcurrentDictionary{TKey,TValue}"/>.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="collection"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentException"><paramref name="collection"/> contains one or more
+ /// <exception cref="System.ArgumentException"><paramref name="collection"/> contains one or more
/// duplicate keys.</exception>
public ConcurrentDictionary(IEnumerable<KeyValuePair<TKey, TValue>> collection) : this(collection, null) { }
/// <summary>
/// Initializes a new instance of the <see cref="ConcurrentDictionary{TKey,TValue}"/>
/// class that is empty, has the specified concurrency level and capacity, and uses the specified
- /// <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>.
+ /// <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>.
/// </summary>
- /// <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>
+ /// <param name="comparer">The <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>
/// implementation to use when comparing keys.</param>
public ConcurrentDictionary(IEqualityComparer<TKey>? comparer) : this(DefaultConcurrencyLevel, DefaultCapacity, true, comparer) { }
/// <summary>
/// Initializes a new instance of the <see cref="ConcurrentDictionary{TKey,TValue}"/>
/// class that contains elements copied from the specified <see
- /// cref="T:System.Collections.IEnumerable"/>, has the default concurrency level, has the default
+ /// cref="System.Collections.IEnumerable"/>, has the default concurrency level, has the default
/// initial capacity, and uses the specified
- /// <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>.
+ /// <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>.
/// </summary>
/// <param name="collection">The <see
- /// cref="T:System.Collections.IEnumerable{KeyValuePair{TKey,TValue}}"/> whose elements are copied to
+ /// cref="System.Collections.Generic.IEnumerable{T}"/> whose elements are copied to
/// the new
/// <see cref="ConcurrentDictionary{TKey,TValue}"/>.</param>
- /// <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>
+ /// <param name="comparer">The <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>
/// implementation to use when comparing keys.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="collection"/> is a null reference
/// (Nothing in Visual Basic).</exception>
public ConcurrentDictionary(IEnumerable<KeyValuePair<TKey, TValue>> collection, IEqualityComparer<TKey>? comparer)
: this(comparer)
/// <summary>
/// Initializes a new instance of the <see cref="ConcurrentDictionary{TKey,TValue}"/>
- /// class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable"/>,
+ /// class that contains elements copied from the specified <see cref="System.Collections.IEnumerable"/>,
/// has the specified concurrency level, has the specified initial capacity, and uses the specified
- /// <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>.
+ /// <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>.
/// </summary>
/// <param name="concurrencyLevel">The estimated number of threads that will update the
/// <see cref="ConcurrentDictionary{TKey,TValue}"/> concurrently.</param>
- /// <param name="collection">The <see cref="T:System.Collections.IEnumerable{KeyValuePair{TKey,TValue}}"/> whose elements are copied to the new
+ /// <param name="collection">The <see cref="System.Collections.Generic.IEnumerable{T}"/> whose elements are copied to the new
/// <see cref="ConcurrentDictionary{TKey,TValue}"/>.</param>
- /// <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/> implementation to use
+ /// <param name="comparer">The <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/> implementation to use
/// when comparing keys.</param>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="collection"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="concurrencyLevel"/> is less than 1.
/// </exception>
- /// <exception cref="T:System.ArgumentException"><paramref name="collection"/> contains one or more duplicate keys.</exception>
+ /// <exception cref="System.ArgumentException"><paramref name="collection"/> contains one or more duplicate keys.</exception>
public ConcurrentDictionary(
int concurrencyLevel, IEnumerable<KeyValuePair<TKey, TValue>> collection, IEqualityComparer<TKey>? comparer)
: this(concurrencyLevel, DefaultCapacity, false, comparer)
/// <summary>
/// Initializes a new instance of the <see cref="ConcurrentDictionary{TKey,TValue}"/>
/// class that is empty, has the specified concurrency level, has the specified initial capacity, and
- /// uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>.
+ /// uses the specified <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>.
/// </summary>
/// <param name="concurrencyLevel">The estimated number of threads that will update the
/// <see cref="ConcurrentDictionary{TKey,TValue}"/> concurrently.</param>
/// <param name="capacity">The initial number of elements that the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>
/// can contain.</param>
- /// <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{TKey}"/>
+ /// <param name="comparer">The <see cref="System.Collections.Generic.IEqualityComparer{TKey}"/>
/// implementation to use when comparing keys.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="concurrencyLevel"/> is less than 1. -or-
/// <paramref name="capacity"/> is less than 0.
/// </exception>
/// <returns>true if the key/value pair was added to the <see cref="ConcurrentDictionary{TKey,
/// TValue}"/>
/// successfully; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The <see cref="ConcurrentDictionary{TKey, TValue}"/>
+ /// <exception cref="System.OverflowException">The <see cref="ConcurrentDictionary{TKey, TValue}"/>
/// contains too many elements.</exception>
public bool TryAdd(TKey key, TValue value)
{
/// TValue}"/>.</param>
/// <returns>true if the <see cref="ConcurrentDictionary{TKey, TValue}"/> contains an element with
/// the specified key; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
public bool ContainsKey(TKey key)
{
/// name="TValue"/>
/// if the operation failed.</param>
/// <returns>true if an object was removed successfully; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
public bool TryRemove(TKey key, [MaybeNullWhen(false)] out TValue value)
{
/// <typeparamref name="TValue"/>, if the operation failed.</param>
/// <returns>true if the key was found in the <see cref="ConcurrentDictionary{TKey,TValue}"/>;
/// otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
public bool TryGetValue(TKey key, [MaybeNullWhen(false)] out TValue value)
{
/// <returns>true if the value with <paramref name="key"/> was equal to <paramref
/// name="comparisonValue"/> and replaced with <paramref name="newValue"/>; otherwise,
/// false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null
/// reference.</exception>
public bool TryUpdate(TKey key, TValue newValue, TValue comparisonValue)
{
/// <returns>true if the value with <paramref name="key"/> was equal to <paramref
/// name="comparisonValue"/> and replaced with <paramref name="newValue"/>; otherwise,
/// false.</returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null
/// reference.</exception>
private bool TryUpdateInternal(TKey key, int hashcode, TValue newValue, TValue comparisonValue)
{
}
/// <summary>
- /// Copies the elements of the <see cref="T:System.Collections.Generic.ICollection"/> to an array of
- /// type <see cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/>, starting at the
+ /// Copies the elements of the <see cref="System.Collections.Generic.ICollection{T}"/> to an array of
+ /// type <see cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/>, starting at the
/// specified array index.
/// </summary>
/// <param name="array">The one-dimensional array of type <see
- /// cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
+ /// cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
/// that is the destination of the <see
- /// cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/> elements copied from the <see
- /// cref="T:System.Collections.ICollection"/>. The array must have zero-based indexing.</param>
+ /// cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/> elements copied from the <see
+ /// cref="System.Collections.ICollection"/>. 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
+ /// <exception cref="System.ArgumentNullException"><paramref name="array"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="index"/> is less than
/// 0.</exception>
- /// <exception cref="T:System.ArgumentException"><paramref name="index"/> is equal to or greater than
+ /// <exception cref="System.ArgumentException"><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"/>
+ /// cref="System.Collections.ICollection"/>
/// is greater than the available space from <paramref name="index"/> to the end of the destination
/// <paramref name="array"/>.</exception>
void ICollection<KeyValuePair<TKey, TValue>>.CopyTo(KeyValuePair<TKey, TValue>[] array, int index)
/// <param name="key">The key of the value to get or set.</param>
/// <value>The value associated with the specified key. If the specified key is not found, a get
/// operation throws a
- /// <see cref="T:System.Collections.Generic.KeyNotFoundException"/>, and a set operation creates a new
+ /// <see cref="System.Collections.Generic.KeyNotFoundException"/>, and a set operation creates a new
/// element with the specified key.</value>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.Collections.Generic.KeyNotFoundException">The property is retrieved and
+ /// <exception cref="System.Collections.Generic.KeyNotFoundException">The property is retrieved and
/// <paramref name="key"/>
/// does not exist in the collection.</exception>
public TValue this[TKey key]
/// Gets the number of key/value pairs contained in the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>.
/// </summary>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <value>The number of key/value pairs contained in the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>.</value>
/// cref="ConcurrentDictionary{TKey,TValue}"/>. Should only be used after all locks
/// have been acquired.
/// </summary>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <value>The number of key/value pairs contained in the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>.</value>
/// </summary>
/// <param name="key">The key of the element to add.</param>
/// <param name="valueFactory">The function used to generate a value for the key</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="valueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="valueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The value for the key. This will be either the existing value for the key if the
/// key is already in the dictionary, or the new value for the key as returned by valueFactory
/// <param name="key">The key of the element to add.</param>
/// <param name="valueFactory">The function used to generate a value for the key</param>
/// <param name="factoryArgument">An argument value to pass into <paramref name="valueFactory"/>.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="valueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="valueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The value for the key. This will be either the existing value for the key if the
/// key is already in the dictionary, or the new value for the key as returned by valueFactory
/// </summary>
/// <param name="key">The key of the element to add.</param>
/// <param name="value">the value to be added, if the key does not already exist</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The value for the key. This will be either the existing value for the key if the
/// key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
/// <param name="updateValueFactory">The function used to generate a new value for an existing key
/// based on the key's existing value</param>
/// <param name="factoryArgument">An argument to pass into <paramref name="addValueFactory"/> and <paramref name="updateValueFactory"/>.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="addValueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="addValueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The new value for the key. This will be either be the result of addValueFactory (if the key was
/// absent) or the result of updateValueFactory (if the key was present).</returns>
/// <param name="addValueFactory">The function used to generate a value for an absent key</param>
/// <param name="updateValueFactory">The function used to generate a new value for an existing key
/// based on the key's existing value</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="addValueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="addValueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The new value for the key. This will be either the result of addValueFactory (if the key was
/// absent) or the result of updateValueFactory (if the key was present).</returns>
/// <param name="addValue">The value to be added for an absent key</param>
/// <param name="updateValueFactory">The function used to generate a new value for an existing key based on
/// the key's existing value</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="updateValueFactory"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
/// <returns>The new value for the key. This will be either the value of addValue (if the key was
/// absent) or the result of updateValueFactory (if the key was present).</returns>
/// <summary>
/// Adds the specified key and value to the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.IDictionary{TKey,TValue}"/>.
/// </summary>
/// <param name="key">The object to use as the key of the element to add.</param>
/// <param name="value">The object to use as the value of the element to add.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
- /// <exception cref="T:System.ArgumentException">
+ /// <exception cref="System.ArgumentException">
/// An element with the same key already exists in the <see
/// cref="ConcurrentDictionary{TKey,TValue}"/>.</exception>
void IDictionary<TKey, TValue>.Add(TKey key, TValue value)
/// <summary>
/// Removes the element with the specified key from the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.IDictionary{TKey,TValue}"/>.
/// </summary>
/// <param name="key">The key of the element to remove.</param>
/// <returns>true if the element is successfully remove; otherwise false. This method also returns
/// false if
/// <paramref name="key"/> was not found in the original <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.IDictionary{TKey,TValue}"/>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
bool IDictionary<TKey, TValue>.Remove(TKey key)
{
/// <summary>
/// Gets a collection containing the keys in the <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.Generic.ICollection{TKey}"/> containing the keys in the
- /// <see cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.</value>
+ /// <value>An <see cref="System.Collections.Generic.ICollection{TKey}"/> containing the keys in the
+ /// <see cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.</value>
public ICollection<TKey> Keys
{
get { return GetKeys(); }
}
/// <summary>
- /// Gets an <see cref="T:System.Collections.Generic.IEnumerable{TKey}"/> containing the keys of
- /// the <see cref="T:System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.
+ /// Gets an <see cref="System.Collections.Generic.IEnumerable{TKey}"/> containing the keys of
+ /// the <see cref="System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.Generic.IEnumerable{TKey}"/> containing the keys of
- /// the <see cref="T:System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.</value>
+ /// <value>An <see cref="System.Collections.Generic.IEnumerable{TKey}"/> containing the keys of
+ /// the <see cref="System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.</value>
IEnumerable<TKey> IReadOnlyDictionary<TKey, TValue>.Keys
{
get { return GetKeys(); }
/// <summary>
/// Gets a collection containing the values in the <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.Generic.ICollection{TValue}"/> containing the values in
+ /// <value>An <see cref="System.Collections.Generic.ICollection{TValue}"/> containing the values in
/// the
- /// <see cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.</value>
+ /// <see cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.</value>
public ICollection<TValue> Values
{
get { return GetValues(); }
}
/// <summary>
- /// Gets an <see cref="T:System.Collections.Generic.IEnumerable{TValue}"/> containing the values
- /// in the <see cref="T:System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.
+ /// Gets an <see cref="System.Collections.Generic.IEnumerable{TValue}"/> containing the values
+ /// in the <see cref="System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.Generic.IEnumerable{TValue}"/> containing the
- /// values in the <see cref="T:System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.</value>
+ /// <value>An <see cref="System.Collections.Generic.IEnumerable{TValue}"/> containing the
+ /// values in the <see cref="System.Collections.Generic.IReadOnlyDictionary{TKey,TValue}"/>.</value>
IEnumerable<TValue> IReadOnlyDictionary<TKey, TValue>.Values
{
get { return GetValues(); }
#region ICollection<KeyValuePair<TKey,TValue>> Members
/// <summary>
- /// Adds the specified value to the <see cref="T:System.Collections.Generic.ICollection{TValue}"/>
+ /// Adds the specified value to the <see cref="System.Collections.Generic.ICollection{TValue}"/>
/// with the specified key.
/// </summary>
- /// <param name="keyValuePair">The <see cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
+ /// <param name="keyValuePair">The <see cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
/// structure representing the key and value to add to the <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.</param>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="keyValuePair"/> of <paramref
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.</param>
+ /// <exception cref="System.ArgumentNullException">The <paramref name="keyValuePair"/> of <paramref
/// name="keyValuePair"/> is null.</exception>
- /// <exception cref="T:System.OverflowException">The <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>
+ /// <exception cref="System.OverflowException">The <see
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>
/// contains too many elements.</exception>
- /// <exception cref="T:System.ArgumentException">An element with the same key already exists in the
- /// <see cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/></exception>
+ /// <exception cref="System.ArgumentException">An element with the same key already exists in the
+ /// <see cref="System.Collections.Generic.Dictionary{TKey,TValue}"/></exception>
void ICollection<KeyValuePair<TKey, TValue>>.Add(KeyValuePair<TKey, TValue> keyValuePair)
{
((IDictionary<TKey, TValue>)this).Add(keyValuePair.Key, keyValuePair.Value);
}
/// <summary>
- /// Determines whether the <see cref="T:System.Collections.Generic.ICollection{TKey,TValue}"/>
+ /// Determines whether the <see cref="System.Collections.Generic.ICollection{T}"/>
/// contains a specific key and value.
/// </summary>
- /// <param name="keyValuePair">The <see cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
+ /// <param name="keyValuePair">The <see cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
/// structure to locate in the <see
- /// cref="T:System.Collections.Generic.ICollection{TValue}"/>.</param>
+ /// cref="System.Collections.Generic.ICollection{TValue}"/>.</param>
/// <returns>true if the <paramref name="keyValuePair"/> is found in the <see
- /// cref="T:System.Collections.Generic.ICollection{TKey,TValue}"/>; otherwise, false.</returns>
+ /// cref="System.Collections.Generic.ICollection{T}"/>; otherwise, false.</returns>
bool ICollection<KeyValuePair<TKey, TValue>>.Contains(KeyValuePair<TKey, TValue> keyValuePair)
{
TValue value;
/// <summary>
/// Gets a value indicating whether the dictionary is read-only.
/// </summary>
- /// <value>true if the <see cref="T:System.Collections.Generic.ICollection{TKey,TValue}"/> is
+ /// <value>true if the <see cref="System.Collections.Generic.ICollection{T}"/> is
/// read-only; otherwise, false. For <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>, this property always returns
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>, this property always returns
/// false.</value>
bool ICollection<KeyValuePair<TKey, TValue>>.IsReadOnly
{
/// Removes a key and value from the dictionary.
/// </summary>
/// <param name="keyValuePair">The <see
- /// cref="T:System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
+ /// cref="System.Collections.Generic.KeyValuePair{TKey,TValue}"/>
/// structure representing the key and value to remove from the <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.</param>
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.</param>
/// <returns>true if the key and value represented by <paramref name="keyValuePair"/> is successfully
/// found and removed; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException">The Key property of <paramref
+ /// <exception cref="System.ArgumentNullException">The Key property of <paramref
/// name="keyValuePair"/> is a null reference (Nothing in Visual Basic).</exception>
bool ICollection<KeyValuePair<TKey, TValue>>.Remove(KeyValuePair<TKey, TValue> keyValuePair)
{
/// </summary>
/// <param name="key">The object to use as the key.</param>
/// <param name="value">The object to use as the value.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.OverflowException">The dictionary contains too many
+ /// <exception cref="System.OverflowException">The dictionary contains too many
/// elements.</exception>
- /// <exception cref="T:System.ArgumentException">
+ /// <exception cref="System.ArgumentException">
/// <paramref name="key"/> is of a type that is not assignable to the key type <typeparamref
- /// name="TKey"/> of the <see cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>. -or-
+ /// name="TKey"/> of the <see cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>. -or-
/// <paramref name="value"/> is of a type that is not assignable to <typeparamref name="TValue"/>,
- /// the type of values in the <see cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.
+ /// the type of values in the <see cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.
/// -or- A value with the same key already exists in the <see
- /// cref="T:System.Collections.Generic.Dictionary{TKey,TValue}"/>.
+ /// cref="System.Collections.Generic.Dictionary{TKey,TValue}"/>.
/// </exception>
void IDictionary.Add(object key, object? value)
{
}
/// <summary>
- /// Gets whether the <see cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> contains an
+ /// Gets whether the <see cref="System.Collections.IDictionary"/> contains an
/// element with the specified key.
/// </summary>
/// <param name="key">The key to locate in the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.</param>
- /// <returns>true if the <see cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> contains
+ /// cref="System.Collections.IDictionary"/>.</param>
+ /// <returns>true if the <see cref="System.Collections.IDictionary"/> contains
/// an element with the specified key; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException"> <paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"> <paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
bool IDictionary.Contains(object key)
{
return (key is TKey) && this.ContainsKey((TKey)key);
}
- /// <summary>Provides an <see cref="T:System.Collections.Generics.IDictionaryEnumerator"/> for the
- /// <see cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.</summary>
- /// <returns>An <see cref="T:System.Collections.Generics.IDictionaryEnumerator"/> for the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.</returns>
+ /// <summary>Provides an <see cref="System.Collections.IDictionaryEnumerator"/> for the
+ /// <see cref="System.Collections.IDictionary"/>.</summary>
+ /// <returns>An <see cref="System.Collections.IDictionaryEnumerator"/> for the <see
+ /// cref="System.Collections.IDictionary"/>.</returns>
IDictionaryEnumerator IDictionary.GetEnumerator()
{
return new DictionaryEnumerator(this);
/// <summary>
/// Gets a value indicating whether the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> has a fixed size.
+ /// cref="System.Collections.IDictionary"/> has a fixed size.
/// </summary>
- /// <value>true if the <see cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> has a
+ /// <value>true if the <see cref="System.Collections.IDictionary"/> has a
/// fixed size; otherwise, false. For <see
- /// cref="T:System.Collections.Generic.ConcurrentDictionary{TKey,TValue}"/>, this property always
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>, this property always
/// returns false.</value>
bool IDictionary.IsFixedSize
{
/// <summary>
/// Gets a value indicating whether the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> is read-only.
+ /// cref="System.Collections.IDictionary"/> is read-only.
/// </summary>
- /// <value>true if the <see cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/> is
+ /// <value>true if the <see cref="System.Collections.IDictionary"/> is
/// read-only; otherwise, false. For <see
- /// cref="T:System.Collections.Generic.ConcurrentDictionary{TKey,TValue}"/>, this property always
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>, this property always
/// returns false.</value>
bool IDictionary.IsReadOnly
{
}
/// <summary>
- /// Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.
+ /// Gets an <see cref="System.Collections.ICollection"/> containing the keys of the <see
+ /// cref="System.Collections.IDictionary"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see
- /// cref="T:System.Collections.Generic.IDictionary{TKey,TValue}"/>.</value>
+ /// <value>An <see cref="System.Collections.ICollection"/> containing the keys of the <see
+ /// cref="System.Collections.IDictionary"/>.</value>
ICollection IDictionary.Keys
{
get { return GetKeys(); }
/// <summary>
/// Removes the element with the specified key from the <see
- /// cref="T:System.Collections.IDictionary"/>.
+ /// cref="System.Collections.IDictionary"/>.
/// </summary>
/// <param name="key">The key of the element to remove.</param>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
void IDictionary.Remove(object key)
{
}
/// <summary>
- /// Gets an <see cref="T:System.Collections.ICollection"/> containing the values in the <see
- /// cref="T:System.Collections.IDictionary"/>.
+ /// Gets an <see cref="System.Collections.ICollection"/> containing the values in the <see
+ /// cref="System.Collections.IDictionary"/>.
/// </summary>
- /// <value>An <see cref="T:System.Collections.ICollection"/> containing the values in the <see
- /// cref="T:System.Collections.IDictionary"/>.</value>
+ /// <value>An <see cref="System.Collections.ICollection"/> containing the values in the <see
+ /// cref="System.Collections.IDictionary"/>.</value>
ICollection IDictionary.Values
{
get { return GetValues(); }
/// <value>The value associated with the specified key, or a null reference (Nothing in Visual Basic)
/// if <paramref name="key"/> is not in the dictionary or <paramref name="key"/> is of a type that is
/// not assignable to the key type <typeparamref name="TKey"/> of the <see
- /// cref="T:System.Collections.Generic.ConcurrentDictionary{TKey,TValue}"/>.</value>
- /// <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is a null reference
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>.</value>
+ /// <exception cref="System.ArgumentNullException"><paramref name="key"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentException">
+ /// <exception cref="System.ArgumentException">
/// A value is being assigned, and <paramref name="key"/> is of a type that is not assignable to the
/// key type <typeparamref name="TKey"/> of the <see
- /// cref="T:System.Collections.Generic.ConcurrentDictionary{TKey,TValue}"/>. -or- A value is being
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>. -or- A value is being
/// assigned, and <paramref name="key"/> is of a type that is not assignable to the value type
/// <typeparamref name="TValue"/> of the <see
- /// cref="T:System.Collections.Generic.ConcurrentDictionary{TKey,TValue}"/>
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>
/// </exception>
object? IDictionary.this[object key]
{
#region ICollection Members
/// <summary>
- /// Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an array, starting
+ /// Copies the elements of the <see cref="System.Collections.ICollection"/> to an array, starting
/// at the specified array index.
/// </summary>
/// <param name="array">The one-dimensional array that is the destination of the elements copied from
- /// the <see cref="T:System.Collections.ICollection"/>. The array must have zero-based
+ /// the <see cref="System.Collections.ICollection"/>. 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
+ /// <exception cref="System.ArgumentNullException"><paramref name="array"/> is a null reference
/// (Nothing in Visual Basic).</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="index"/> is less than
/// 0.</exception>
- /// <exception cref="T:System.ArgumentException"><paramref name="index"/> is equal to or greater than
+ /// <exception cref="System.ArgumentException"><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"/>
+ /// cref="System.Collections.ICollection"/>
/// is greater than the available space from <paramref name="index"/> to the end of the destination
/// <paramref name="array"/>.</exception>
void ICollection.CopyTo(Array array, int index)
}
/// <summary>
- /// Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is
+ /// Gets a value indicating whether access to the <see cref="System.Collections.ICollection"/> is
/// synchronized with the SyncRoot.
/// </summary>
- /// <value>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized
+ /// <value>true if access to the <see cref="System.Collections.ICollection"/> is synchronized
/// (thread safe); otherwise, false. For <see
- /// cref="T:System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>, this property always
+ /// cref="System.Collections.Concurrent.ConcurrentDictionary{TKey,TValue}"/>, this property always
/// returns false.</value>
bool ICollection.IsSynchronized
{
/// <summary>
/// Gets an object that can be used to synchronize access to the <see
- /// cref="T:System.Collections.ICollection"/>. This property is not supported.
+ /// cref="System.Collections.ICollection"/>. This property is not supported.
/// </summary>
- /// <exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
+ /// <exception cref="System.NotSupportedException">The SyncRoot property is not supported.</exception>
object ICollection.SyncRoot
{
get
/// </summary>
/// <param name="collection">The collection whose elements are copied to the new <see
/// cref="ConcurrentStack{T}"/>.</param>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collection"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collection"/> argument is
/// null.</exception>
public ConcurrentStack(IEnumerable<T> collection)
{
/// <summary>
- /// Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is
+ /// Gets a value indicating whether access to the <see cref="System.Collections.ICollection"/> is
/// synchronized with the SyncRoot.
/// </summary>
- /// <value>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized
+ /// <value>true if access to the <see cref="System.Collections.ICollection"/> is synchronized
/// with the SyncRoot; otherwise, false. For <see cref="ConcurrentStack{T}"/>, this property always
/// returns false.</value>
bool ICollection.IsSynchronized
/// <summary>
/// Gets an object that can be used to synchronize access to the <see
- /// cref="T:System.Collections.ICollection"/>. This property is not supported.
+ /// cref="System.Collections.ICollection"/>. This property is not supported.
/// </summary>
- /// <exception cref="T:System.NotSupportedException">The SyncRoot property is not supported</exception>
+ /// <exception cref="System.NotSupportedException">The SyncRoot property is not supported</exception>
object ICollection.SyncRoot
{
get
}
/// <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.
+ /// Copies the elements of the <see cref="System.Collections.ICollection"/> to an <see
+ /// cref="System.Array"/>, starting at a particular
+ /// <see cref="System.Array"/> index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of
+ /// <param name="array">The one-dimensional <see cref="System.Array"/> that is the destination of
/// the elements copied from the
- /// <see cref="ConcurrentStack{T}"/>. The <see cref="T:System.Array"/> must
+ /// <see cref="ConcurrentStack{T}"/>. The <see cref="System.Array"/> must
/// have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// <paramref name="array"/> is multidimensional. -or-
/// <paramref name="array"/> does not have zero-based indexing. -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
+ /// -or- The number of elements in the source <see cref="System.Collections.ICollection"/> is
/// greater than the available space from <paramref name="index"/> to the end of the destination
/// <paramref name="array"/>. -or- The type of the source <see
- /// cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the
+ /// cref="System.Collections.ICollection"/> cannot be cast automatically to the type of the
/// destination <paramref name="array"/>.
/// </exception>
void ICollection.CopyTo(Array array, int index)
/// <summary>
/// Copies the <see cref="ConcurrentStack{T}"/> elements to an existing one-dimensional <see
- /// cref="T:System.Array"/>, starting at the specified array index.
+ /// cref="System.Array"/>, starting at the specified array index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of
+ /// <param name="array">The one-dimensional <see cref="System.Array"/> that is the destination of
/// the elements copied from the
- /// <see cref="ConcurrentStack{T}"/>. The <see cref="T:System.Array"/> must have zero-based
+ /// <see cref="ConcurrentStack{T}"/>. The <see cref="System.Array"/> must have zero-based
/// indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// <summary>
/// Attempts to add an object to the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
/// </summary>
/// <param name="item">The object to add to the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>. The value can be a null
+ /// cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>. 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>
/// 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{T}"/> or an
+ /// the top of the <see cref="System.Collections.Concurrent.ConcurrentStack{T}"/> or an
/// unspecified value if the operation failed.</param>
/// <returns>true if and object was returned successfully; otherwise, false.</returns>
public bool TryPeek([MaybeNullWhen(false)] out T result)
/// atomically.
/// </summary>
/// <param name="items">
- /// The <see cref="T:System.Array"/> to which objects popped from the top of the <see
+ /// The <see cref="System.Array"/> to which objects popped from the top of the <see
/// cref="ConcurrentStack{T}"/> will be added.
/// </param>
/// <returns>The number of objects successfully popped from the top of the <see
/// atomically.
/// </summary>
/// <param name="items">
- /// The <see cref="T:System.Array"/> to which objects popped from the top of the <see
+ /// The <see cref="System.Array"/> to which objects popped from the top of the <see
/// cref="ConcurrentStack{T}"/> will be added.
/// </param>
/// <param name="startIndex">The zero-based offset in <paramref name="items"/> at which to begin
/// <summary>
/// Attempts to remove and return an object from the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// cref="System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
/// </summary>
/// <param name="item">
/// When this method returns, if the operation was successful, <paramref name="item"/> contains the
/// <summary>
/// Returns an enumerator that iterates through a collection.
/// </summary>
- /// <returns>An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through
+ /// <returns>An <see cref="System.Collections.IEnumerator"/> that can be used to iterate through
/// the collection.</returns>
/// <remarks>
/// The enumeration represents a moment-in-time snapshot of the contents of the stack. It does not
/// <li>All indices must be non-negative. If any indices are negative, consumers of the implementation
/// may throw exceptions.</li>
/// <li><see cref="GetPartitions"/> and <see cref="GetOrderablePartitions"/> should throw a
- /// <see cref="T:System.ArgumentOutOfRangeException"/> if the requested partition count is less than or
+ /// <see cref="System.ArgumentOutOfRangeException"/> if the requested partition count is less than or
/// equal to zero.</li>
/// <li><see cref="GetPartitions"/> and <see cref="GetOrderablePartitions"/> should always return a number
/// of enumerables equal to the requested partition count. If the partitioner runs out of data and cannot
/// create as many partitions as requested, an empty enumerator should be returned for each of the
/// remaining partitions. If this rule is not followed, consumers of the implementation may throw a <see
- /// cref="T:System.InvalidOperationException"/>.</li>
+ /// cref="System.InvalidOperationException"/>.</li>
/// <li><see cref="GetPartitions"/>, <see cref="GetOrderablePartitions"/>,
/// <see cref="GetDynamicPartitions"/>, and <see cref="GetOrderableDynamicPartitions"/>
/// should never return null. If null is returned, a consumer of the implementation may throw a
- /// <see cref="T:System.InvalidOperationException"/>.</li>
+ /// <see cref="System.InvalidOperationException"/>.</li>
/// <li><see cref="GetPartitions"/>, <see cref="GetOrderablePartitions"/>,
/// <see cref="GetDynamicPartitions"/>, and <see cref="GetOrderableDynamicPartitions"/>
/// should always return partitions that can fully and uniquely enumerate the input data source. All of
/// <remarks>
/// <para>
/// The returned object implements the <see
- /// cref="T:System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
+ /// cref="System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
/// cref="System.Collections.Generic.IEnumerable{TSource}.GetEnumerator">GetEnumerator</see> on the
/// object creates another partition over the sequence.
/// </para>
/// <remarks>
/// <para>
/// The returned object implements the <see
- /// cref="T:System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
+ /// cref="System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
/// cref="System.Collections.Generic.IEnumerable{TSource}.GetEnumerator">GetEnumerator</see> on the
/// object creates another partition over the sequence.
/// </para>
/// Inheritors of <see cref="Partitioner{TSource}"/> must adhere to the following rules:
/// <ol>
/// <li><see cref="GetPartitions"/> should throw a
- /// <see cref="T:System.ArgumentOutOfRangeException"/> if the requested partition count is less than or
+ /// <see cref="System.ArgumentOutOfRangeException"/> if the requested partition count is less than or
/// equal to zero.</li>
/// <li><see cref="GetPartitions"/> should always return a number of enumerables equal to the requested
/// partition count. If the partitioner runs out of data and cannot create as many partitions as
/// requested, an empty enumerator should be returned for each of the remaining partitions. If this rule
/// is not followed, consumers of the implementation may throw a <see
- /// cref="T:System.InvalidOperationException"/>.</li>
+ /// cref="System.InvalidOperationException"/>.</li>
/// <li><see cref="GetPartitions"/> and <see cref="GetDynamicPartitions"/>
/// should never return null. If null is returned, a consumer of the implementation may throw a
- /// <see cref="T:System.InvalidOperationException"/>.</li>
+ /// <see cref="System.InvalidOperationException"/>.</li>
/// <li><see cref="GetPartitions"/> and <see cref="GetDynamicPartitions"/> should always return
/// partitions that can fully and uniquely enumerate the input data source. All of the data and only the
/// data contained in the input source should be enumerated, with no duplication that was not already in
/// <remarks>
/// <para>
/// The returned object implements the <see
- /// cref="T:System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
+ /// cref="System.Collections.Generic.IEnumerable{TSource}"/> interface. Calling <see
/// cref="System.Collections.Generic.IEnumerable{TSource}.GetEnumerator">GetEnumerator</see> on the
/// object creates another partition over the sequence.
/// </para>
/// <typeparam name="TSource">Type of the elements in source enumerable.</typeparam>
/// <param name="source">The enumerable to be partitioned.</param>
/// <param name="partitionerOptions">Options to control the buffering behavior of the partitioner.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// The <paramref name="partitionerOptions"/> argument specifies an invalid value for <see
- /// cref="T:System.Collections.Concurrent.EnumerablePartitionerOptions"/>.
+ /// cref="System.Collections.Concurrent.EnumerablePartitionerOptions"/>.
/// </exception>
/// <returns>
/// An orderable partitioner based on the input array.
/// <param name="fromInclusive">The lower, inclusive bound of the range.</param>
/// <param name="toExclusive">The upper, exclusive bound of the range.</param>
/// <returns>A partitioner.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
/// less than or equal to the <paramref name="fromInclusive"/> argument.</exception>
public static OrderablePartitioner<Tuple<long, long>> Create(long fromInclusive, long toExclusive)
{
/// <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
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
/// less than or equal to the <paramref name="fromInclusive"/> argument.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> The <paramref name="rangeSize"/> argument is
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="rangeSize"/> argument is
/// less than or equal to 0.</exception>
public static OrderablePartitioner<Tuple<long, long>> Create(long fromInclusive, long toExclusive, long rangeSize)
{
/// <param name="fromInclusive">The lower, inclusive bound of the range.</param>
/// <param name="toExclusive">The upper, exclusive bound of the range.</param>
/// <returns>A partitioner.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
/// less than or equal to the <paramref name="fromInclusive"/> argument.</exception>
public static OrderablePartitioner<Tuple<int, int>> Create(int fromInclusive, int toExclusive)
{
/// <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
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="toExclusive"/> argument is
/// less than or equal to the <paramref name="fromInclusive"/> argument.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> The <paramref name="rangeSize"/> argument is
+ /// <exception cref="System.ArgumentOutOfRangeException"> The <paramref name="rangeSize"/> argument is
/// less than or equal to 0.</exception>
public static OrderablePartitioner<Tuple<int, int>> Create(int fromInclusive, int toExclusive, int rangeSize)
{
/// <typeparam name="T">The type of element stored by the array.</typeparam>
/// <devremarks>
/// This type has a documented contract of being exactly one reference-type field in size.
- /// Our own <see cref="T:System.Collections.Immutable.ImmutableInterlocked"/> class depends on it, as well as others externally.
+ /// Our own <see cref="System.Collections.Immutable.ImmutableInterlocked"/> class depends on it, as well as others externally.
/// IMPORTANT NOTICE FOR MAINTAINERS AND REVIEWERS:
/// This type should be thread-safe. As a struct, it cannot protect its own fields
/// from being changed from one thread while its members are executing on other threads
/// Bulk adds entries to the map.
/// </summary>
/// <param name="pairs">The entries to add.</param>
- /// <param name="avoidToHashMap"><c>true</c> when being called from <see cref="WithComparers(IEqualityComparer{TKey}, IEqualityComparer{TValue})"/> to avoid <see cref="T:System.StackOverflowException"/>.</param>
+ /// <param name="avoidToHashMap"><c>true</c> when being called from <see cref="WithComparers(IEqualityComparer{TKey}, IEqualityComparer{TValue})"/> to avoid a stack overflow.</param>
[Pure]
private ImmutableDictionary<TKey, TValue> AddRange(IEnumerable<KeyValuePair<TKey, TValue>> pairs, bool avoidToHashMap)
{
/// <param name="count">The number of elements in the sequence.</param>
/// <returns>The array.</returns>
/// <remarks>
- /// This is more efficient than the <see cref="M:System.Linq.Enumerable.ToArray``1(System.Collections.Generic.IEnumerable{``0})"/> extension method
+ /// This is more efficient than the <see cref="System.Linq.Enumerable.ToArray{TSource}(IEnumerable{TSource})"/> extension method
/// because that only tries to cast the sequence to <see cref="ICollection{T}"/> to determine
/// the count before it falls back to reallocating arrays as it enumerates.
/// </remarks>
/// Bulk adds entries to the set.
/// </summary>
/// <param name="items">The entries to add.</param>
- /// <param name="avoidWithComparer"><c>true</c> when being called from <see cref="WithComparer"/> to avoid <see cref="T:System.StackOverflowException"/>.</param>
+ /// <param name="avoidWithComparer"><c>true</c> when being called from <see cref="WithComparer"/> to avoid a stack overflow.</param>
[Pure]
private ImmutableHashSet<T> Union(IEnumerable<T> items, bool avoidWithComparer)
{
/// </summary>
/// <param name="items">The entries to add.</param>
/// <param name="overwriteOnCollision"><c>true</c> to allow the <paramref name="items"/> sequence to include duplicate keys and let the last one win; <c>false</c> to throw on collisions.</param>
- /// <param name="avoidToSortedMap"><c>true</c> when being called from <see cref="WithComparers(IComparer{TKey}, IEqualityComparer{TValue})"/> to avoid <see cref="T:System.StackOverflowException"/>.</param>
+ /// <param name="avoidToSortedMap"><c>true</c> when being called from <see cref="WithComparers(IComparer{TKey}, IEqualityComparer{TValue})"/> to avoid a stack overflow.</param>
[Pure]
private ImmutableSortedDictionary<TKey, TValue> AddRange(IEnumerable<KeyValuePair<TKey, TValue>> items, bool overwriteOnCollision, bool avoidToSortedMap)
{
/// with <c>TKey</c> fixed to be <see cref="int"/>. This avoids multiple interface-based dispatches while examining
/// each node in the tree during a lookup: an interface call to the comparer's <see cref="IComparer{T}.Compare"/> method,
/// and then an interface call to <see cref="int"/>'s <see cref="IComparable{T}.CompareTo"/> method as part of
- /// the <see cref="T:System.Collections.Generic.GenericComparer`1"/>'s <see cref="IComparer{T}.Compare"/> implementation.
+ /// the comparer's <see cref="IComparer{T}.Compare"/> implementation.
/// </remarks>
[DebuggerDisplay("{_key} = {_value}")]
internal sealed partial class SortedInt32KeyNode<TValue> : IBinaryTree
public event EventHandler<ComposablePartCatalogChangeEventArgs> Changing;
/// <summary>
- /// Raises the <see cref="E:Changed"/> event.
+ /// Raises the <see cref="Changed"/> event.
/// </summary>
/// <param name="e">The <see cref="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs"/> instance containing the event data.</param>
protected virtual void OnChanged(ComposablePartCatalogChangeEventArgs e)
}
/// <summary>
- /// Raises the <see cref="E:Changing"/> event.
+ /// Raises the <see cref="Changing"/> event.
/// </summary>
/// <param name="e">The <see cref="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs"/> instance containing the event data.</param>
protected virtual void OnChanging(ComposablePartCatalogChangeEventArgs e)
public event EventHandler<ComposablePartCatalogChangeEventArgs> Changing;
/// <summary>
- /// Raises the <see cref="E:Changed"/> event.
+ /// Raises the <see cref="Changed"/> event.
/// </summary>
/// <param name="e">The <see cref="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs"/> instance containing the event data.</param>
protected virtual void OnChanged(ComposablePartCatalogChangeEventArgs e)
}
/// <summary>
- /// Raises the <see cref="E:Changing"/> event.
+ /// Raises the <see cref="Changing"/> event.
/// </summary>
/// <param name="e">The <see cref="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs"/> instance containing the event data.</param>
protected virtual void OnChanging(ComposablePartCatalogChangeEventArgs e)
/// components, you would pass typeof(IComponent). Passing typeof(object)
/// will cause the provider to be called to provide type information for
/// all types.
- ///
- /// This method can be called from partially trusted code. If
- /// <see cref="E:System.Security.Permissions.TypeDescriptorPermissionFlags.RestrictedRegistrationAccess"/>
- /// is defined, the caller can register a provider for the specified type
- /// if it's also partially trusted.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public static void AddProviderTransparent(TypeDescriptionProvider provider, Type type)
/// using this method will never have its CreateInstance method called
/// because the instance already exists. This method does not prevent
/// the object from finalizing.
- ///
- /// This method can be called from partially trusted code. If
- /// <see cref="E:System.Security.Permissions.TypeDescriptorPermissionFlags.RestrictedRegistrationAccess"/>
- /// is defined, the caller can register a provider for the specified instance
- /// if its type is also partially trusted.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public static void AddProviderTransparent(TypeDescriptionProvider provider, object instance)
/// description provider. Removing a provider causes a Refresh
/// event to be raised for the object or type the provider is
/// associated with.
- ///
- /// This method can be called from partially trusted code. If
- /// <see cref="E:System.Security.Permissions.TypeDescriptorPermissionFlags.RestrictedRegistrationAccess"/>
- /// is defined, the caller can unregister a provider for the specified type
- /// if it's also partially trusted.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public static void RemoveProviderTransparent(TypeDescriptionProvider provider, Type type)
/// description provider. Removing a provider causes a Refresh
/// event to be raised for the object or type the provider is
/// associated with.
- ///
- /// This method can be called from partially trusted code. If
- /// <see cref="E:System.Security.Permissions.TypeDescriptorPermissionFlags.RestrictedRegistrationAccess"/>
- /// is defined, the caller can register a provider for the specified instance
- /// if its type is also partially trusted.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public static void RemoveProviderTransparent(TypeDescriptionProvider provider, object instance)
}
/// <summary>
- /// Reads the XML schema from the specified <see cref='T:System.Xml.XMLReader'/> into the <see cref='System.Data.DataSet'/>
+ /// Reads the XML schema from the specified <see cref="System.Xml.XmlReader" /> into the <see cref="System.Data.DataSet" />
/// </summary>
public void ReadXmlSchema(XmlReader reader) => ReadXmlSchema(reader, false);
}
/// <summary>
- /// Raises the <see cref='E:System.Data.DataView.ListChanged'/> event.
+ /// Raises the <see cref="System.Data.DataView.ListChanged" /> event.
/// </summary>
protected virtual void OnListChanged(ListChangedEventArgs e)
{
{
/// <devdoc>
/// <para>Directs tracing or debugging output to
- /// a <see cref='T:System.IO.TextWriter'/> or to a <see cref='T:System.IO.Stream'/>,
- /// such as <see cref='F:System.Console.Out'/> or <see cref='T:System.IO.FileStream'/>.</para>
+ /// a <see cref='System.IO.TextWriter'/> or to a <see cref='System.IO.Stream'/>,
+ /// such as <see cref='System.Console.Out'/> or <see cref='System.IO.FileStream'/>.</para>
/// </devdoc>
public class TextWriterTraceListener : TraceListener
{
namespace System.IO
{
/// <devdoc>
- /// Provides data for the <see cref='E:System.IO.FileSystemWatcher.Error'/> event.
+ /// Provides data for the <see cref='System.IO.FileSystemWatcher.Error'/> event.
/// </devdoc>
public class ErrorEventArgs : EventArgs
{
{
/// <devdoc>
/// Represents the method that will
- /// handle the <see cref='E:System.IO.FileSystemWatcher.Error'/>
- /// event of a <see cref='T:System.IO.FileSystemWatcher'/>.
+ /// handle the <see cref='System.IO.FileSystemWatcher.Error'/>
+ /// event of a <see cref='System.IO.FileSystemWatcher'/>.
/// </devdoc>
public delegate void ErrorEventHandler(object sender, ErrorEventArgs e);
}
/// to convert to a <see cref="System.Linq.ParallelQuery{T}"/>.</param>
/// <returns>The source as a <see cref="System.Linq.ParallelQuery{T}"/> to bind to
/// ParallelEnumerable extension methods.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> AsParallel<TSource>(this IEnumerable<TSource> source)
/// whereas the partitioner's GetPartitions is used if ordering is not enabled (the default).
/// The source partitioner's GetDynamicPartitions and GetDynamicOrderedPartitions are not used.
/// </remarks>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> AsParallel<TSource>(this Partitioner<TSource> source)
/// </summary>
/// <typeparam name="TSource">The type of elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The input sequence.</param>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// Thrown if <paramref name="source"/> is not one of AsParallel, ParallelEnumerable.Range, or ParallelEnumerable.Repeat.
/// </exception>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <remarks>
/// <exception cref="InvalidOperationException">
/// Thrown if the <paramref name="source"/> is not one of AsParallel, ParallelEnumerable.Range, or ParallelEnumerable.Repeat.
/// </exception>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <remarks>
/// <typeparam name="TSource">The type of elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The input sequence.</param>
/// <returns>The source sequence with arbitrary order.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> AsUnordered<TSource>(this ParallelQuery<TSource> source)
/// The source as a ParallelQuery to bind to
/// ParallelEnumerable extension methods.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery AsParallel(this IEnumerable source)
/// <param name="source">A <see cref="ParallelQuery{T}"/> to convert to an <see cref="System.Collections.Generic.IEnumerable{T}"/>.</param>
/// <returns>The source as an <see cref="System.Collections.Generic.IEnumerable{T}"/>
/// to bind to sequential extension methods.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static IEnumerable<TSource> AsSequential<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">A ParallelQuery on which to set the limit on the degrees of parallelism.</param>
/// <param name="degreeOfParallelism">The degree of parallelism for the query.</param>
/// <returns>ParallelQuery representing the same query as source, with the limit on the degrees of parallelism set.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// WithDegreeOfParallelism is used multiple times in the query.
/// </exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="degreeOfParallelism"/> is less than 1 or greater than 512.
/// </exception>
public static ParallelQuery<TSource> WithDegreeOfParallelism<TSource>(this ParallelQuery<TSource> source, int degreeOfParallelism)
/// <param name="cancellationToken">A cancellation token.</param>
/// <returns>ParallelQuery representing the same query as source, but with the <seealso cref="System.Threading.CancellationToken"/>
/// registered.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// WithCancellation is used multiple times in the query.
/// </exception>
public static ParallelQuery<TSource> WithCancellation<TSource>(this ParallelQuery<TSource> source, CancellationToken cancellationToken)
/// <param name="executionMode">The mode in which to execute the query.</param>
/// <returns>ParallelQuery representing the same query as source, but with the
/// <seealso cref="System.Linq.ParallelExecutionMode"/> registered.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.ArgumentException">
- /// <paramref name="executionMode"/> is not a valid <see cref="T:System.Linq.ParallelExecutionMode"/> value.
+ /// <exception cref="System.ArgumentException">
+ /// <paramref name="executionMode"/> is not a valid <see cref="System.Linq.ParallelExecutionMode"/> value.
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// WithExecutionMode is used multiple times in the query.
/// </exception>
public static ParallelQuery<TSource> WithExecutionMode<TSource>(this ParallelQuery<TSource> source, ParallelExecutionMode executionMode)
/// <param name="mergeOptions">The merge options to set for this query.</param>
/// <returns>ParallelQuery representing the same query as source, but with the
/// <seealso cref="ParallelMergeOptions"/> registered.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.ArgumentException">
- /// <paramref name="mergeOptions"/> is not a valid <see cref="T:System.Linq.ParallelMergeOptions"/> value.
+ /// <exception cref="System.ArgumentException">
+ /// <paramref name="mergeOptions"/> is not a valid <see cref="System.Linq.ParallelMergeOptions"/> value.
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// WithMergeOptions is used multiple times in the query.
/// </exception>
public static ParallelQuery<TSource> WithMergeOptions<TSource>(this ParallelQuery<TSource> source, ParallelMergeOptions mergeOptions)
/// <param name="count">The number of sequential integers to generate.</param>
/// <returns>An <b>IEnumerable<Int32></b> in C# or <B>IEnumerable(Of Int32)</B> in
/// Visual Basic that contains a range of sequential integral numbers.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="count"/> is less than 0
/// -or-
- /// <paramref name="start"/> + <paramref name="count"/> - 1 is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <paramref name="start"/> + <paramref name="count"/> - 1 is larger than <see cref="System.Int32.MaxValue"/>.
/// </exception>
public static ParallelQuery<int> Range(int start, int count)
{
/// <param name="element">The value to be repeated.</param>
/// <param name="count">The number of times to repeat the value in the generated sequence.</param>
/// <returns>A sequence that contains a repeated value.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="count"/> is less than 0.
/// </exception>
public static ParallelQuery<TResult> Repeat<TResult>(TResult element, int count)
/// <param name="source">The <see cref="ParallelQuery{T}"/> whose elements will be processed by
/// <paramref name="action"/>.</param>
/// <param name="action">An Action to invoke on each element.</param>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="action"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static void ForAll<TSource>(this ParallelQuery<TSource> source, Action<TSource> action)
/// <param name="predicate">A function to test each element for a condition.</param>
/// <returns>A sequence that contains elements from the input sequence that satisfy
/// the condition.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Where<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <param name="source">A sequence to filter.</param>
/// <param name="predicate">A function to test each element for a condition.</param>
/// <returns>A sequence that contains elements from the input sequence that satisfy the condition.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Where<TSource>(this ParallelQuery<TSource> source, Func<TSource, int, bool> predicate)
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>A sequence whose elements are the result of invoking the transform function on each
/// element of <paramref name="source"/>.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> Select<TSource, TResult>(
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>A sequence whose elements are the result of invoking the transform function on each
/// element of <paramref name="source"/>.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> Select<TSource, TResult>(
/// resultSelector pairwise on two sequences. If the sequence lengths are unequal, this truncates
/// to the length of the shorter sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> Zip<TFirst, TSecond, TResult>(
/// <param name="second">This parameter is not used.</param>
/// <param name="resultSelector">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Zip with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TFirst}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSecond}"/>.
/// <param name="resultSelector">A function to create a result element from two matching elements.</param>
/// <returns>A sequence that has elements of type <typeparamref name="TResult"/> that are obtained by performing
/// an inner join on two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="outer"/> or <paramref name="inner"/> or <paramref name="outerKeySelector"/> or
/// <paramref name="innerKeySelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="innerKeySelector">This parameter is not used.</param>
/// <param name="resultSelector">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage Join with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TOuter}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TInner}"/>.
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to hash and compare keys.</param>
/// <returns>A sequence that has elements of type <typeparamref name="TResult"/> that are obtained by performing
/// an inner join on two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="outer"/> or <paramref name="inner"/> or <paramref name="outerKeySelector"/> or
/// <paramref name="innerKeySelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="resultSelector">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Join with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TOuter}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TInner}"/>.
/// the first sequence and a collection of matching elements from the second sequence.</param>
/// <returns>A sequence that has elements of type <typeparamref name="TResult"/> that are obtained by performing
/// a grouped join on two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="outer"/> or <paramref name="inner"/> or <paramref name="outerKeySelector"/> or
/// <paramref name="innerKeySelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="innerKeySelector">This parameter is not used.</param>
/// <param name="resultSelector">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of GroupJoin with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TOuter}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TInner}"/>.
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to hash and compare keys.</param>
/// <returns>A sequence that has elements of type <typeparamref name="TResult"/> that are obtained by performing
/// a grouped join on two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="outer"/> or <paramref name="inner"/> or <paramref name="outerKeySelector"/> or
/// <paramref name="innerKeySelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="resultSelector">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of GroupJoin with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TOuter}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TInner}"/>.
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>A sequence whose elements are the result of invoking the one-to-many transform
/// function on each element of the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> SelectMany<TSource, TResult>(
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>A sequence whose elements are the result of invoking the one-to-many transform
/// function on each element of the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> SelectMany<TSource, TResult>(
/// <returns>A sequence whose elements are the result of invoking the one-to-many transform
/// function <paramref name="collectionSelector"/> on each element of <paramref name="source"/> and then mapping
/// each of those sequence elements and their corresponding source element to a result element.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="collectionSelector"/> or
/// <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// each of those sequence elements and their corresponding source element to a
/// result element.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="collectionSelector"/> or
/// <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="keySelector">A function to extract a key from an element.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted
/// according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static OrderedParallelQuery<TSource> OrderBy<TSource, TKey>(
/// <param name="comparer">An IComparer{TKey} to compare keys.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted according
/// to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static OrderedParallelQuery<TSource> OrderBy<TSource, TKey>(
/// <param name="keySelector">A function to extract a key from an element.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted
/// descending according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static OrderedParallelQuery<TSource> OrderByDescending<TSource, TKey>(
/// <param name="comparer">An IComparer{TKey} to compare keys.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted descending
/// according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static OrderedParallelQuery<TSource> OrderByDescending<TSource, TKey>(
/// <param name="keySelector">A function to extract a key from an element.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are
/// sorted according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="comparer">An IComparer{TKey} to compare keys.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted
/// according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
///
/// <param name="keySelector">A function to extract a key from an element.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted
/// descending according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
///
/// <param name="comparer">An IComparer{TKey} to compare keys.</param>
/// <returns>An OrderedParallelQuery{TSource} whose elements are sorted
/// descending according to a key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
///
/// <param name="keySelector">A function to extract a key from an element.</param>
/// <returns>A collection of elements of type IGrouping{TKey, TElement}, where each element represents a
/// group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/>
/// is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="comparer">An equality comparer to compare keys.</param>
/// <returns>A collection of elements of type IGrouping{TKey, TElement}, where each element represents a
/// group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<IGrouping<TKey, TSource>> GroupBy<TSource, TKey>(
/// IGrouping{Key, TElement}.</param>
/// <returns>A collection of elements of type IGrouping{TKey, TElement}, where each element represents a
/// group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="comparer">An equality comparer to compare keys.</param>
/// <returns>A collection of elements of type IGrouping{TKey, TElement}, where each element represents a
/// group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="resultSelector">A function to create a result value from each group.</param>
/// <returns>A collection of elements of type <typeparamref name="TResult"/> where each element represents a
/// projection over a group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="comparer">An equality comparer to compare keys.</param>
/// <returns>A collection of elements of type <typeparamref name="TResult"/> where each element represents a
/// projection over a group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="resultSelector">A function to create a result value from each group.</param>
/// <returns>A collection of elements of type <typeparamref name="TResult"/> where each element represents a
/// projection over a group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="elementSelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="comparer">An equality comparer to compare keys.</param>
/// <returns>A collection of elements of type <typeparamref name="TResult"/> where each element represents a
/// projection over a group and its key.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or
/// <paramref name="elementSelector"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
/// <param name="source">A sequence to aggregate over.</param>
/// <param name="func">An accumulator function to be invoked on each element.</param>
/// <returns>The final accumulator value.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="func"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Aggregate<TSource>(
/// <param name="seed">The initial accumulator value.</param>
/// <param name="func">An accumulator function to be invoked on each element.</param>
/// <returns>The final accumulator value.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="func"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TAccumulate Aggregate<TSource, TAccumulate>(
/// <param name="resultSelector">A function to transform the final accumulator value
/// into the result value.</param>
/// <returns>The transformed final accumulator value.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="func"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TResult Aggregate<TSource, TAccumulate, TResult>(
/// A function to transform the final accumulator value into the result value.
/// </param>
/// <returns>The transformed final accumulator value.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="updateAccumulatorFunc"/>
/// or <paramref name="combineAccumulatorsFunc"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TResult Aggregate<TSource, TAccumulate, TResult>(
/// A function to transform the final accumulator value into the result value.
/// </param>
/// <returns>The transformed final accumulator value.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="seedFactory"/> or <paramref name="updateAccumulatorFunc"/>
/// or <paramref name="combineAccumulatorsFunc"/> or <paramref name="resultSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TResult Aggregate<TSource, TAccumulate, TResult>(
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence that contains elements to be counted.</param>
/// <returns>The number of elements in the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The number of elements in source is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The number of elements in source is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Count<TSource>(this ParallelQuery<TSource> source)
/// A number that represents how many elements in the sequence satisfy the condition
/// in the predicate function.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The number of elements in source is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The number of elements in source is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Count<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence that contains elements to be counted.</param>
/// <returns>The number of elements in the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The number of elements in source is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The number of elements in source is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long LongCount<TSource>(this ParallelQuery<TSource> source)
/// A number that represents how many elements in the sequence satisfy the condition
/// in the predicate function.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The number of elements in source is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The number of elements in source is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long LongCount<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Sum(this ParallelQuery<int> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Sum(this ParallelQuery<int?> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Sum(this ParallelQuery<long> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Sum(this ParallelQuery<long?> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Sum(this ParallelQuery<float> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Sum(this ParallelQuery<float?> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Sum(this ParallelQuery<double> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Sum(this ParallelQuery<double?> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Decimal.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Decimal.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Sum(this ParallelQuery<decimal> source)
/// </summary>
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Decimal.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Decimal.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Sum(this ParallelQuery<decimal?> source)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, int> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, int?> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, long> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, long?> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, float> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, float?> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, double> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, double?> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Decimal.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Decimal.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal> selector)
/// <param name="source">A sequence of values to calculate the sum of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The sum of the values in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum is larger than <see cref="M:System.Decimal.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum is larger than <see cref="System.Decimal.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Sum<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal?> selector)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Min(this ParallelQuery<int> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Min(this ParallelQuery<int?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Min(this ParallelQuery<long> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Min(this ParallelQuery<long?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Min(this ParallelQuery<float> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Min(this ParallelQuery<float?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Min(this ParallelQuery<double> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Min(this ParallelQuery<double?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Min(this ParallelQuery<decimal> source)
/// </summary>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Min(this ParallelQuery<decimal?> source)
/// <typeparam name="TSource">The type of elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements and <typeparamref name="TSource"/> is a non-nullable value type.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Min<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, int> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, int?> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, long> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, long?> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, float> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, float?> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, double> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, double?> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Min<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal?> selector)
/// <param name="source">A sequence of values to determine the minimum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The minimum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements and <typeparamref name="TResult"/> is a non-nullable value type.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TResult Min<TSource, TResult>(this ParallelQuery<TSource> source, Func<TSource, TResult> selector)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Max(this ParallelQuery<int> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Max(this ParallelQuery<int?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Max(this ParallelQuery<long> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Max(this ParallelQuery<long?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Max(this ParallelQuery<float> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Max(this ParallelQuery<float?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Max(this ParallelQuery<double> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Max(this ParallelQuery<double?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Max(this ParallelQuery<decimal> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Max(this ParallelQuery<decimal?> source)
/// </summary>
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements and <typeparam name="TSource"/> is a non-nullable value type.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Max<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, int> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static int? Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, int?> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, long> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static long? Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, long?> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, float> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, float?> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, double> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, double?> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Max<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal?> selector)
/// <param name="source">A sequence of values to determine the maximum value of.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The maximum value in the sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements and <typeparamref name="TResult"/> is a non-nullable value type.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TResult Max<TSource, TResult>(this ParallelQuery<TSource> source, Func<TSource, TResult> selector)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average(this ParallelQuery<int> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average(this ParallelQuery<int?> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average(this ParallelQuery<long> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average(this ParallelQuery<long?> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Average(this ParallelQuery<float> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Average(this ParallelQuery<float?> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average(this ParallelQuery<double> source)
/// <summary>
/// Computes in parallel the average of a sequence of values.
/// </summary>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average(this ParallelQuery<double?> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Average(this ParallelQuery<decimal> source)
/// </summary>
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Average(this ParallelQuery<decimal?> source)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, int> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, int?> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int32.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int32.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, long> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
- /// The sum or count of the elements in the sequence is larger than <see cref="M:System.Int64.MaxValue"/>.
+ /// <exception cref="System.AggregateException">
+ /// The sum or count of the elements in the sequence is larger than <see cref="System.Int64.MaxValue"/>.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, long?> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, float> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static float? Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, float?> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, double> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static double? Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, double?> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal> selector)
/// <param name="source">A sequence of values that are used to calculate an average.</param>
/// <param name="selector">A transform function to apply to each element.</param>
/// <returns>The average of the sequence of values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="selector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static decimal? Average<TSource>(this ParallelQuery<TSource> source, Func<TSource, decimal?> selector)
/// <returns>
/// true if any elements in the source sequence pass the test in the specified predicate; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool Any<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <typeparam name="TSource">The type of elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The IEnumerable to check for emptiness.</param>
/// <returns>true if the source sequence contains any elements; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool Any<TSource>(this ParallelQuery<TSource> source)
/// <returns>
/// true if all elements in the source sequence pass the test in the specified predicate; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool All<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <returns>
/// true if the source sequence contains an element that has the specified value; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool Contains<TSource>(this ParallelQuery<TSource> source, TSource value)
/// <returns>
/// true if the source sequence contains an element that has the specified value; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool Contains<TSource>(this ParallelQuery<TSource> source, TSource value, IEqualityComparer<TSource> comparer)
/// <returns>
/// A sequence that contains the specified number of elements from the start of the input sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Take<TSource>(this ParallelQuery<TSource> source, int count)
/// A sequence that contains the elements from the input sequence that occur before
/// the element at which the test no longer passes.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> TakeWhile<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// A sequence that contains elements from the input sequence that occur before
/// the element at which the test no longer passes.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> TakeWhile<TSource>(this ParallelQuery<TSource> source, Func<TSource, int, bool> predicate)
/// <returns>
/// A sequence that contains the elements that occur after the specified index in the input sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Skip<TSource>(this ParallelQuery<TSource> source, int count)
/// <returns>A sequence that contains the elements from the input sequence starting at
/// the first element in the linear series that does not pass the test specified by
/// <B>predicate</B>.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> SkipWhile<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// first element in the linear series that does not pass the test specified by
/// <B>predicate</B>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> SkipWhile<TSource>(this ParallelQuery<TSource> source, Func<TSource, int, bool> predicate)
/// <param name="first">The first sequence to concatenate.</param>
/// <param name="second">The sequence to concatenate to the first sequence.</param>
/// <returns>A sequence that contains the concatenated elements of the two input sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Concat<TSource>(this ParallelQuery<TSource> first, ParallelQuery<TSource> second)
/// <param name="first">This parameter is not used.</param>
/// <param name="second">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Concat with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// true if the two source sequences are of equal length and their corresponding elements
/// are equal according to the default equality comparer for their type; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool SequenceEqual<TSource>(this ParallelQuery<TSource> first, ParallelQuery<TSource> second)
/// <param name="first">This parameter is not used.</param>
/// <param name="second">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">Thrown every time this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown every time this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of SequenceEqual with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// true if the two source sequences are of equal length and their corresponding
/// elements are equal according to the default equality comparer for their type; otherwise, false.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static bool SequenceEqual<TSource>(this ParallelQuery<TSource> first, ParallelQuery<TSource> second, IEqualityComparer<TSource> comparer)
/// <param name="second">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">Thrown every time this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown every time this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of SequenceEqual with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The sequence to remove duplicate elements from.</param>
/// <returns>A sequence that contains distinct elements from the source sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Distinct<TSource>(
/// <param name="source">The sequence to remove duplicate elements from.</param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare values.</param>
/// <returns>A sequence that contains distinct elements from the source sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Distinct<TSource>(
/// <param name="first">A sequence whose distinct elements form the first set for the union.</param>
/// <param name="second">A sequence whose distinct elements form the second set for the union.</param>
/// <returns>A sequence that contains the elements from both input sequences, excluding duplicates.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Union<TSource>(
/// <param name="first">This parameter is not used.</param>
/// <param name="second">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Union with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// <param name="second">A sequence whose distinct elements form the second set for the union.</param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare values.</param>
/// <returns>A sequence that contains the elements from both input sequences, excluding duplicates.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Union<TSource>(
/// <param name="second">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Union with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// A sequence whose distinct elements that also appear in the first sequence will be returned.
/// </param>
/// <returns>A sequence that contains the elements that form the set intersection of two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Intersect<TSource>(
/// <param name="first">This parameter is not used.</param>
/// <param name="second">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Intersect with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// </param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare values.</param>
/// <returns>A sequence that contains the elements that form the set intersection of two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Intersect<TSource>(
/// <param name="second">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Intersect with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// elements to be removed from the returned sequence.
/// </param>
/// <returns>A sequence that contains the set difference of the elements of two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Except<TSource>(
/// <param name="first">This parameter is not used.</param>
/// <param name="second">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Except with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// </param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare values.</param>
/// <returns>A sequence that contains the set difference of the elements of two sequences.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="first"/> or <paramref name="second"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Except<TSource>(
/// <param name="second">This parameter is not used.</param>
/// <param name="comparer">This parameter is not used.</param>
/// <returns>This overload always throws a <see cref="System.NotSupportedException"/>.</returns>
- /// <exception cref="T:System.NotSupportedException">The exception that occurs when this method is called.</exception>
+ /// <exception cref="System.NotSupportedException">The exception that occurs when this method is called.</exception>
/// <remarks>
/// This overload exists to disallow usage of Except with a left data source of type
/// <see cref="System.Linq.ParallelQuery{TSource}"/> and a right data source of type <see cref="System.Collections.Generic.IEnumerable{TSource}"/>.
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The sequence to type as <see cref="System.Collections.Generic.IEnumerable{T}"/>.</param>
/// <returns>The input sequence types as <see cref="System.Collections.Generic.IEnumerable{T}"/>.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static IEnumerable<TSource> AsEnumerable<TSource>(this ParallelQuery<TSource> source)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence to create an array from.</param>
/// <returns>An array that contains the elements from the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource[] ToArray<TSource>(this ParallelQuery<TSource> source)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence to create a List<(Of <(T>)>) from.</param>
/// <returns>A List<(Of <(T>)>) that contains elements from the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static List<TSource> ToList<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">A sequence to create a Dictionary<(Of <(TKey, TValue>)>) from.</param>
/// <param name="keySelector">A function to extract a key from each element.</param>
/// <returns>A Dictionary<(Of <(TKey, TValue>)>) that contains keys and values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// <paramref name="keySelector"/> produces a key that is a null reference (Nothing in Visual Basic).
/// -or-
/// <paramref name="keySelector"/> produces duplicate keys for two elements.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static Dictionary<TKey, TSource> ToDictionary<TSource, TKey>(
/// <param name="keySelector">A function to extract a key from each element.</param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare keys.</param>
/// <returns>A Dictionary<(Of <(TKey, TValue>)>) that contains keys and values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// <paramref name="keySelector"/> produces a key that is a null reference (Nothing in Visual Basic).
/// -or-
/// <paramref name="keySelector"/> produces duplicate keys for two elements.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static Dictionary<TKey, TSource> ToDictionary<TSource, TKey>(
/// A Dictionary<(Of <(TKey, TValue>)>) that contains values of type <typeparamref name="TElement"/>
/// selected from the input sequence
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// <paramref name="keySelector"/> produces a key that is a null reference (Nothing in Visual Basic).
/// -or-
/// <paramref name="keySelector"/> produces duplicate keys for two elements.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static Dictionary<TKey, TElement> ToDictionary<TSource, TKey, TElement>(
/// A Dictionary<(Of <(TKey, TValue>)>) that contains values of type <typeparamref name="TElement"/>
/// selected from the input sequence
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// <paramref name="keySelector"/> produces a key that is a null reference (Nothing in Visual Basic).
/// -or-
/// <paramref name="keySelector"/> produces duplicate keys for two elements.
/// -or-
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static Dictionary<TKey, TElement> ToDictionary<TSource, TKey, TElement>(
/// <param name="source">The sequence to create a Lookup<(Of <(TKey, TElement>)>) from.</param>
/// <param name="keySelector">A function to extract a key from each element.</param>
/// <returns>A Lookup<(Of <(TKey, TElement>)>) that contains keys and values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static ILookup<TKey, TSource> ToLookup<TSource, TKey>(
/// <param name="keySelector">A function to extract a key from each element.</param>
/// <param name="comparer">An IEqualityComparer<(Of <(T>)>) to compare keys.</param>
/// <returns>A Lookup<(Of <(TKey, TElement>)>) that contains keys and values.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static ILookup<TKey, TSource> ToLookup<TSource, TKey>(
/// A Lookup<(Of <(TKey, TElement>)>) that contains values of type TElement
/// selected from the input sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static ILookup<TKey, TElement> ToLookup<TSource, TKey, TElement>(
/// A Lookup<(Of <(TKey, TElement>)>) that contains values of type TElement selected
/// from the input sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="keySelector"/> or <paramref name="elementSelector"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static ILookup<TKey, TElement> ToLookup<TSource, TKey, TElement>(
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">A sequence of values to reverse.</param>
/// <returns>A sequence whose elements correspond to those of the input sequence in reverse order.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> Reverse<TSource>(this ParallelQuery<TSource> source)
/// <typeparam name="TResult">The type to filter the elements of the sequence on.</typeparam>
/// <param name="source">The sequence whose elements to filter.</param>
/// <returns>A sequence that contains elements from the input sequence of type <typeparamref name="TResult"/>.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> OfType<TResult>(this ParallelQuery source)
/// <returns>
/// A sequence that contains each weakly-type element of the source sequence converted to the specified stronger type.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TResult> Cast<TResult>(this ParallelQuery source)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The sequence to return the first element of.</param>
/// <returns>The first element in the specified sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource First<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">The sequence to return an element from.</param>
/// <param name="predicate">A function to test each element for a condition.</param>
/// <returns>The first element in the sequence that passes the test in the specified predicate function.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// No element in <paramref name="source"/> satisfies the condition in <paramref name="predicate"/>.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource First<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <returns>
/// default(<B>TSource</B>) if <paramref name="source"/> is empty; otherwise, the first element in <paramref name="source"/>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource FirstOrDefault<TSource>(this ParallelQuery<TSource> source)
/// specified by <B>predicate</B>; otherwise, the first element in <paramref name="source"/> that
/// passes the test specified by <B>predicate</B>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource FirstOrDefault<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The sequence to return the last element from.</param>
/// <returns>The value at the last position in the source sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// <paramref name="source"/> contains no elements.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Last<TSource>(this ParallelQuery<TSource> source)
/// <returns>
/// The last element in the sequence that passes the test in the specified predicate function.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// No element in <paramref name="source"/> satisfies the condition in <paramref name="predicate"/>.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Last<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <returns>
/// default(<typeparamref name="TSource"/>) if the source sequence is empty; otherwise, the last element in the sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource LastOrDefault<TSource>(this ParallelQuery<TSource> source)
/// default(<typeparamref name="TSource"/>) if the sequence is empty or if no elements pass the test in the
/// predicate function; otherwise, the last element that passes the test in the predicate function.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource LastOrDefault<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <param name="source">The sequence to return the single element of.</param>
/// <returns>The single element of the input sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The input sequence contains more than one element. -or- The input sequence is empty.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Single<TSource>(this ParallelQuery<TSource> source)
/// <param name="source">The sequence to return the single element of.</param>
/// <param name="predicate">A function to test an element for a condition.</param>
/// <returns>The single element of the input sequence that satisfies a condition.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// No element satisfies the condition in <paramref name="predicate"/>. -or- More than one element satisfies the condition in <paramref name="predicate"/>.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource Single<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// The single element of the input sequence, or default(<typeparamref name="TSource"/>) if the
/// sequence contains no elements.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource SingleOrDefault<TSource>(this ParallelQuery<TSource> source)
/// The single element of the input sequence that satisfies the condition, or
/// default(<typeparamref name="TSource"/>) if no such element is found.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> or <paramref name="predicate"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource SingleOrDefault<TSource>(this ParallelQuery<TSource> source, Func<TSource, bool> predicate)
/// <returns>
/// A sequence that contains default(<B>TSource</B>) if <paramref name="source"/> is empty; otherwise, <paramref name="source"/>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> DefaultIfEmpty<TSource>(this ParallelQuery<TSource> source)
/// <returns>
/// A sequence that contains <B>defaultValue</B> if <paramref name="source"/> is empty; otherwise, <paramref name="source"/>.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
public static ParallelQuery<TSource> DefaultIfEmpty<TSource>(this ParallelQuery<TSource> source, TSource defaultValue)
/// <param name="source">A sequence to return an element from.</param>
/// <param name="index">The zero-based index of the element to retrieve.</param>
/// <returns>The element at the specified position in the source sequence.</returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="index"/> is less than 0 or greater than or equal to the number of elements in <paramref name="source"/>.
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource ElementAt<TSource>(this ParallelQuery<TSource> source, int index)
/// default(<B>TSource</B>) if the index is outside the bounds of the source sequence;
/// otherwise, the element at the specified position in the source sequence.
/// </returns>
- /// <exception cref="T:System.ArgumentNullException">
+ /// <exception cref="System.ArgumentNullException">
/// <paramref name="source"/> is a null reference (Nothing in Visual Basic).
/// </exception>
- /// <exception cref="T:System.AggregateException">
+ /// <exception cref="System.AggregateException">
/// One or more exceptions occurred during the evaluation of the query.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException">
+ /// <exception cref="System.OperationCanceledException">
/// The query was canceled.
/// </exception>
public static TSource ElementAtOrDefault<TSource>(this ParallelQuery<TSource> source, int index)
/// otherwise, <c>false</c>.
/// </summary>
/// <remarks>
- /// This flag allows us to determine in O(1) time whether we can preallocate for <see cref="ToArray"/>
- /// and <see cref="M:System.Linq.Enumerable.ConcatIterator`1.ToList"/>, and whether we can get the count of the iterator cheaply.
+ /// This flag allows us to determine in O(1) time whether we can preallocate for ToArray/ToList,
+ /// and whether we can get the count of the iterator cheaply.
/// </remarks>
private readonly bool _hasOnlyCollections;
}
/// <summary>
- /// An iterator that maps each item of a <see cref="T:TSource[]"/>.
+ /// An iterator that maps each item of a array.
/// </summary>
/// <typeparam name="TSource">The type of the source array.</typeparam>
/// <typeparam name="TResult">The type of the mapped items.</typeparam>
}
/// <summary>
- /// Returns an <see cref="T:TSource[]"/> that contains the items of this node's singly-linked list in reverse.
+ /// Returns an array that contains the items of this node's singly-linked list in reverse.
/// </summary>
/// <param name="count">The number of items in this node.</param>
public TSource[] ToArray(int count)
}
/// <summary>
- /// An iterator that filters each item of a <see cref="T:TSource[]"/>.
+ /// An iterator that filters each item of an array.
/// </summary>
/// <typeparam name="TSource">The type of the source array.</typeparam>
internal sealed partial class WhereArrayIterator<TSource> : Iterator<TSource>
}
/// <summary>
- /// An iterator that filters, then maps, each item of a <see cref="T:TSource[]"/>.
+ /// An iterator that filters, then maps, each item of an array.
/// </summary>
/// <typeparam name="TSource">The type of the source array.</typeparam>
/// <typeparam name="TResult">The type of the mapped items.</typeparam>
namespace System.Management
{
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementEventWatcher.EventArrived'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementEventWatcher.EventArrived'/> event.</para>
/// </summary>
public delegate void EventArrivedEventHandler(object sender, EventArrivedEventArgs e);
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementEventWatcher.Stopped'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementEventWatcher.Stopped'/> event.</para>
/// </summary>
public delegate void StoppedEventHandler (object sender, StoppedEventArgs e);
{
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementOperationObserver.ObjectReady'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementOperationObserver.ObjectReady'/> event.</para>
/// </summary>
public delegate void ObjectReadyEventHandler(object sender, ObjectReadyEventArgs e);
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementOperationObserver.Completed'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementOperationObserver.Completed'/> event.</para>
/// </summary>
public delegate void CompletedEventHandler (object sender, CompletedEventArgs e);
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementOperationObserver.Progress'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementOperationObserver.Progress'/> event.</para>
/// </summary>
public delegate void ProgressEventHandler (object sender, ProgressEventArgs e);
/// <summary>
- /// <para>Represents the method that will handle the <see cref='E:System.Management.ManagementOperationObserver.ObjectPut'/> event.</para>
+ /// <para>Represents the method that will handle the <see cref='System.Management.ManagementOperationObserver.ObjectPut'/> event.</para>
/// </summary>
public delegate void ObjectPutEventHandler(object sender, ObjectPutEventArgs e);
}
/// <summary>
- /// Creates an instance of <see cref="ReadOnlySequence{T}"/> from the <see cref="T:T[]"/>.
+ /// Creates an instance of <see cref="ReadOnlySequence{T}"/> from the array.
/// </summary>
public ReadOnlySequence(T[] array)
{
}
/// <summary>
- /// Creates an instance of <see cref="ReadOnlySequence{T}"/> from the <see cref="T:T[]"/>, start and index.
+ /// Creates an instance of <see cref="ReadOnlySequence{T}"/> from the array, start, and index.
/// </summary>
public ReadOnlySequence(T[] array, int start, int length)
{
namespace System.Net.Sockets
{
- /// <devdoc>
- /// <para>
- /// Specifies the address families that an instance of the <see cref='T:System.Net.Sockets.Socket'/>
- /// class can use.
- /// </para>
- /// </devdoc>
+ /// <summary>Specifies the addressing scheme that an instance of the Socket class can use.</summary>
public enum AddressFamily
{
Unknown = -1, // Unknown
/// This implementation is scoped to byte arrays as that is all that the metadata reader needs.
///
/// Also, since we don't have access to immutable collection internals, we use a trick involving
- /// overlapping a <see cref="ImmutableArray{Byte}"/> with a <see cref="T:Byte[]"/> refer. While
+ /// overlapping a <see cref="ImmutableArray{Byte}"/> with an array reference. While
/// unverifiable, it is valid. See ECMA-335, section II.10.7 Controlling instance layout:
///
/// "It is possible to overlap fields in this way, though offsets occupied by an object reference
/// another object reference. While one object reference can completely overlap another, this is
/// unverifiable."
///
- /// Furthermore, the fact that <see cref="ImmutableArray{Byte}"/> backed by a single <see cref="T:Byte[]"/>
+ /// Furthermore, the fact that <see cref="ImmutableArray{Byte}"/> backed by a single byte array
/// field is something inherent to the design of ImmutableArray in order to get its performance
/// characteristics and therefore something we (Microsoft) are comfortable defining as a contract that
/// can be depended upon as below.
// See the LICENSE file in the project root for more information.
using System.Diagnostics;
-using System.Runtime.CompilerServices;
using System.Threading;
using System.Threading.Tasks;
using Windows.Foundation;
#region Factory methods for creating "normal" IAsyncInfo instances backed by a Task created by a pastProvider delegate
/// <summary>
- /// Creates and starts an <see cref="T:Windows.Foundation.IAsyncAction"/> instance from a function that generates
+ /// Creates and starts an <see cref="IAsyncAction"/> instance from a function that generates
/// a <see cref="System.Threading.Tasks.Task"/>.
/// Use this overload if your task supports cancellation in order to hook-up the <code>Cancel</code>
/// mechanism exposed by the created asynchronous action and the cancellation of your task.</summary>
/// The function is passed a <see cref="System.Threading.CancellationToken"/> that the task may monitor
/// to be notified of a cancellation request;
/// you may ignore the <code>CancellationToken</code> if your task does not support cancellation.</param>
- /// <returns>An unstarted <see cref="T:Windows.Foundation.IAsyncAction"/> instance. </returns>
+ /// <returns>An unstarted <see cref="IAsyncAction"/> instance. </returns>
public static IAsyncAction Run(Func<CancellationToken, Task> taskProvider)
{
if (taskProvider == null)
/// <summary>
- /// Creates and starts an <see cref="T:Windows.Foundation.IAsyncActionWithProgress`1"/> instance from a function
+ /// Creates and starts an <see cref="IAsyncActionWithProgress{TProgress}"/> instance from a function
/// that generates a <see cref="System.Threading.Tasks.Task"/>.
/// Use this overload if your task supports cancellation and progress monitoring is order to:
/// (1) hook-up the <code>Cancel</code> mechanism of the created asynchronous action and the cancellation of your task,
/// you may ignore the <code>CancellationToken</code> if your task does not support cancellation.
/// It is also passed a <see cref="System.IProgress{TProgress}"/> instance to which progress updates may be published;
/// you may ignore the <code>IProgress</code> if your task does not support progress reporting.</param>
- /// <returns>An unstarted <see cref="T:Windows.Foundation.IAsyncActionWithProgress`1"/> instance.</returns>
+ /// <returns>An unstarted <see cref="IAsyncActionWithProgress{TProgress}"/> instance.</returns>
public static IAsyncActionWithProgress<TProgress> Run<TProgress>(Func<CancellationToken, IProgress<TProgress>, Task> taskProvider)
{
if (taskProvider == null)
/// <summary>
- /// Creates and starts an <see cref="T:Windows.Foundation.IAsyncOperation`1"/> instance from a function
+ /// Creates and starts an <see cref="IAsyncOperation{TResult}"/> instance from a function
/// that generates a <see cref="System.Threading.Tasks.Task{TResult}"/>.
/// Use this overload if your task supports cancellation in order to hook-up the <code>Cancel</code>
/// mechanism exposed by the created asynchronous operation and the cancellation of your task.</summary>
/// The function is passed a <see cref="System.Threading.CancellationToken"/> that the task may monitor
/// to be notified of a cancellation request;
/// you may ignore the <code>CancellationToken</code> if your task does not support cancellation.</param>
- /// <returns>An unstarted <see cref="T:Windows.Foundation.IAsyncOperation`1"/> instance.</returns>
+ /// <returns>An unstarted <see cref="IAsyncOperation{TResult}"/> instance.</returns>
public static IAsyncOperation<TResult> Run<TResult>(Func<CancellationToken, Task<TResult>> taskProvider)
{
// This is only internal to reduce the number of public overloads.
/// <summary>
- /// Creates and starts an <see cref="T:Windows.Foundation.IAsyncOperationWithProgress`2"/> instance
+ /// Creates and starts an <see cref="IAsyncOperationWithProgress{TResult, TProgress}"/> instance
/// from a function that generates a <see cref="System.Threading.Tasks.Task{TResult}"/>.<br />
/// Use this overload if your task supports cancellation and progress monitoring is order to:
/// (1) hook-up the <code>Cancel</code> mechanism of the created asynchronous operation and the cancellation of your task,
/// you may ignore the <code>CancellationToken</code> if your task does not support cancellation.
/// It is also passed a <see cref="System.IProgress{TProgress}"/> instance to which progress updates may be published;
/// you may ignore the <code>IProgress</code> if your task does not support progress reporting.</param>
- /// <returns>An unstarted <see cref="T:Windows.Foundation.IAsyncOperationWithProgress`2"/> instance.</returns>
+ /// <returns>An unstarted <see cref="IAsyncOperationWithProgress{TResult, TProgress}"/> instance.</returns>
public static IAsyncOperationWithProgress<TResult, TProgress> Run<TResult, TProgress>(
Func<CancellationToken, IProgress<TProgress>, Task<TResult>> taskProvider)
{
#endregion
#region Post and SendAsync
- /// <summary>Posts an item to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
+ /// <summary>Posts an item to the <see cref="System.Threading.Tasks.Dataflow.ITargetBlock{T}"/>.</summary>
/// <typeparam name="TInput">Specifies the type of data accepted by the target block.</typeparam>
/// <param name="target">The target block.</param>
/// <param name="item">The item being offered to the target.</param>
/// <remarks>
/// This method will return once the target block has decided to accept or decline the item,
/// but unless otherwise dictated by special semantics of the target block, it does not wait
- /// for the item to actually be processed (for example, <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>
+ /// for the item to actually be processed (for example, <see cref="System.Threading.Tasks.Dataflow.ActionBlock{T}"/>
/// will return from Post as soon as it has stored the posted item into its input queue). From the perspective
/// of the block's processing, Post is asynchronous. For target blocks that support postponing offered messages,
/// or for blocks that may do more processing in their Post implementation, consider using
- /// <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync">SendAsync</see>,
+ /// <see cref="System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync{TInput}(ITargetBlock{TInput}, TInput)">SendAsync</see>,
/// which will return immediately and will enable the target to postpone the posted message and later consume it
/// after SendAsync returns.
/// </remarks>
#region TryReceive, ReceiveAsync, and Receive
#region TryReceive
/// <summary>
- /// Attempts to synchronously receive an item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
+ /// Attempts to synchronously receive an item from the <see cref="System.Threading.Tasks.Dataflow.ISourceBlock{T}"/>.
/// </summary>
/// <param name="source">The source from which to receive.</param>
/// <param name="item">The item received from the source.</param>
/// Gets a target block that synchronously accepts all messages offered to it and drops them.
/// </summary>
/// <typeparam name="TInput">The type of the messages this block can accept.</typeparam>
- /// <returns>A <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> that accepts and subsequently drops all offered messages.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.Dataflow.ITargetBlock{T}"/> that accepts and subsequently drops all offered messages.</returns>
public static ITargetBlock<TInput> NullTarget<TInput>()
{
return new NullTargetBlock<TInput>();
get { return _defaultTarget != null ? _defaultTarget.Completion : _spscTarget.Completion; }
}
- /// <summary>Posts an item to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
+ /// <summary>Posts an item to the <see cref="System.Threading.Tasks.Dataflow.ITargetBlock{T}"/>.</summary>
/// <param name="item">The item being offered to the target.</param>
/// <returns>true if the item was accepted by the target block; otherwise, false.</returns>
/// <remarks>
/// This method will return once the target block has decided to accept or decline the item,
/// but unless otherwise dictated by special semantics of the target block, it does not wait
- /// for the item to actually be processed (for example, <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>
+ /// for the item to actually be processed (for example, <see cref="System.Threading.Tasks.Dataflow.ActionBlock{T}"/>
/// will return from Post as soon as it has stored the posted item into its input queue). From the perspective
/// of the block's processing, Post is asynchronous. For target blocks that support postponing offered messages,
/// or for blocks that may do more processing in their Post implementation, consider using
- /// <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync">SendAsync</see>,
+ /// <see cref="System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync{TInput}(ITargetBlock{TInput}, TInput)">SendAsync</see>,
/// which will return immediately and will enable the target to postpone the posted message and later consume it
/// after SendAsync returns.
/// </remarks>
/// </summary>
/// <param name="collection">The collection whose elements are copied to the new <see
/// cref="ConcurrentQueue{T}"/>.</param>
- /// <exception cref="T:System.ArgumentNullException">The <paramref name="collection"/> argument is
+ /// <exception cref="System.ArgumentNullException">The <paramref name="collection"/> argument is
/// null.</exception>
public ConcurrentQueue(IEnumerable<T> collection)
{
}
/// <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.
+ /// Copies the elements of the <see cref="System.Collections.ICollection"/> to an <see
+ /// cref="System.Array"/>, starting at a particular
+ /// <see cref="System.Array"/> index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array">Array</see> that is the
+ /// <param name="array">The one-dimensional <see cref="System.Array">Array</see> that is the
/// destination of the elements copied from the
- /// <see cref="T:System.Collections.Concurrent.ConcurrentBag"/>. The <see
- /// cref="T:System.Array">Array</see> must have zero-based indexing.</param>
+ /// <see cref="ConcurrentQueue{T}"/>. The <see
+ /// cref="System.Array">Array</see> must have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// <exception cref="ArgumentNullException"><paramref name="array"/> is a null reference (Nothing in
/// <paramref name="array"/> is multidimensional. -or-
/// <paramref name="array"/> does not have zero-based indexing. -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
+ /// -or- The number of elements in the source <see cref="System.Collections.ICollection"/> is
/// greater than the available space from <paramref name="index"/> to the end of the destination
/// <paramref name="array"/>. -or- The type of the source <see
- /// cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the
+ /// cref="System.Collections.ICollection"/> cannot be cast automatically to the type of the
/// destination <paramref name="array"/>.
/// </exception>
void ICollection.CopyTo(Array array, int index)
}
/// <summary>
- /// Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is
+ /// Gets a value indicating whether access to the <see cref="System.Collections.ICollection"/> is
/// synchronized with the SyncRoot.
/// </summary>
- /// <value>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized
+ /// <value>true if access to the <see cref="System.Collections.ICollection"/> is synchronized
/// with the SyncRoot; otherwise, false. For <see cref="ConcurrentQueue{T}"/>, this property always
/// returns false.</value>
bool ICollection.IsSynchronized
/// <summary>
/// Gets an object that can be used to synchronize access to the <see
- /// cref="T:System.Collections.ICollection"/>. This property is not supported.
+ /// cref="System.Collections.ICollection"/>. This property is not supported.
/// </summary>
- /// <exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
+ /// <exception cref="System.NotSupportedException">The SyncRoot property is not supported.</exception>
object ICollection.SyncRoot
{
get
/// <summary>
/// Returns an enumerator that iterates through a collection.
/// </summary>
- /// <returns>An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the collection.</returns>
+ /// <returns>An <see cref="System.Collections.IEnumerator"/> that can be used to iterate through the collection.</returns>
IEnumerator IEnumerable.GetEnumerator()
{
return ((IEnumerable<T>)this).GetEnumerator();
/// <summary>
/// Attempts to add an object to the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// cref="IProducerConsumerCollection{T}"/>.
/// </summary>
/// <param name="item">The object to add to the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>. The value can be a null
+ /// cref="IProducerConsumerCollection{T}"/>. 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>
/// <summary>
/// Attempts to remove and return an object from the <see
- /// cref="T:System.Collections.Concurrent.IProducerConsumerCollection{T}"/>.
+ /// cref="IProducerConsumerCollection{T}"/>.
/// </summary>
/// <param name="item">
/// When this method returns, if the operation was successful, <paramref name="item"/> contains the
/// <summary>
/// Copies the <see cref="ConcurrentQueue{T}"/> elements to a new <see
- /// cref="T:System.Collections.Generic.List{T}"/>.
+ /// cref="System.Collections.Generic.List{T}"/>.
/// </summary>
- /// <returns>A new <see cref="T:System.Collections.Generic.List{T}"/> containing a snapshot of
+ /// <returns>A new <see cref="System.Collections.Generic.List{T}"/> containing a snapshot of
/// elements copied from the <see cref="ConcurrentQueue{T}"/>.</returns>
private List<T> ToList()
{
/// <summary>
/// Copies the <see cref="ConcurrentQueue{T}"/> elements to an existing one-dimensional <see
- /// cref="T:System.Array">Array</see>, starting at the specified array index.
+ /// cref="System.Array">Array</see>, starting at the specified array index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array">Array</see> that is the
+ /// <param name="array">The one-dimensional <see cref="System.Array">Array</see> that is the
/// destination of the elements copied from the
- /// <see cref="ConcurrentQueue{T}"/>. The <see cref="T:System.Array">Array</see> must have zero-based
+ /// <see cref="ConcurrentQueue{T}"/>. The <see cref="System.Array">Array</see> must have zero-based
/// indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// begins.</param>
/// without removing it.
/// </summary>
/// <param name="result">When this method returns, <paramref name="result"/> contains an object from
- /// the beginning of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue{T}"/> or an
+ /// the beginning of the <see cref="ConcurrentQueue{T}"/> or an
/// unspecified value if the operation failed.</param>
/// <returns>true if and object was returned successfully; otherwise, false.</returns>
public bool TryPeek(out T result)
/// <summary>
/// Copies the elements of the <see cref="IProducerConsumerCollection{T}"/> to
/// an
- /// <see cref="T:System.Array"/>, starting at a specified index.
+ /// <see cref="System.Array"/>, starting at a specified index.
/// </summary>
- /// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of
+ /// <param name="array">The one-dimensional <see cref="System.Array"/> that is the destination of
/// the elements copied from the <see cref="IProducerConsumerCollection{T}"/>.
/// The array must have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying
/// <param name="item">The object to add to the <see
/// cref="IProducerConsumerCollection{T}"/>.</param>
/// <returns>true if the object was added successfully; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentException">The <paramref name="item"/> was invalid for this collection.</exception>
+ /// <exception cref="System.ArgumentException">The <paramref name="item"/> was invalid for this collection.</exception>
bool TryAdd(T item);
/// <summary>
{
/// <summary>
/// Stores options that configure the operation of methods on the
- /// <see cref="T:System.Threading.Tasks.Parallel">Parallel</see> class.
+ /// <see cref="System.Threading.Tasks.Parallel">Parallel</see> class.
/// </summary>
/// <remarks>
/// By default, methods on the Parallel class attempt to utilize all available processors, are non-cancelable, and target
}
/// <summary>
- /// Gets or sets the <see cref="T:System.Threading.Tasks.TaskScheduler">TaskScheduler</see>
+ /// Gets or sets the <see cref="System.Threading.Tasks.TaskScheduler">TaskScheduler</see>
/// associated with this <see cref="ParallelOptions"/> instance. Setting this property to null
/// indicates that the current scheduler should be used.
/// </summary>
/// </summary>
/// <remarks>
/// The <see cref="MaxDegreeOfParallelism"/> limits the number of concurrent operations run by <see
- /// cref="T:System.Threading.Tasks.Parallel">Parallel</see> method calls that are passed this
+ /// cref="System.Threading.Tasks.Parallel">Parallel</see> method calls that are passed this
/// ParallelOptions instance to the set value, if it is positive. If <see
/// cref="MaxDegreeOfParallelism"/> is -1, then there is no limit placed on the number of concurrently
/// running operations.
/// </remarks>
- /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <exception cref="System.ArgumentOutOfRangeException">
/// The exception that is thrown when this <see cref="MaxDegreeOfParallelism"/> is set to 0 or some
/// value less than -1.
/// </exception>
}
/// <summary>
- /// Gets or sets the <see cref="T:System.Threading.CancellationToken">CancellationToken</see>
+ /// Gets or sets the <see cref="System.Threading.CancellationToken">CancellationToken</see>
/// associated with this <see cref="ParallelOptions"/> instance.
/// </summary>
/// <remarks>
- /// Providing a <see cref="T:System.Threading.CancellationToken">CancellationToken</see>
- /// to a <see cref="T:System.Threading.Tasks.Parallel">Parallel</see> method enables the operation to be
+ /// Providing a <see cref="System.Threading.CancellationToken">CancellationToken</see>
+ /// to a <see cref="System.Threading.Tasks.Parallel">Parallel</see> method enables the operation to be
/// exited early. Code external to the operation may cancel the token, and if the operation observes the
/// token being set, it may exit early by throwing an
- /// <see cref="T:System.OperationCanceledException"/>.
+ /// <see cref="System.OperationCanceledException"/>.
/// </remarks>
public CancellationToken CancellationToken
{
/// Provides support for parallel loops and regions.
/// </summary>
/// <remarks>
- /// The <see cref="T:System.Threading.Tasks.Parallel"/> class provides library-based data parallel replacements
+ /// The <see cref="System.Threading.Tasks.Parallel"/> class provides library-based data parallel replacements
/// for common operations such as for loops, for each loops, and execution of a set of statements.
/// </remarks>
public static class Parallel
/// <summary>
/// Executes each of the provided actions, possibly in parallel.
/// </summary>
- /// <param name="actions">An array of <see cref="T:System.Action">Actions</see> to execute.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <param name="actions">An array of <see cref="System.Action">Actions</see> to execute.</param>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="actions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentException">The exception that is thrown when the
/// <paramref name="actions"/> array contains a null element.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown when any
+ /// <exception cref="System.AggregateException">The exception that is thrown when any
/// action in the <paramref name="actions"/> array throws an exception.</exception>
/// <remarks>
/// This method can be used to execute a set of operations, potentially in parallel.
/// <summary>
/// Executes each of the provided actions, possibly in parallel.
/// </summary>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
- /// <param name="actions">An array of <see cref="T:System.Action">Actions</see> to execute.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <param name="actions">An array of <see cref="System.Action">Actions</see> to execute.</param>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="actions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentException">The exception that is thrown when the
/// <paramref name="actions"/> array contains a null element.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown when any
+ /// <exception cref="System.AggregateException">The exception that is thrown when any
/// action in the <paramref name="actions"/> array throws an exception.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
/// <remarks>
/// This method can be used to execute a set of operations, potentially in parallel.
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// </summary>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// </summary>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// which other iterations will not execute.
/// </para>
/// <para>
- /// When a loop is ended prematurely, the <see cref="T:ParallelLoopState"/> that's returned will contain
+ /// When a loop is ended prematurely, the <see cref="ParallelLoopState"/> that's returned will contain
/// relevant information about the loop's completion.
/// </para>
/// </remarks>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// </summary>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// </summary>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each value in the iteration range:
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="fromInclusive">The start index, inclusive.</param>
/// <param name="toExclusive">The end index, exclusive.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// <param name="localInit">A selector function that returns new thread local state.</param>
/// <param name="localFinally">A cleanup function to destroy thread local state.</param>
/// <remarks>Only one of the body arguments may be supplied (i.e. they are exclusive).</remarks>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
private static ParallelLoopResult ForWorker<TLocal>(
int fromInclusive, int toExclusive,
ParallelOptions parallelOptions,
/// <param name="localInit">A selector function that returns new thread local state.</param>
/// <param name="localFinally">A cleanup function to destroy thread local state.</param>
/// <remarks>Only one of the body arguments may be supplied (i.e. they are exclusive).</remarks>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
private static ParallelLoopResult ForWorker64<TLocal>(
long fromInclusive, long toExclusive,
ParallelOptions parallelOptions,
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="source">An enumerable data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// The <paramref name="body"/> delegate is invoked once for each element in the <paramref name="source"/>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="source">An enumerable data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
}
/// <summary>
- /// Executes a for each operation on an <see cref="T:System.Collections.IEnumerable{TSource}"/>
+ /// Executes a for each operation on an <see cref="System.Collections.Generic.IEnumerable{TSource}"/>
/// in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the data in the source.</typeparam>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="source">An enumerable data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
/// <param name="localInit">A selector function that returns new thread local state.</param>
/// <param name="localFinally">A cleanup function to destroy thread local state.</param>
/// <remarks>Only one of the bodyXX arguments may be supplied (i.e. they are exclusive).</remarks>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
private static ParallelLoopResult ForEachWorker<TSource, TLocal>(
IEnumerable<TSource> source,
ParallelOptions parallelOptions,
/// <param name="bodyWithEverything">The loop body for the most generic overload.</param>
/// <param name="localInit">A selector function that returns new thread local state.</param>
/// <param name="localFinally">A cleanup function to destroy thread local state.</param>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
private static ParallelLoopResult ForEachWorker<TSource, TLocal>(
TSource[] array,
ParallelOptions parallelOptions,
/// <param name="bodyWithEverything">The loop body for the most generic overload.</param>
/// <param name="localInit">A selector function that returns new thread local state.</param>
/// <param name="localFinally">A cleanup function to destroy thread local state.</param>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult"/> structure.</returns>
private static ParallelLoopResult ForEachWorker<TSource, TLocal>(
IList<TSource> list,
ParallelOptions parallelOptions,
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The Partitioner that contains the original data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The Partitioner that contains the original data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.OrderablePartitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The OrderablePartitioner that contains the original data source.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// KeysNormalized property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> OrderablePartitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner do not return the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IList with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() or GetDynamicOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.OrderablePartitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// KeysNormalized property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> OrderablePartitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner do not return the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IList with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() or GetDynamicOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The Partitioner that contains the original data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The Partitioner that contains the original data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.OrderablePartitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The OrderablePartitioner that contains the original data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// KeysNormalized property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> OrderablePartitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner do not return the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IList with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() or GetDynamicOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.Partitioner{TSource}">
/// Partitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="source">The Partitioner that contains the original data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> Partitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> Partitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner does not return
/// the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() method in the <paramref name="source"/> Partitioner returns an IList
/// with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() method in the <paramref name="source"/> Partitioner returns an
/// IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
}
/// <summary>
- /// Executes a for each operation on a <see cref="T:System.Collections.Concurrent.OrderablePartitioner{TSource}">
+ /// Executes a for each operation on a <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see> in which iterations may run in parallel.
/// </summary>
/// <typeparam name="TSource">The type of the elements in <paramref name="source"/>.</typeparam>
/// <typeparam name="TLocal">The type of the thread-local data.</typeparam>
/// <param name="source">The OrderablePartitioner that contains the original data source.</param>
- /// <param name="parallelOptions">A <see cref="T:System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
+ /// <param name="parallelOptions">A <see cref="System.Threading.Tasks.ParallelOptions">ParallelOptions</see>
/// instance that configures the behavior of this operation.</param>
/// <param name="localInit">The function delegate that returns the initial state of the local data
/// for each thread.</param>
/// <param name="body">The delegate that is invoked once per iteration.</param>
/// <param name="localFinally">The delegate that performs a final action on the local state of each
/// thread.</param>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="source"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="parallelOptions"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the <paramref name="body"/>
/// argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localInit"/> argument is null.</exception>
- /// <exception cref="T:System.ArgumentNullException">The exception that is thrown when the
+ /// <exception cref="System.ArgumentNullException">The exception that is thrown when the
/// <paramref name="localFinally"/> argument is null.</exception>
- /// <exception cref="T:System.OperationCanceledException">The exception that is thrown when the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
+ /// <exception cref="System.OperationCanceledException">The exception that is thrown when the
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> in the <paramref name="parallelOptions"/>
/// argument is set</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// SupportsDynamicPartitions property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// KeysNormalized property in the <paramref name="source"/> OrderablePartitioner returns
/// false.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when any
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when any
/// methods in the <paramref name="source"/> OrderablePartitioner return null.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner do not return the correct number of partitions.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetPartitions() or GetOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IList with at least one null value.</exception>
- /// <exception cref="T:System.InvalidOperationException">The exception that is thrown when the
+ /// <exception cref="System.InvalidOperationException">The exception that is thrown when the
/// GetDynamicPartitions() or GetDynamicOrderablePartitions() methods in the <paramref name="source"/>
/// OrderablePartitioner return an IEnumerable whose GetEnumerator() method returns null.</exception>
- /// <exception cref="T:System.AggregateException">The exception that is thrown to contain an exception
+ /// <exception cref="System.AggregateException">The exception that is thrown to contain an exception
/// thrown from one of the specified delegates.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The exception that is thrown when the
- /// the <see cref="T:System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
- /// the <see cref="T:System.Threading.CancellationToken">CancellationToken</see> in the
+ /// <exception cref="System.ObjectDisposedException">The exception that is thrown when the
+ /// the <see cref="System.Threading.CancellationTokenSource">CancellationTokenSource</see> associated with the
+ /// the <see cref="System.Threading.CancellationToken">CancellationToken</see> in the
/// <paramref name="parallelOptions"/> has been disposed.</exception>
- /// <returns>A <see cref="T:System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
+ /// <returns>A <see cref="System.Threading.Tasks.ParallelLoopResult">ParallelLoopResult</see> structure
/// that contains information on what portion of the loop completed.</returns>
/// <remarks>
/// <para>
- /// The <see cref="T:System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
+ /// The <see cref="System.Collections.Concurrent.Partitioner{TSource}">Partitioner</see> is used to retrieve
/// the elements to be processed, in place of the original data source. If the current element's
- /// index is desired, the source must be an <see cref="T:System.Collections.Concurrent.OrderablePartitioner">
+ /// index is desired, the source must be an <see cref="System.Collections.Concurrent.OrderablePartitioner{TSource}">
/// OrderablePartitioner</see>.
/// </para>
/// <para>
namespace System.Threading.Tasks
{
/// <summary>
- /// Enables iterations of <see cref="T:System.Threading.Tasks.Parallel"/> loops to interact with
+ /// Enables iterations of <see cref="System.Threading.Tasks.Parallel"/> loops to interact with
/// other iterations.
/// </summary>
[DebuggerDisplay("ShouldExitCurrentIteration = {ShouldExitCurrentIteration}")]
/// Communicates that the <see cref="Parallel"/> loop should cease execution at the system's earliest
/// convenience.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The <see cref="Break()"/> method was previously called. <see cref="Break()"/> and <see
/// cref="Stop()"/> may not be used in combination by iterations of the same loop.
/// </exception>
/// Communicates that the <see cref="Parallel"/> loop should cease execution at the system's earliest
/// convenience of iterations beyond the current iteration.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The <see cref="Stop()"/> method was previously called. <see cref="Break()"/> and <see cref="Stop()"/>
/// may not be used in combination by iterations of the same loop.
/// </exception>
/// Communicates that parallel tasks should stop when they reach a specified iteration element.
/// (which is CurrentIteration of the caller).
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">Break() called after Stop().</exception>
+ /// <exception cref="System.InvalidOperationException">Break() called after Stop().</exception>
/// <remarks>
/// This is shared with all other concurrent threads in the system which are participating in the
/// loop's execution. After calling Break(), no additional iterations will be executed on
/// Communicates that parallel tasks should stop when they reach a specified iteration element.
/// (which is CurrentIteration of the caller).
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">Break() called after Stop().</exception>
+ /// <exception cref="System.InvalidOperationException">Break() called after Stop().</exception>
/// <remarks>
/// Atomically sets shared StoppedBroken flag to BROKEN, then atomically sets shared
/// LowestBreakIteration to CurrentIteration, but only if CurrentIteration is less than
/// </summary>
/// <param name="participantCount">The number of participating threads.</param>
/// <exception cref="ArgumentOutOfRangeException"> <paramref name="participantCount"/> is less than 0
- /// or greater than <see cref="T:System.Int16.MaxValue"/>.</exception>
+ /// or greater than <see cref="System.Int16.MaxValue"/>.</exception>
public Barrier(int participantCount)
: this(participantCount, null)
{
/// Initializes a new instance of the <see cref="Barrier"/> class.
/// </summary>
/// <param name="participantCount">The number of participating threads.</param>
- /// <param name="postPhaseAction">The <see cref="T:System.Action`1"/> to be executed after each
+ /// <param name="postPhaseAction">The <see cref="System.Action{Barrier}"/> to be executed after each
/// phase.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="participantCount"/> is less than 0
- /// or greater than <see cref="T:System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.ArgumentOutOfRangeException"> <paramref name="participantCount"/> is less than 0
+ /// or greater than <see cref="System.Int32.MaxValue"/>.</exception>
/// <remarks>
/// The <paramref name="postPhaseAction"/> delegate will be executed after
/// all participants have arrived at the barrier in one phase. The participants
/// </summary>
/// <returns>The phase number of the barrier in which the new participants will first
/// participate.</returns>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// Adding a participant would cause the barrier's participant count to
- /// exceed <see cref="T:System.Int16.MaxValue"/>.
+ /// exceed <see cref="System.Int16.MaxValue"/>.
/// </exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public long AddParticipant()
{
/// barrier.</param>
/// <returns>The phase number of the barrier in which the new participants will first
/// participate.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="participantCount"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="participantCount"/> is less than
/// 0.</exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException">Adding <paramref name="participantCount"/> participants would cause the
- /// barrier's participant count to exceed <see cref="T:System.Int16.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.ArgumentOutOfRangeException">Adding <paramref name="participantCount"/> participants would cause the
+ /// barrier's participant count to exceed <see cref="System.Int16.MaxValue"/>.</exception>
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public long AddParticipants(int participantCount)
{
/// <summary>
/// Notifies the <see cref="Barrier"/> that there will be one less participant.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">The barrier already has 0
+ /// <exception cref="System.InvalidOperationException">The barrier already has 0
/// participants.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void RemoveParticipant()
{
/// Notifies the <see cref="Barrier"/> that there will be fewer participants.
/// </summary>
/// <param name="participantCount">The number of additional participants to remove from the barrier.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="participantCount"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="participantCount"/> is less than
/// 0.</exception>
- /// <exception cref="T:System.InvalidOperationException">The barrier already has 0 participants.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">The barrier already has 0 participants.</exception>
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void RemoveParticipants(int participantCount)
{
/// Signals that a participant has reached the <see cref="Barrier"/> and waits for all other
/// participants to reach the barrier as well.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void SignalAndWait()
{
/// <summary>
/// Signals that a participant has reached the <see cref="Barrier"/> and waits for all other
/// participants to reach the barrier, while observing a <see
- /// cref="T:System.Threading.CancellationToken"/>.
+ /// cref="System.Threading.CancellationToken"/>.
/// </summary>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has been
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has been
/// canceled.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void SignalAndWait(CancellationToken cancellationToken)
{
/// <summary>
/// Signals that a participant has reached the <see cref="Barrier"/> and waits for all other
/// participants to reach the barrier as well, using a
- /// <see cref="T:System.TimeSpan"/> to measure the time interval.
+ /// <see cref="System.TimeSpan"/> to measure the time interval.
/// </summary>
- /// <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
+ /// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of
+ /// milliseconds to wait, or a <see cref="System.TimeSpan"/> that represents -1 milliseconds to
/// wait indefinitely.</param>
/// <returns>true if all other participants reached the barrier; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/>is a negative number
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="timeout"/>is a negative number
/// other than -1 milliseconds, which represents an infinite time-out, or it is greater than
- /// <see cref="T:System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <see cref="System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool SignalAndWait(TimeSpan timeout)
{
/// <summary>
/// Signals that a participant has reached the <see cref="Barrier"/> and waits for all other
/// participants to reach the barrier as well, using a
- /// <see cref="T:System.TimeSpan"/> to measure the time interval, while observing a <see
- /// cref="T:System.Threading.CancellationToken"/>.
+ /// <see cref="System.TimeSpan"/> to measure the time interval, while observing a <see
+ /// cref="System.Threading.CancellationToken"/>.
/// </summary>
- /// <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
+ /// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of
+ /// milliseconds to wait, or a <see cref="System.TimeSpan"/> that represents -1 milliseconds to
/// wait indefinitely.</param>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
/// <returns>true if all other participants reached the barrier; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/>is a negative number
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="timeout"/>is a negative number
/// other than -1 milliseconds, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has been
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has been
/// canceled.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool SignalAndWait(TimeSpan timeout, CancellationToken cancellationToken)
{
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// cref="Timeout.Infinite"/>(-1) to wait indefinitely.</param>
/// <returns>true if all other participants reached the barrier; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool SignalAndWait(int millisecondsTimeout)
{
/// Signals that a participant has reached the barrier and waits for all other participants to reach
/// the barrier as well, using a
/// 32-bit signed integer to measure the time interval, while observing a <see
- /// cref="T:System.Threading.CancellationToken"/>.
+ /// cref="System.Threading.CancellationToken"/>.
/// </summary>
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// cref="Timeout.Infinite"/>(-1) to wait indefinitely.</param>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
/// <returns>true if all other participants reached the barrier; otherwise, false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action, the barrier currently has 0 participants,
/// or the barrier is being used by more threads than are registered as participants.
/// </exception>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has been
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has been
/// canceled.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool SignalAndWait(int millisecondsTimeout, CancellationToken cancellationToken)
{
/// <summary>
/// Releases all resources used by the current instance of <see cref="Barrier"/>.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The method was invoked from within a post-phase action.
/// </exception>
/// <remarks>
private volatile bool _disposed; // Whether the latch has been disposed.
/// <summary>
- /// Initializes a new instance of <see cref="T:System.Threading.CountdownEvent"/> class with the
+ /// Initializes a new instance of <see cref="System.Threading.CountdownEvent"/> class with the
/// specified count.
/// </summary>
/// <param name="initialCount">The number of signals required to set the <see
- /// cref="T:System.Threading.CountdownEvent"/>.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="initialCount"/> is less
+ /// cref="System.Threading.CountdownEvent"/>.</param>
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="initialCount"/> is less
/// than 0.</exception>
public CountdownEvent(int initialCount)
{
}
/// <summary>
- /// Gets a <see cref="T:System.Threading.WaitHandle"/> that is used to wait for the event to be set.
+ /// Gets a <see cref="System.Threading.WaitHandle"/> that is used to wait for the event to be set.
/// </summary>
- /// <value>A <see cref="T:System.Threading.WaitHandle"/> that is used to wait for the event to be set.</value>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
+ /// <value>A <see cref="System.Threading.WaitHandle"/> that is used to wait for the event to be set.</value>
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been disposed.</exception>
/// <remarks>
/// <see cref="WaitHandle"/> should only be used if it's needed for integration with code bases
/// that rely on having a WaitHandle. If all that's needed is to wait for the <see cref="CountdownEvent"/>
}
/// <summary>
- /// Releases all resources used by the current instance of <see cref="T:System.Threading.CountdownEvent"/>.
+ /// Releases all resources used by the current instance of <see cref="System.Threading.CountdownEvent"/>.
/// </summary>
/// <remarks>
/// Unlike most of the members of <see cref="CountdownEvent"/>, <see cref="Dispose()"/> is not
/// <summary>
/// When overridden in a derived class, releases the unmanaged resources used by the
- /// <see cref="T:System.Threading.CountdownEvent"/>, and optionally releases the managed resources.
+ /// <see cref="System.Threading.CountdownEvent"/>, and optionally releases the managed resources.
/// </summary>
/// <param name="disposing">true to release both managed and unmanaged resources; false to release
/// only unmanaged resources.</param>
}
/// <summary>
- /// Registers a signal with the <see cref="T:System.Threading.CountdownEvent"/>, decrementing its
+ /// Registers a signal with the <see cref="System.Threading.CountdownEvent"/>, decrementing its
/// count.
/// </summary>
/// <returns>true if the signal caused the count to reach zero and the event was set; otherwise,
/// false.</returns>
- /// <exception cref="T:System.InvalidOperationException">The current instance is already set.
+ /// <exception cref="System.InvalidOperationException">The current instance is already set.
/// </exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool Signal()
{
}
/// <summary>
- /// Registers multiple signals with the <see cref="T:System.Threading.CountdownEvent"/>,
+ /// Registers multiple signals with the <see cref="System.Threading.CountdownEvent"/>,
/// decrementing its count by the specified amount.
/// </summary>
/// <param name="signalCount">The number of signals to register.</param>
/// <returns>true if the signals caused the count to reach zero and the event was set; otherwise,
/// false.</returns>
- /// <exception cref="T:System.InvalidOperationException">
+ /// <exception cref="System.InvalidOperationException">
/// The current instance is already set. -or- Or <paramref name="signalCount"/> is greater than <see
/// cref="CurrentCount"/>.
/// </exception>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less
/// than 1.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool Signal(int signalCount)
{
}
/// <summary>
- /// Increments the <see cref="T:System.Threading.CountdownEvent"/>'s current count by one.
+ /// Increments the <see cref="System.Threading.CountdownEvent"/>'s current count by one.
/// </summary>
- /// <exception cref="T:System.InvalidOperationException">The current instance is already
+ /// <exception cref="System.InvalidOperationException">The current instance is already
/// set.</exception>
- /// <exception cref="T:System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
- /// cref="T:System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">
+ /// <exception cref="System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
+ /// cref="System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.ObjectDisposedException">
/// The current instance has already been disposed.
/// </exception>
public void AddCount()
}
/// <summary>
- /// Attempts to increment the <see cref="T:System.Threading.CountdownEvent"/>'s current count by one.
+ /// Attempts to increment the <see cref="System.Threading.CountdownEvent"/>'s current count by one.
/// </summary>
/// <returns>true if the increment succeeded; otherwise, false. If <see cref="CurrentCount"/> is
/// already at zero. this will return false.</returns>
- /// <exception cref="T:System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
- /// cref="T:System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
+ /// cref="System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool TryAddCount()
{
}
/// <summary>
- /// Increments the <see cref="T:System.Threading.CountdownEvent"/>'s current count by a specified
+ /// Increments the <see cref="System.Threading.CountdownEvent"/>'s current count by a specified
/// value.
/// </summary>
/// <param name="signalCount">The value by which to increase <see cref="CurrentCount"/>.</param>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less than
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less than
/// 0.</exception>
- /// <exception cref="T:System.InvalidOperationException">The current instance is already
+ /// <exception cref="System.InvalidOperationException">The current instance is already
/// set.</exception>
- /// <exception cref="T:System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
- /// cref="T:System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
+ /// cref="System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void AddCount(int signalCount)
{
}
/// <summary>
- /// Attempts to increment the <see cref="T:System.Threading.CountdownEvent"/>'s current count by a
+ /// Attempts to increment the <see cref="System.Threading.CountdownEvent"/>'s current count by a
/// specified value.
/// </summary>
/// <param name="signalCount">The value by which to increase <see cref="CurrentCount"/>.</param>
/// <returns>true if the increment succeeded; otherwise, false. If <see cref="CurrentCount"/> is
/// already at zero this will return false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="signalCount"/> is less
/// than 0.</exception>
- /// <exception cref="T:System.InvalidOperationException">The current instance is already
+ /// <exception cref="System.InvalidOperationException">The current instance is already
/// set.</exception>
- /// <exception cref="T:System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
- /// cref="T:System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.InvalidOperationException"><see cref="CurrentCount"/> is equal to <see
+ /// cref="System.Int32.MaxValue"/>.</exception>
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool TryAddCount(int signalCount)
{
/// Unlike most of the members of <see cref="CountdownEvent"/>, Reset is not
/// thread-safe and may not be used concurrently with other members of this instance.
/// </remarks>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void Reset()
{
/// Resets the <see cref="CurrentCount"/> to a specified value.
/// </summary>
/// <param name="count">The number of signals required to set the <see
- /// cref="T:System.Threading.CountdownEvent"/>.</param>
+ /// cref="System.Threading.CountdownEvent"/>.</param>
/// <remarks>
/// Unlike most of the members of <see cref="CountdownEvent"/>, Reset is not
/// thread-safe and may not be used concurrently with other members of this instance.
/// </remarks>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="count"/> is
+ /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="count"/> is
/// less than 0.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been disposed.</exception>
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been disposed.</exception>
public void Reset(int count)
{
ThrowIfDisposed();
}
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set.
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set.
/// </summary>
/// <remarks>
/// The caller of this method blocks indefinitely until the current instance is set. The caller will
/// return immediately if the event is currently in a set state.
/// </remarks>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void Wait()
{
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set, while
- /// observing a <see cref="T:System.Threading.CancellationToken"/>.
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set, while
+ /// observing a <see cref="System.Threading.CancellationToken"/>.
/// </summary>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
/// <remarks>
/// The caller of this method blocks indefinitely until the current instance is set. The caller will
/// return immediately if the event is currently in a set state. If the
- /// <see cref="T:System.Threading.CancellationToken">CancellationToken</see> being observed
- /// is canceled during the wait operation, an <see cref="T:System.OperationCanceledException"/>
+ /// <see cref="System.Threading.CancellationToken">CancellationToken</see> being observed
+ /// is canceled during the wait operation, an <see cref="System.OperationCanceledException"/>
/// will be thrown.
/// </remarks>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has been
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has been
/// canceled.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public void Wait(CancellationToken cancellationToken)
{
}
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set, using a
- /// <see cref="T:System.TimeSpan"/> to measure the time interval.
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set, using a
+ /// <see cref="System.TimeSpan"/> to measure the time interval.
/// </summary>
- /// <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
+ /// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of
+ /// milliseconds to wait, or a <see cref="System.TimeSpan"/> that represents -1 milliseconds to
/// wait indefinitely.</param>
/// <returns>true if the <see cref="System.Threading.CountdownEvent"/> was set; otherwise,
/// false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool Wait(TimeSpan timeout)
{
}
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set, using
- /// a <see cref="T:System.TimeSpan"/> to measure the time interval, while observing a
- /// <see cref="T:System.Threading.CancellationToken"/>.
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set, using
+ /// a <see cref="System.TimeSpan"/> to measure the time interval, while observing a
+ /// <see cref="System.Threading.CancellationToken"/>.
/// </summary>
- /// <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
+ /// <param name="timeout">A <see cref="System.TimeSpan"/> that represents the number of
+ /// milliseconds to wait, or a <see cref="System.TimeSpan"/> that represents -1 milliseconds to
/// wait indefinitely.</param>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
/// <returns>true if the <see cref="System.Threading.CountdownEvent"/> was set; otherwise,
/// false.</returns>
- /// <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> is a negative
+ /// <exception cref="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="System.Int32.MaxValue"/>.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has
/// been canceled.</exception>
public bool Wait(TimeSpan timeout, CancellationToken cancellationToken)
{
}
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set, using a
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set, using a
/// 32-bit signed integer to measure the time interval.
/// </summary>
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// false.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
public bool Wait(int millisecondsTimeout)
{
}
/// <summary>
- /// Blocks the current thread until the <see cref="T:System.Threading.CountdownEvent"/> is set, using a
+ /// Blocks the current thread until the <see cref="System.Threading.CountdownEvent"/> is set, using a
/// 32-bit signed integer to measure the time interval, while observing a
- /// <see cref="T:System.Threading.CancellationToken"/>.
+ /// <see cref="System.Threading.CancellationToken"/>.
/// </summary>
/// <param name="millisecondsTimeout">The number of milliseconds to wait, or <see
/// cref="Timeout.Infinite"/>(-1) to wait indefinitely.</param>
- /// <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to
+ /// <param name="cancellationToken">The <see cref="System.Threading.CancellationToken"/> to
/// observe.</param>
/// <returns>true if the <see cref="System.Threading.CountdownEvent"/> was set; otherwise,
/// false.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="millisecondsTimeout"/> is a
/// negative number other than -1, which represents an infinite time-out.</exception>
- /// <exception cref="T:System.ObjectDisposedException">The current instance has already been
+ /// <exception cref="System.ObjectDisposedException">The current instance has already been
/// disposed.</exception>
- /// <exception cref="T:System.OperationCanceledException"><paramref name="cancellationToken"/> has
+ /// <exception cref="System.OperationCanceledException"><paramref name="cancellationToken"/> has
/// been canceled.</exception>
public bool Wait(int millisecondsTimeout, CancellationToken cancellationToken)
{