add xmldoc comments

This commit is contained in:
Aaron Po
2026-06-18 23:25:50 -04:00
parent 6a66619c70
commit 254b2afb9f
52 changed files with 1681 additions and 7 deletions

View File

@@ -5,12 +5,28 @@ using Service.Emails;
namespace Service.Auth;
/// <summary>
/// Handles confirmation of newly registered user accounts and resending of confirmation emails.
/// </summary>
/// <param name="authRepository">Repository used to look up and confirm user accounts.</param>
/// <param name="tokenService">Service used to generate and validate confirmation tokens.</param>
/// <param name="emailService">Service used to send confirmation-related emails.</param>
public class ConfirmationService(
IAuthRepository authRepository,
ITokenService tokenService,
IEmailService emailService
) : IConfirmationService
{
/// <summary>
/// Validates a confirmation token and marks the corresponding user account as confirmed.
/// </summary>
/// <param name="confirmationToken">The confirmation token issued to the user, typically delivered via email.</param>
/// <returns>
/// A <see cref="ConfirmationServiceReturn"/> containing the UTC timestamp of confirmation and the confirmed user's ID.
/// </returns>
/// <exception cref="Domain.Exceptions.UnauthorizedException">
/// Thrown when the confirmation token is invalid or expired, or when the associated user account cannot be found.
/// </exception>
public async Task<ConfirmationServiceReturn> ConfirmUserAsync(
string confirmationToken
)
@@ -34,6 +50,15 @@ public class ConfirmationService(
);
}
/// <summary>
/// Resends the account confirmation email to a user, generating a fresh confirmation token.
/// </summary>
/// <param name="userId">The unique identifier of the user requesting the resend.</param>
/// <returns>A task that completes once the operation has finished.</returns>
/// <remarks>
/// Returns silently without sending an email if the user does not exist (to prevent user enumeration)
/// or if the user's account is already verified.
/// </remarks>
public async Task ResendConfirmationEmailAsync(Guid userId)
{
var user = await authRepository.GetUserByIdAsync(userId);