Revize a35cb648

Added comments to backend

Backend/Core/Services/UserService/IUserService.cs

@@ -11 +11 @@
 {
     public interface IUserService
     {
+        /// <summary>
+        /// Creates a new user
+        /// </summary>
+        /// <param name="username"></param>
+        /// <param name="name"></param>
+        /// <param name="surname"></param>
+        /// <param name="password"></param>
+        /// <param name="role"></param>
+        /// <returns></returns>
         public User? CreateUser(string username, string name, string surname, string password, ERole role);
+        /// <summary>
+        /// Returns a user with the specified username or null if no such user exists
+        /// </summary>
+        /// <param name="username"></param>
+        /// <returns></returns>
         public User? GetUserByUsername(string username);
+        /// <summary>
+        /// Returns a user with the specified Id or null if no such user exists
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         public User? GetUserById(Guid id);
+        /// <summary>
+        /// Updates information about the user
+        /// Pass null as a parameter if you dont want to update it
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="username"></param>
+        /// <param name="name"></param>
+        /// <param name="surname"></param>
+        /// <param name="role"></param>
+        /// <returns></returns>
         public User UpdateUser(User user, string? username = null, string? name = null, string? surname = null, ERole? role = null);
+        /// <summary>
+        /// Updates information about the user
+        /// Pass null as a parameter if you dont want to update it
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="username"></param>
+        /// <param name="name"></param>
+        /// <param name="surname"></param>
+        /// <param name="role"></param>
+        /// <returns></returns>
         public User? UpdateUser(Guid userId, string? username = null, string? name = null, string? surname = null, ERole? role = null);
+        /// <summary>
+        /// Sets a new password
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="newPassword"></param>
+        /// <returns></returns>
         public User ChangePassword(User user, string newPassword);
+        /// <summary>
+        /// Sets a new password
+        /// </summary>
+        /// <param name="user"></param>
+        /// <param name="newPassword"></param>
+        /// <returns></returns>
         public User? ChangePassword(Guid userId, string newPassword);
+        /// <summary>
+        /// Check if the user with this username has this password
+        /// </summary>
+        /// <param name="username"></param>
+        /// <param name="password"></param>
+        /// <returns></returns>
         public User? CheckUsernamePassword(string username, string password);
+        /// <summary>
+        /// Returns list of all users
+        /// </summary>
+        /// <returns></returns>
         public UserList GetUsers();
+        /// <summary>
+        /// Deletes a user
+        /// </summary>
+        /// <param name="userId"></param>
         public void DeleteUser(Guid userId);
     }
 }