Merge pull request #552 from SCCapstone/383

383: Comment /Helpers in API
SCCapstone · Apr 21, 2024 · f2c8f2e · f2c8f2e
2 parents 7c6fe9c + 337c310
commit f2c8f2e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/FU.API/FU.API/Helpers/AuthHelper.cs b/FU.API/FU.API/Helpers/AuthHelper.cs
@@ -6,6 +6,10 @@
 using System.Security.Claims;
 using System.Text;
 
+/// <summary>
+/// Helper class for creating authentication tokens.
+/// Used when a user logs in or sending account verification emails.
+/// </summary>
 public static class AuthHelper
 {
     public static AuthenticationInfo CreateAuthInfo(IConfiguration configuration, DateTime expires, int userId)

diff --git a/FU.API/FU.API/Helpers/Mapper.cs b/FU.API/FU.API/Helpers/Mapper.cs
@@ -10,6 +10,11 @@ namespace FU.API.Helpers;
 using FU.API.DTOs.User;
 using FU.API.DTOs;
 
+/// <summary>
+/// A static class that contains extension methods for mapping between DTOs and models.
+/// Used to keep the controllers clean.
+/// Simple mapping, and no complex logic.
+/// </summary>
 public static class Mapper
 {
     public static UserProfile ToProfile(this ApplicationUser appUser, Message? lastChatMessage = null)