Update XML doc comment in backend projects

This commit is contained in:
Aaron Po
2026-08-18 16:28:25 -04:00
parent 6a53167cb8
commit 693f74bb5b
53 changed files with 287 additions and 83 deletions

View File

@@ -22,6 +22,7 @@ public class EmailDispatcher(
Environment.GetEnvironmentVariable("WEBSITE_BASE_URL")
?? throw new InvalidOperationException("WEBSITE_BASE_URL environment variable is not set");
/// <inheritdoc />
public async Task SendRegistrationEmailAsync(
string firstName,
string email,
@@ -38,6 +39,7 @@ public class EmailDispatcher(
await emailProvider.SendAsync(email, "Welcome to The Biergarten App!", emailHtml, true);
}
/// <inheritdoc />
public async Task SendResendConfirmationEmailAsync(
string firstName,
string email,

View File

@@ -8,10 +8,14 @@ public interface IEmailDispatcher
/// <summary>
/// Sends a welcome email containing an account confirmation link to a newly registered user.
/// </summary>
/// <remarks>The email is sent synchronously; the returned task completes once delivery to the mail server succeeds or fails.</remarks>
/// <param name="confirmationToken">Embedded in the confirmation link sent to <paramref name="email" />.</param>
Task SendRegistrationEmailAsync(string firstName, string email, string confirmationToken);
/// <summary>
/// Sends an email containing a fresh account confirmation link to a user who requested a resend.
/// </summary>
/// <remarks>The email is sent synchronously; the returned task completes once delivery to the mail server succeeds or fails.</remarks>
/// <param name="confirmationToken">Embedded in the confirmation link sent to <paramref name="email" />.</param>
Task SendResendConfirmationEmailAsync(string firstName, string email, string confirmationToken);
}