Skip to content

Commit 904bca2

Browse files
committed
xml commenting
1 parent eacb922 commit 904bca2

3 files changed

Lines changed: 32 additions & 0 deletions

File tree

src/Soenneker.Blazor.WebWorkers/Enums/WebWorkerBackend.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ namespace Soenneker.Blazor.WebWorkers.Enums;
55
/// </summary>
66
public enum WebWorkerBackend
77
{
8+
/// <summary>
9+
/// Represents the java script value.
10+
/// </summary>
811
JavaScript,
12+
/// <summary>
13+
/// Represents the dot net value.
14+
/// </summary>
915
DotNet
1016
}

src/Soenneker.Blazor.WebWorkers/Enums/WebWorkerJobState.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,20 @@ namespace Soenneker.Blazor.WebWorkers.Enums;
88
[JsonConverter(typeof(JsonStringEnumConverter))]
99
public enum WebWorkerJobState
1010
{
11+
/// <summary>
12+
/// Represents the running value.
13+
/// </summary>
1114
Running,
15+
/// <summary>
16+
/// Represents the completed value.
17+
/// </summary>
1218
Completed,
19+
/// <summary>
20+
/// Represents the cancelled value.
21+
/// </summary>
1322
Cancelled,
23+
/// <summary>
24+
/// Represents the faulted value.
25+
/// </summary>
1426
Faulted
1527
}

src/Soenneker.Blazor.WebWorkers/WebWorkersInterop.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,11 @@ public async ValueTask<WebWorkerCoordinatorSnapshot> GetCoordinatorSnapshot(WebW
304304
}
305305
}
306306

307+
/// <summary>
308+
/// Executes the handle coordinator event operation.
309+
/// </summary>
310+
/// <param name="eventJson">The event json.</param>
311+
/// <returns>A task that represents the asynchronous operation.</returns>
307312
[JSInvokable]
308313
public async Task HandleCoordinatorEvent(string eventJson)
309314
{
@@ -338,6 +343,11 @@ public async Task HandleCoordinatorEvent(string eventJson)
338343
}
339344
}
340345

346+
/// <summary>
347+
/// Executes the handle dot net coordinator event operation.
348+
/// </summary>
349+
/// <param name="eventJson">The event json.</param>
350+
/// <returns>A task that represents the asynchronous operation.</returns>
341351
[JSInvokable]
342352
public async Task HandleDotNetCoordinatorEvent(string eventJson)
343353
{
@@ -369,6 +379,10 @@ public async Task HandleDotNetCoordinatorEvent(string eventJson)
369379
}
370380
}
371381

382+
/// <summary>
383+
/// Asynchronously releases resources used by the current instance.
384+
/// </summary>
385+
/// <returns>A task that represents the asynchronous operation.</returns>
372386
public async ValueTask DisposeAsync()
373387
{
374388
if (_disposed)

0 commit comments

Comments
 (0)