Skip to content

Commit 9951e3f

Browse files
authored
Add missing docs for Task API (dotnet#10405)
* Add missing docs for Task API * Apply suggestions from code review
1 parent ec4f911 commit 9951e3f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

xml/System.Threading.Tasks.Sources/ManualResetValueTaskSourceCore`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
</Attribute>
5858
</Attributes>
5959
<Docs>
60-
<typeparam name="TResult" />
60+
<typeparam name="TResult">Specifies the type of results of the operation represented by this instance.</typeparam>
6161
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource" /> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1" />.</summary>
6262
<remarks>To be added.</remarks>
6363
</Docs>
@@ -308,7 +308,7 @@
308308
<Parameter Name="error" Type="System.Exception" />
309309
</Parameters>
310310
<Docs>
311-
<param name="error" />
311+
<param name="error">The exception.</param>
312312
<summary>Complets with an error.</summary>
313313
<remarks>To be added.</remarks>
314314
</Docs>

xml/System.Threading.Tasks/Task.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6720,7 +6720,7 @@ An exception was thrown during
67206720
</Parameter>
67216721
</Parameters>
67226722
<Docs>
6723-
<typeparam name="TResult">To be added.</typeparam>
6723+
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
67246724
<param name="tasks">The tasks to wait on for completion.</param>
67256725
<summary>Creates a task that will complete when all of the supplied tasks have completed.</summary>
67266726
<returns>A task that represents the completion of all of the supplied tasks.</returns>
@@ -7178,7 +7178,7 @@ The returned task will complete when any of the supplied tasks has completed. T
71787178
</Parameter>
71797179
</Parameters>
71807180
<Docs>
7181-
<typeparam name="TResult">To be added.</typeparam>
7181+
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
71827182
<param name="tasks">The tasks to wait on for completion.</param>
71837183
<summary>Creates a task that will complete when any of the supplied tasks have completed.</summary>
71847184
<returns>A task that represents the completion of one of the supplied tasks. The return Task's Result is the task that completed.</returns>
@@ -7352,7 +7352,7 @@ The returned task will complete when any of the supplied tasks has completed. T
73527352
<Parameter Name="tasks" Type="System.Collections.Generic.IEnumerable&lt;System.Threading.Tasks.Task&gt;" Index="0" FrameworkAlternate="net-9.0" />
73537353
</Parameters>
73547354
<Docs>
7355-
<param name="tasks">To be added.</param>
7355+
<param name="tasks">The tasks to iterate through as they complete.</param>
73567356
<summary>To be added.</summary>
73577357
<returns>To be added.</returns>
73587358
<remarks>To be added.</remarks>
@@ -7394,7 +7394,7 @@ The returned task will complete when any of the supplied tasks has completed. T
73947394
</Parameter>
73957395
</Parameters>
73967396
<Docs>
7397-
<param name="tasks">To be added.</param>
7397+
<param name="tasks">The tasks to iterate through as they complete.</param>
73987398
<summary>To be added.</summary>
73997399
<returns>To be added.</returns>
74007400
<remarks>To be added.</remarks>
@@ -7484,8 +7484,8 @@ The returned task will complete when any of the supplied tasks has completed. T
74847484
<Parameter Name="tasks" Type="System.Collections.Generic.IEnumerable&lt;System.Threading.Tasks.Task&lt;TResult&gt;&gt;" Index="0" FrameworkAlternate="net-9.0" />
74857485
</Parameters>
74867486
<Docs>
7487-
<typeparam name="TResult">To be added.</typeparam>
7488-
<param name="tasks">To be added.</param>
7487+
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
7488+
<param name="tasks">The tasks to iterate through as they complete.</param>
74897489
<summary>To be added.</summary>
74907490
<returns>To be added.</returns>
74917491
<remarks>To be added.</remarks>
@@ -7537,8 +7537,8 @@ The returned task will complete when any of the supplied tasks has completed. T
75377537
</Parameter>
75387538
</Parameters>
75397539
<Docs>
7540-
<typeparam name="TResult">To be added.</typeparam>
7541-
<param name="tasks">To be added.</param>
7540+
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
7541+
<param name="tasks">The tasks to iterate through as they complete.</param>
75427542
<summary>To be added.</summary>
75437543
<returns>To be added.</returns>
75447544
<remarks>To be added.</remarks>
@@ -7590,8 +7590,8 @@ The returned task will complete when any of the supplied tasks has completed. T
75907590
</Parameter>
75917591
</Parameters>
75927592
<Docs>
7593-
<typeparam name="TResult">To be added.</typeparam>
7594-
<param name="tasks">To be added.</param>
7593+
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
7594+
<param name="tasks">The tasks to iterate through as they complete.</param>
75957595
<summary>To be added.</summary>
75967596
<returns>To be added.</returns>
75977597
<remarks>To be added.</remarks>

0 commit comments

Comments
 (0)