Skip to content

Commit 377f28e

Browse files
committed
xml commenting
1 parent b1e949c commit 377f28e

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

src/Soenneker.GitHub.ClientUtil/Abstract/IGitHubOpenApiClientUtil.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,10 @@ namespace Soenneker.GitHub.ClientUtil.Abstract;
1010
/// </summary>
1111
public interface IGitHubOpenApiClientUtil : IDisposable, IAsyncDisposable
1212
{
13+
/// <summary>
14+
/// Gets the value.
15+
/// </summary>
16+
/// <param name="cancellationToken">The cancellation token.</param>
17+
/// <returns>A task containing the result of the operation.</returns>
1318
ValueTask<GitHubOpenApiClient> Get(CancellationToken cancellationToken = default);
1419
}

src/Soenneker.GitHub.ClientUtil/GitHubOpenApiClientUtil.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,18 @@ public ValueTask<GitHubOpenApiClient> Get(CancellationToken cancellationToken =
4343
return _client.Get(cancellationToken);
4444
}
4545

46+
/// <summary>
47+
/// Releases resources used by the current instance.
48+
/// </summary>
4649
public void Dispose()
4750
{
4851
_client.Dispose();
4952
}
5053

54+
/// <summary>
55+
/// Asynchronously releases resources used by the current instance.
56+
/// </summary>
57+
/// <returns>A task that represents the asynchronous operation.</returns>
5158
public ValueTask DisposeAsync()
5259
{
5360
return _client.DisposeAsync();

0 commit comments

Comments
 (0)