Skip to content

Commit 821ec63

Browse files
Automatic port of System.Threading exceptions (dotnet#4656)
* Automatic port of System.Threading exceptions * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Threading.Tasks/TaskCompletionSource.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 411a8d4 commit 821ec63

File tree

5 files changed

+61
-17
lines changed

5 files changed

+61
-17
lines changed

xml/System.Threading.Channels/ChannelReader`1.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ChannelReader&lt;T&gt;" FullName="System.Threading.Channels.ChannelReader&lt;T&gt;">
1+
<Type Name="ChannelReader&lt;T&gt;" FullName="System.Threading.Channels.ChannelReader&lt;T&gt;">
22
<TypeSignature Language="C#" Value="public abstract class ChannelReader&lt;T&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ChannelReader`1&lt;T&gt; extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.Channels.ChannelReader`1" />
@@ -110,6 +110,7 @@
110110
<summary>Gets the current number of items available from this channel reader.</summary>
111111
<value>To be added.</value>
112112
<remarks>To be added.</remarks>
113+
<exception cref="T:System.NotSupportedException">Counting is not supported on this instance.</exception>
113114
</Docs>
114115
</Member>
115116
<Member MemberName="ReadAllAsync">

xml/System.Threading.Tasks/Task.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="Task" FullName="System.Threading.Tasks.Task">
1+
<Type Name="Task" FullName="System.Threading.Tasks.Task">
22
<TypeSignature Language="C#" Value="public class Task : IAsyncResult" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Task extends System.Object implements class System.IAsyncResult" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.Tasks.Task" />
@@ -5671,6 +5671,8 @@ The returned task will complete when any of the supplied tasks has completed. T
56715671
56725672
]]></format>
56735673
</remarks>
5674+
<exception cref="T:System.ArgumentNullException">
5675+
<paramref name="task1" /> or <paramref name="task2" /> was <see langword="null" />.</exception>
56745676
</Docs>
56755677
</Member>
56765678
<Member MemberName="WhenAny&lt;TResult&gt;">
@@ -5838,6 +5840,8 @@ The returned task will complete when any of the supplied tasks has completed. T
58385840
58395841
]]></format>
58405842
</remarks>
5843+
<exception cref="T:System.ArgumentNullException">
5844+
<paramref name="task1" /> or <paramref name="task2" /> was <see langword="null" />.</exception>
58415845
</Docs>
58425846
</Member>
58435847
<Member MemberName="Yield">

xml/System.Threading.Tasks/TaskCompletionSource.xml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="TaskCompletionSource" FullName="System.Threading.Tasks.TaskCompletionSource">
1+
<Type Name="TaskCompletionSource" FullName="System.Threading.Tasks.TaskCompletionSource">
22
<TypeSignature Language="C#" Value="public class TaskCompletionSource" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TaskCompletionSource extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.Tasks.TaskCompletionSource" />
@@ -94,6 +94,8 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
9494
9595
]]></format>
9696
</remarks>
97+
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the specified <paramref name="creationOptions" /> are invalid for use with a <see cref="T:System.Threading.Tasks.TaskCompletionSource" />.
98+
</exception>
9799
</Docs>
98100
</Member>
99101
<Member MemberName=".ctor">
@@ -117,6 +119,8 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
117119
<param name="creationOptions">The options to use when creating the underlying <see cref="T:System.Threading.Tasks.Task" />.</param>
118120
<summary>Creates a <see cref="T:System.Threading.Tasks.TaskCompletionSource" /> with the specified state and options.</summary>
119121
<remarks>To be added.</remarks>
122+
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the specified <paramref name="creationOptions" /> are invalid for use with a <see cref="T:System.Threading.Tasks.TaskCompletionSource" />.
123+
</exception>
120124
</Docs>
121125
</Member>
122126
<Member MemberName="SetCanceled">
@@ -138,6 +142,7 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
138142
<Docs>
139143
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state.</summary>
140144
<remarks>To be added.</remarks>
145+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
141146
</Docs>
142147
</Member>
143148
<Member MemberName="SetCanceled">
@@ -162,6 +167,7 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
162167
<param name="cancellationToken">The cancellation token with which to cancel the <see cref="T:System.Threading.Tasks.Task" />.</param>
163168
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state using the specified token.</summary>
164169
<remarks>To be added.</remarks>
170+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
165171
</Docs>
166172
</Member>
167173
<Member MemberName="SetException">
@@ -186,6 +192,10 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
186192
<param name="exceptions">The collection of exceptions to bind to this <see cref="T:System.Threading.Tasks.Task" />.</param>
187193
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</summary>
188194
<remarks>To be added.</remarks>
195+
<exception cref="T:System.ArgumentNullException">
196+
<paramref name="exceptions" /> is <see langword="null" />.</exception>
197+
<exception cref="T:System.ArgumentException">There are one or more <see langword="null" /> elements in <paramref name="exceptions" />.</exception>
198+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
189199
</Docs>
190200
</Member>
191201
<Member MemberName="SetException">
@@ -210,6 +220,9 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
210220
<param name="exception">The exception to bind to this <see cref="T:System.Threading.Tasks.Task" />.</param>
211221
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</summary>
212222
<remarks>To be added.</remarks>
223+
<exception cref="T:System.ArgumentNullException">
224+
<paramref name="exception" /> is <see langword="null" />.</exception>
225+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
213226
</Docs>
214227
</Member>
215228
<Member MemberName="SetResult">
@@ -231,6 +244,7 @@ The <xref:System.Threading.Tasks.Task> created by this instance and accessible t
231244
<Docs>
232245
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" /> state.</summary>
233246
<remarks>To be added.</remarks>
247+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
234248
</Docs>
235249
</Member>
236250
<Member MemberName="Task">
@@ -363,6 +377,10 @@ This operation will return `false` if the <xref:System.Threading.Tasks.Task> is
363377
364378
]]></format>
365379
</remarks>
380+
<exception cref="T:System.ArgumentNullException">
381+
<paramref name="exceptions" /> is <see langword="null" />.</exception>
382+
<exception cref="T:System.ArgumentException">There are one or more <see langword="null" /> elements in <paramref name="exceptions" />.</exception>
383+
<exception cref="T:System.ArgumentException">The <paramref name="exceptions" /> collection is empty.</exception>
366384
</Docs>
367385
</Member>
368386
<Member MemberName="TrySetException">
@@ -398,6 +416,8 @@ This operation will return `false` if the <xref:System.Threading.Tasks.Task> is
398416
399417
]]></format>
400418
</remarks>
419+
<exception cref="T:System.ArgumentNullException">
420+
<paramref name="exception" /> is <see langword="null" />.</exception>
401421
</Docs>
402422
</Member>
403423
<Member MemberName="TrySetResult">

xml/System.Threading.Tasks/TaskCompletionSource`1.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="TaskCompletionSource&lt;TResult&gt;" FullName="System.Threading.Tasks.TaskCompletionSource&lt;TResult&gt;">
1+
<Type Name="TaskCompletionSource&lt;TResult&gt;" FullName="System.Threading.Tasks.TaskCompletionSource&lt;TResult&gt;">
22
<TypeSignature Language="C#" Value="public class TaskCompletionSource&lt;TResult&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TaskCompletionSource`1&lt;TResult&gt; extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.Tasks.TaskCompletionSource`1" />
@@ -323,6 +323,7 @@
323323
<param name="cancellationToken">The cancellation token with which to cancel the <see cref="T:System.Threading.Tasks.Task`1" />.</param>
324324
<summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state using the specified token.</summary>
325325
<remarks>To be added.</remarks>
326+
<exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task`1" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
326327
</Docs>
327328
</Member>
328329
<MemberGroup MemberName="SetException">

0 commit comments

Comments
 (0)