Skip to content

Commit 6098ddd

Browse files
committed
📔 Fix XML documentation
1 parent ea9c60b commit 6098ddd

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

src/OpenOnlineConfig/OpenOnlineConfig/OpenOnlineConfig.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
<RepositoryUrl>https://github.com/Shadowsocks-NET/OpenOnlineConfig.NET</RepositoryUrl>
1313
<RepositoryType>Public</RepositoryType>
1414
<PackageTags>open-online-config;censorship-circumvention</PackageTags>
15+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
16+
<NoWarn>CS1591</NoWarn>
1517
</PropertyGroup>
1618

1719
<ItemGroup>

src/OpenOnlineConfig/OpenOnlineConfig/v1/OOCv1ApiClient{T}.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ namespace OpenOnlineConfig.v1
1212
/// <typeparam name="T">OOCv1 config type for specific protocols.</typeparam>
1313
public class OOCv1ApiClient<T> : OOCv1ApiClient where T : OOCv1ConfigBase
1414
{
15+
/// <summary>
16+
/// Creates an OOCv1 API client with config type <typeparamref name="T"/> for the API endpoint.
17+
/// The supplied HttpClient is used only when the API doesn't use a self-signed certificate.
18+
/// </summary>
19+
/// <param name="apiToken">API token of the designated API endpoint.</param>
20+
/// <param name="httpClient">Supply an existing HttpClient instance.</param>
1521
public OOCv1ApiClient(OOCv1ApiToken apiToken, HttpClient? httpClient = null) : base(apiToken, httpClient) { }
1622

1723
/// <summary>
18-
/// Retrieves the online config and deserializes the response JSON as <see cref="T"/> in an asynchronous operation.
24+
/// Retrieves the online config and deserializes the response JSON as <typeparamref name="T"/> in an asynchronous operation.
1925
/// </summary>
2026
/// <param name="cancellationToken">The cancellation token to cancel the operation.</param>
2127
/// <returns>The task object representing the asynchronous operation.</returns>

0 commit comments

Comments
 (0)