Skip to content

Add missing docs for Task API #10405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Add missing docs for Task API #10405

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80ee702
Add missing docs for Task API
ericstj Sep 17, 2024
9614393
Apply suggestions from code review
ericstj Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions xml/System.Threading.Tasks.Sources/ManualResetValueTaskSourceCore`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
</Attribute>
</Attributes>
<Docs>
<typeparam name="TResult" />
<typeparam name="TResult">Specifies the type of results of the operation represented by this instance.</typeparam>
<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>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -308,7 +308,7 @@
<Parameter Name="error" Type="System.Exception" />
</Parameters>
<Docs>
<param name="error" />
<param name="error">The exception.</param>
<summary>Complets with an error.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
20 changes: 10 additions & 10 deletions xml/System.Threading.Tasks/Task.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6720,7 +6720,7 @@ An exception was thrown during
</Parameter>
</Parameters>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
<param name="tasks">The tasks to wait on for completion.</param>
<summary>Creates a task that will complete when all of the supplied tasks have completed.</summary>
<returns>A task that represents the completion of all of the supplied tasks.</returns>
Expand Down Expand Up @@ -7178,7 +7178,7 @@ The returned task will complete when any of the supplied tasks has completed. T
</Parameter>
</Parameters>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
<param name="tasks">The tasks to wait on for completion.</param>
<summary>Creates a task that will complete when any of the supplied tasks have completed.</summary>
<returns>A task that represents the completion of one of the supplied tasks. The return Task's Result is the task that completed.</returns>
Expand Down Expand Up @@ -7352,7 +7352,7 @@ The returned task will complete when any of the supplied tasks has completed. T
<Parameter Name="tasks" Type="System.Collections.Generic.IEnumerable&lt;System.Threading.Tasks.Task&gt;" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="tasks">To be added.</param>
<param name="tasks">The task to iterate through when completed.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -7394,7 +7394,7 @@ The returned task will complete when any of the supplied tasks has completed. T
</Parameter>
</Parameters>
<Docs>
<param name="tasks">To be added.</param>
<param name="tasks">The task to iterate through when completed.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -7484,8 +7484,8 @@ The returned task will complete when any of the supplied tasks has completed. T
<Parameter Name="tasks" Type="System.Collections.Generic.IEnumerable&lt;System.Threading.Tasks.Task&lt;TResult&gt;&gt;" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<param name="tasks">To be added.</param>
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
<param name="tasks">The task to iterate through when completed.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -7537,8 +7537,8 @@ The returned task will complete when any of the supplied tasks has completed. T
</Parameter>
</Parameters>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<param name="tasks">To be added.</param>
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
<param name="tasks">The task to iterate through when completed.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -7590,8 +7590,8 @@ The returned task will complete when any of the supplied tasks has completed. T
</Parameter>
</Parameters>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<param name="tasks">To be added.</param>
<typeparam name="TResult">The type of the result returned by the tasks.</typeparam>
<param name="tasks">The task to iterate through when completed.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
Expand Down