Skip to content

Commit 32f75fe

Browse files
jgscherbermairaw
authored andcommitted
Change description of 'state' object passed to ProgressUpdate (#3090)
* Change description of 'state' object passed to ProgressUpdate Match description of the parameter to the description of the property on the event generated from the function call. * fixed bad crefs
1 parent b26df6f commit 32f75fe

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

xml/System.ComponentModel/BackgroundWorker.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@
750750
</Parameters>
751751
<Docs>
752752
<param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
753-
<param name="userState">The state object passed to <see cref="M:System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object)" />.</param>
753+
<param name="userState">A unique <see cref="T:System.Object"/> indicating the user state. Returned as the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.UserState" /> property of the <see cref="T:System.ComponentModel.ProgressChangedEventArgs" />.</param>
754754
<summary>Raises the <see cref="E:System.ComponentModel.BackgroundWorker.ProgressChanged" /> event.</summary>
755755
<remarks>
756756
<format type="text/markdown"><![CDATA[

0 commit comments

Comments
 (0)