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

@@ -5,13 +5,15 @@ namespace Infrastructure.Email.Templates.Rendering;
/// </summary>
public interface IEmailTemplateProvider
{
/// <summary>
/// Renders the UserRegisteredEmail template.
/// </summary>
/// <summary>Renders the registration confirmation email template.</summary>
/// <param name="username">The recipient's username, shown in the greeting.</param>
/// <param name="confirmationLink">The URL the recipient follows to confirm their account.</param>
/// <returns>A task whose result is the rendered HTML for the email body.</returns>
Task<string> RenderUserRegisteredEmailAsync(string username, string confirmationLink);
/// <summary>
/// Renders the ResendConfirmation template.
/// </summary>
/// <summary>Renders the resend-confirmation email template.</summary>
/// <param name="username">The recipient's username, shown in the greeting.</param>
/// <param name="confirmationLink">The URL the recipient follows to confirm their account.</param>
/// <returns>A task whose result is the rendered HTML for the email body.</returns>
Task<string> RenderResendConfirmationEmailAsync(string username, string confirmationLink);
}