Skip to content

Commit 09bb0c0

Browse files
authored
[WebAuthn] Fix documentation formatting
1 parent 530ecef commit 09bb0c0

File tree

3 files changed

+21
-19
lines changed

3 files changed

+21
-19
lines changed

src/Tizen.Security.WebAuthn/Tizen.Security.WebAuthn/GetAssertionCallbacks.cs

+10-9
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,18 @@ public class GetAssertionCallbacks
4242
/// If the request does not need to display a QR code
4343
/// then this callback function won't be invoked.
4444
/// </param>
45-
/// <param name="responseCallback">Callback function for getting the final response.
45+
/// <param name="responseCallback">
46+
/// Callback function for getting the final response.
4647
/// Invoked when the response for the GetAssertion request need to be returned.
4748
/// The result of the GetAssertion request may be one of the following:
4849
/// * <see cref="WauthnError.None"/> if the request is completed well,
4950
/// * <see cref="WauthnError.Canceled"/> if the request is cancelled by a Cancel() request.
5051
/// * <see cref="WauthnError.InvalidState"/> if the server entered invalid state. Known causes:
51-
/// * - proxy issues,
52-
/// * - reached the limit of credentials stored by the authenticator.
52+
/// - proxy issues,
53+
/// - reached the limit of credentials stored by the authenticator.
5354
/// * <see cref="WauthnError.TimedOut"/> if the request times out. Known causes:
54-
/// * - authenticator does not respond during state assisted transactions due to
55-
/// * lack of push notifications support (e.g. missing Google Account).
55+
/// - authenticator does not respond during state assisted transactions due to
56+
/// lack of push notifications support (e.g. missing Google Account).
5657
/// </param>
5758
/// <param name="linkedDataCallback">
5859
/// Callback function for getting the updated linked device data. May be called multiple times.
@@ -61,11 +62,11 @@ public class GetAssertionCallbacks
6162
/// * <see cref="WauthnError.None"/> if the request is completed well,
6263
/// * <see cref="WauthnError.Canceled"/> if the request is cancelled by a Cancel() request.
6364
/// * <see cref="WauthnError.InvalidState"/> if the server entered invalid state. Known causes:
64-
/// * - proxy issues,
65-
/// * - reached the limit of credentials stored by the authenticator.
65+
/// - proxy issues,
66+
/// - reached the limit of credentials stored by the authenticator.
6667
/// * <see cref="WauthnError.TimedOut"/> if the request times out. Known causes:
67-
/// * - authenticator does not respond during state assisted transactions due to
68-
/// * lack of push notifications support (e.g. missing Google Account).
68+
/// - authenticator does not respond during state assisted transactions due to
69+
/// lack of push notifications support (e.g. missing Google Account).
6970
/// </param>
7071
/// <param name="userData">User data to be passed to <see cref="QrcodeCallback"/>, <see cref="ResponseCallback"/> and <see cref="LinkedDataCallback"/>.</param>
7172
public GetAssertionCallbacks(

src/Tizen.Security.WebAuthn/Tizen.Security.WebAuthn/MakeCredentialCallbacks.cs

+10-9
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,18 @@ public class MakeCredentialCallbacks
4242
/// If the request does not need to display a QR code
4343
/// then this callback function won't be invoked.
4444
/// </param>
45-
/// <param name="responseCallback">Callback function for getting the final response.
45+
/// <param name="responseCallback">
46+
/// Callback function for getting the final response.
4647
/// Invoked when the response for the <see cref="Authenticator.MakeCredential"/> request
4748
/// needs to be returned. The result of this request may be one of the following:
4849
/// * <see cref="WauthnError.None"/> if the request is completed well,
4950
/// * <see cref="WauthnError.Canceled"/> if the request is cancelled by a Cancel() request.
5051
/// * <see cref="WauthnError.InvalidState"/> if the server entered invalid state. Known causes:
51-
/// * - proxy issues,
52-
/// * - reached the limit of credentials stored by the authenticator.
52+
/// - proxy issues,
53+
/// - reached the limit of credentials stored by the authenticator.
5354
/// * <see cref="WauthnError.TimedOut"/> if the request times out. Known causes:
54-
/// * - authenticator does not respond during state assisted transactions due to
55-
/// * lack of push notifications support (e.g. missing Google Account).
55+
/// - authenticator does not respond during state assisted transactions due to
56+
/// lack of push notifications support (e.g. missing Google Account).
5657
/// </param>
5758
/// <param name="linkedDataCallback">
5859
/// Callback function for getting the updated linked device data. May be called multiple times.
@@ -61,11 +62,11 @@ public class MakeCredentialCallbacks
6162
/// * <see cref="WauthnError.None"/> if the request is completed well,
6263
/// * <see cref="WauthnError.Canceled"/> if the request is cancelled by a Cancel() request.
6364
/// * <see cref="WauthnError.InvalidState"/> if the server entered invalid state. Known causes:
64-
/// * - proxy issues,
65-
/// * - reached the limit of credentials stored by the authenticator.
65+
/// - proxy issues,
66+
/// - reached the limit of credentials stored by the authenticator.
6667
/// * <see cref="WauthnError.TimedOut"/> if the request times out. Known causes:
67-
/// * - authenticator does not respond during state assisted transactions due to
68-
/// * lack of push notifications support (e.g. missing Google Account).
68+
/// - authenticator does not respond during state assisted transactions due to
69+
/// lack of push notifications support (e.g. missing Google Account).
6970
/// </param>
7071
/// <param name="userData">User data to be passed to <see cref="QrcodeCallback"/>, <see cref="ResponseCallback"/> and <see cref="LinkedDataCallback"/>.</param>
7172
public MakeCredentialCallbacks(

src/Tizen.Security.WebAuthn/doc/api/Tizen.Security.WebAuthn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ remarks: *content
77
---
88
## Overview
99
It provides an [Authenticator](xref:Tizen.Security.WebAuthn.Authenticator) class containing methods for creating public key-based credentials
10-
([Authenticator.MakeCredential()](xref:Tizen.Security.WebAuthn.Authenticator.MakeCredential(Tizen.Security.WebAuthn.ClientData,Tizen.Security.WebAuthn.PubkeyCredCreationOptions,Tizen.Security.WebAuthn.McCallbacks))) and using them ([Authenticator.GetAssertion()](xref:Tizen.Security.WebAuthn.Authenticator.GetAssertion(Tizen.Security.WebAuthn.ClientData,Tizen.Security.WebAuthn.PubkeyCredRequestOptions,Tizen.Security.WebAuthn.GaCallbacks))). Both these operations are performed asynchronously. Callbacks passed as arguments are used to notify about the progress
10+
([Authenticator.MakeCredential()](xref:Tizen.Security.WebAuthn.Authenticator.MakeCredential(Tizen.Security.WebAuthn.ClientData,Tizen.Security.WebAuthn.PubkeyCredCreationOptions,Tizen.Security.WebAuthn.MakeCredentialCallbacks))) and using them ([Authenticator.GetAssertion()](xref:Tizen.Security.WebAuthn.Authenticator.GetAssertion(Tizen.Security.WebAuthn.ClientData,Tizen.Security.WebAuthn.PubkeyCredRequestOptions,Tizen.Security.WebAuthn.GetAssertionCallbacks))). Both these operations are performed asynchronously. Callbacks passed as arguments are used to notify about the progress
1111
or when user's interaction is necessary. Due to significant amount of time required to complete both
1212
requests, cancelation is also possible with the help of Authenticator.Cancel(). The module also
1313
provides a variety of data types based on W3C Web Authentication API (https://www.w3.org/TR/webauthn-3/)

0 commit comments

Comments
 (0)