Skip to content

Commit

Permalink
docs: generate updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
egil committed Nov 18, 2023
1 parent 7015b60 commit 2e0186d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 27 deletions.
8 changes: 4 additions & 4 deletions docs/System.Threading.TimeProviderPeriodicTimerExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ public static class TimeProviderPeriodicTimerExtensions
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TimeProviderPeriodicTimerExtensions
### Methods

<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisSystem.TimeProvider,System.TimeSpan)'></a>
<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisTimeProvider,System.TimeSpan)'></a>

## TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(this TimeProvider, TimeSpan) Method

Factory method that creates a periodic timer that enables waiting asynchronously for timer ticks.
Use this factory method as a replacement for instantiating a [System.Threading.PeriodicTimer](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.PeriodicTimer 'System.Threading.PeriodicTimer').
```csharp
public static System.Threading.PeriodicTimerWrapper CreatePeriodicTimer(this System.TimeProvider timeProvider, System.TimeSpan period);
public static System.Threading.PeriodicTimerWrapper CreatePeriodicTimer(this TimeProvider timeProvider, System.TimeSpan period);
```
#### Parameters

<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisSystem.TimeProvider,System.TimeSpan).timeProvider'></a>
<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisTimeProvider,System.TimeSpan).timeProvider'></a>

`timeProvider` [System.TimeProvider](https://docs.microsoft.com/en-us/dotnet/api/System.TimeProvider 'System.TimeProvider')
<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisSystem.TimeProvider,System.TimeSpan).period'></a>
<a name='System.Threading.TimeProviderPeriodicTimerExtensions.CreatePeriodicTimer(thisTimeProvider,System.TimeSpan).period'></a>

`period` [System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan')
Expand Down
20 changes: 2 additions & 18 deletions docs/TimeProviderExtensions.ManualTimeProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
Represents a synthetic time provider that can be used to enable deterministic behavior in tests.

```csharp
public class ManualTimeProvider : System.TimeProvider
public class ManualTimeProvider
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [System.TimeProvider](https://docs.microsoft.com/en-us/dotnet/api/System.TimeProvider 'System.TimeProvider') &#129106; ManualTimeProvider
Inheritance [System.TimeProvider](https://docs.microsoft.com/en-us/dotnet/api/System.TimeProvider 'System.TimeProvider') &#129106; ManualTimeProvider
### Remarks
Learn more at <a href="https://github.com/egil/TimeProviderExtensions">TimeProviderExtensions on GitHub</a>.
Expand Down Expand Up @@ -104,22 +104,6 @@ public TimeProviderExtensions.AutoAdvanceBehavior AutoAdvanceBehavior { get; set
#### Property Value
[AutoAdvanceBehavior](TimeProviderExtensions.AutoAdvanceBehavior.md 'TimeProviderExtensions.AutoAdvanceBehavior')

<a name='TimeProviderExtensions.ManualTimeProvider.LocalTimeZone'></a>

## ManualTimeProvider.LocalTimeZone Property

Gets a [System.TimeZoneInfo](https://docs.microsoft.com/en-us/dotnet/api/System.TimeZoneInfo 'System.TimeZoneInfo') object that represents the local time zone according to this [System.TimeProvider](https://docs.microsoft.com/en-us/dotnet/api/System.TimeProvider 'System.TimeProvider')'s notion of time.
```csharp
public override System.TimeZoneInfo LocalTimeZone { get; }
```

#### Property Value
[System.TimeZoneInfo](https://docs.microsoft.com/en-us/dotnet/api/System.TimeZoneInfo 'System.TimeZoneInfo')
### Remarks
The default implementation returns [System.TimeZoneInfo.Local](https://docs.microsoft.com/en-us/dotnet/api/System.TimeZoneInfo.Local 'System.TimeZoneInfo.Local').
<a name='TimeProviderExtensions.ManualTimeProvider.Start'></a>

## ManualTimeProvider.Start Property
Expand Down
7 changes: 2 additions & 5 deletions docs/TimeProviderExtensions.ManualTimer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ A implementation of a [System.Threading.ITimer](https://docs.microsoft.com/en-us

```csharp
public class ManualTimer :
System.Threading.ITimer,
System.IDisposable,
System.IAsyncDisposable
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; ManualTimer
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [System.Threading.ITimer](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.ITimer 'System.Threading.ITimer') &#129106; ManualTimer
Implements [System.Threading.ITimer](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.ITimer 'System.Threading.ITimer'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable'), [System.IAsyncDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IAsyncDisposable 'System.IAsyncDisposable')
Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable'), [System.IAsyncDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IAsyncDisposable 'System.IAsyncDisposable')
### Constructors

<a name='TimeProviderExtensions.ManualTimer.ManualTimer(System.Threading.TimerCallback,object,TimeProviderExtensions.ManualTimeProvider)'></a>
Expand Down Expand Up @@ -153,8 +152,6 @@ Specify [System.Threading.Timeout.InfiniteTimeSpan](https://docs.microsoft.com/e
The time interval between invocations of the callback method specified when the Timer was constructed.
Specify [System.Threading.Timeout.InfiniteTimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Timeout.InfiniteTimeSpan 'System.Threading.Timeout.InfiniteTimeSpan') to disable periodic signaling.
Implements [Change(TimeSpan, TimeSpan)](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.ITimer.Change#System_Threading_ITimer_Change_System_TimeSpan,System_TimeSpan_ 'System.Threading.ITimer.Change(System.TimeSpan,System.TimeSpan)')
#### Returns
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the timer was successfully updated; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool').
Expand Down

0 comments on commit 2e0186d

Please sign in to comment.