Update XML doc comment in backend projects

web/backend/Features/Features.Emails/DependencyInjection/FeaturesEmailsServiceCollectionExtensions.cs

@@ -5,8 +5,15 @@ using Microsoft.Extensions.DependencyInjection;
 
 namespace Features.Emails.DependencyInjection;
 
+/// <summary>
+///     Registers the services used by the Features.Emails slice.
+/// </summary>
 public static class FeaturesEmailsServiceCollectionExtensions
 {
+    /// <summary>
+    ///     Registers the SMTP email provider, template renderer, and <see cref="IEmailDispatcher" />.
+    /// </summary>
+    /// <returns>The same <paramref name="services" /> instance, for chaining.</returns>
     public static IServiceCollection AddFeaturesEmails(this IServiceCollection services)
     {
         services.AddScoped<IEmailProvider, SmtpEmailProvider>();

web/backend/Features/Features.Emails/Services/EmailDispatcher.cs

@@ -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,

web/backend/Features/Features.Emails/Services/IEmailDispatcher.cs

@@ -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);
 }