Skip to content

Commit

Permalink
Fix Thread.cs comment (#181)
Browse files Browse the repository at this point in the history
Fix warning for Thread.Sleep
  • Loading branch information
networkfusion authored Mar 13, 2022
1 parent 3591a0e commit 72b8248
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion nanoFramework.CoreLibrary/System/Threading/Thread.cs
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public static void Sleep(TimeSpan timeout)
/// <param name="iterations">A 32-bit signed integer that defines how long a thread is to wait.</param>
/// <remarks>
/// The <see cref="SpinWait"/> method is useful for implementing locks. Classes in the .NET Framework, such as <see cref="Monitor"/> use this method internally. <see cref="SpinWait"/> essentially puts the processor into a very tight loop, with the loop count specified by the <paramref name="iterations"/> parameter. The duration of the wait therefore depends on the speed of the processor.
/// Contrast this with the <see cref="Sleep"/> method. A thread that calls <see cref="Sleep"/> yields the rest of its current slice of processor time, even if the specified interval is zero. Specifying a non-zero interval for <see cref="Sleep"/> removes the thread from consideration by the thread scheduler until the time interval has elapsed.
/// Contrast this with the <see cref="Sleep(int)"/> method. A thread that calls <see cref="Sleep(int)"/> yields the rest of its current slice of processor time, even if the specified interval is zero. Specifying a non-zero interval for <see cref="Sleep(int)"/> removes the thread from consideration by the thread scheduler until the time interval has elapsed.
/// </remarks>
[MethodImpl(MethodImplOptions.InternalCall)]
public static extern void SpinWait(int iterations);
Expand Down

0 comments on commit 72b8248

Please sign in to comment.