Skip to content

Commit 0b2626f

Browse files
peteraritchieRon Petrusha
authored andcommitted
Added details to public static bool QueueUserWorkItem<TState> (Action… (#1993)
* Added details to public static bool QueueUserWorkItem<TState> (Action<TState> callBack, TState state, bool preferLocal) * fixed error * fix errors * fix errors * Apply suggestions from code review Co-Authored-By: peteraritchie <[email protected]>
1 parent f5aec13 commit 0b2626f

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

xml/System.Threading/ThreadPool.xml

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -591,13 +591,14 @@
591591
<Parameter Name="preferLocal" Type="System.Boolean" />
592592
</Parameters>
593593
<Docs>
594-
<typeparam name="TState">To be added.</typeparam>
595-
<param name="callBack">To be added.</param>
596-
<param name="state">To be added.</param>
597-
<param name="preferLocal">To be added.</param>
598-
<summary>To be added.</summary>
599-
<returns>To be added.</returns>
600-
<remarks>To be added.</remarks>
594+
<typeparam name="TState">The type of elements of <paramref name="state" />.</typeparam>
595+
<param name="callBack">An <see cref="T:System.Action`1" /> representing the method to execute.</param>
596+
<param name="state">An object containing data to be used by the method.</param>
597+
<param name="preferLocal">Unlike other QueueUserWorkItem methods, prefer exeucting in the local thread pool and not the global thread pool.</param>
598+
<summary>Queues a method specified by an <see cref="T:System.Action`1" /> delegate for execution, and provides data to be used by the method. The method executes when a thread pool thread becomes available.</summary>
599+
<returns>
600+
<see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.
601+
</returns>
601602
</Docs>
602603
</Member>
603604
<MemberGroup MemberName="RegisterWaitForSingleObject">
@@ -1267,13 +1268,13 @@
12671268
<Parameter Name="preferLocal" Type="System.Boolean" Index="2" FrameworkAlternate="netcore-3.0" />
12681269
</Parameters>
12691270
<Docs>
1270-
<typeparam name="TState">To be added.</typeparam>
1271-
<param name="callBack">To be added.</param>
1272-
<param name="state">To be added.</param>
1273-
<param name="preferLocal">To be added.</param>
1274-
<summary>To be added.</summary>
1275-
<returns>To be added.</returns>
1276-
<remarks>To be added.</remarks>
1271+
<typeparam name="TState">The type of elements of <paramref name="state" />.</typeparam>
1272+
<param name="callBack">A delegate representing the method to execute.</param>
1273+
<param name="state">An object containing data to be used by the method.</param>
1274+
<param name="preferLocal">`true` to execute in the local threadpool; `false` to execute in the global thread pool.</param>
1275+
<summary>Queues a method specified by an <see cref="T:System.Action`1" /> delegate for execution, and specifies an object containing data to be used by the method. The method executes when a thread pool thread becomes available.</summary>
1276+
<returns>
1277+
<see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.</returns>
12771278
</Docs>
12781279
</Member>
12791280
<MemberGroup MemberName="UnsafeRegisterWaitForSingleObject">
@@ -1566,4 +1567,4 @@
15661567
</Docs>
15671568
</Member>
15681569
</Members>
1569-
</Type>
1570+
</Type>

0 commit comments

Comments
 (0)