Skip to content
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

Jump to bottom

Fix FakeTimeProvider docs #5227

Merged
merged 1 commit into from
Jun 17, 2024
Merged

Fix FakeTimeProvider docs #5227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/Libraries/Microsoft.Extensions.TimeProvider.Testing/FakeTimeProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public FakeTimeProvider(DateTimeOffset startDateTime)
/// <remarks>
/// This defaults to <see cref="TimeSpan.Zero"/>.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">if the time value is set to less than <see cref="TimeSpan.Zero"/>.</exception>
/// <exception cref="ArgumentOutOfRangeException">The time value is less than <see cref="TimeSpan.Zero"/>.</exception>
public TimeSpan AutoAdvanceAmount
{
get => _autoAdvanceAmount;
Expand Down Expand Up @@ -91,11 +91,11 @@ public override DateTimeOffset GetUtcNow()
/// Advances the date and time in the UTC time zone.
/// </summary>
/// <param name="value">The date and time in the UTC time zone.</param>
/// <exception cref="ArgumentOutOfRangeException">if the supplied time value is before the current time.</exception>
/// <exception cref="ArgumentOutOfRangeException">The supplied time value is before the current time.</exception>
/// <remarks>
/// This method simply advances time. If the time is set forward beyond the
/// trigger point of any outstanding timers, those timers will immediately trigger.
/// This is unlike the <see cref="AdjustTime" /> method below, which has no impact
/// This is unlike the <see cref="AdjustTime" /> method, which has no impact
/// on timers.
/// </remarks>
public void SetUtcNow(DateTimeOffset value)
Expand Down Expand Up @@ -123,7 +123,7 @@ public void SetUtcNow(DateTimeOffset value)
/// marches forward automatically in hardware, for the fake time provider the application is responsible for
/// doing this explicitly by calling this method.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">if the time value is less than <see cref="TimeSpan.Zero"/>.</exception>
/// <exception cref="ArgumentOutOfRangeException">The time value is less than <see cref="TimeSpan.Zero"/>.</exception>
public void Advance(TimeSpan delta)
{
_ = Throw.IfLessThan(delta.Ticks, 0);
Expand Down