From 04bc6042e6aa323c72886840dce61a0c49c8bd13 Mon Sep 17 00:00:00 2001
From: Alexandre Agostinho <alexandre.agostinho@etu.uca.fr>
Date: Fri, 2 Jun 2023 15:05:33 +0200
Subject: [PATCH] finish the unfinished documentation of IUserManager

---
 MCTG/Model/Managers/IUserManager.cs | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/MCTG/Model/Managers/IUserManager.cs b/MCTG/Model/Managers/IUserManager.cs
index c4c7195..9713ed5 100644
--- a/MCTG/Model/Managers/IUserManager.cs
+++ b/MCTG/Model/Managers/IUserManager.cs
@@ -48,13 +48,30 @@ namespace Model
                         string? name = null, string? surname = null, string? profilePict = null);
 
         /// <summary>
-        /// 
+        /// Add an user in the data.
         /// </summary>
-        /// <param name="user"></param>
-        /// <returns></returns>
+        /// <param name="user">The user to add.</param>
+        /// <returns>True is the user was correctly added to the data. False otherwise.</returns>
         bool AddUserToData(User user);
+
+        /// <summary>
+        /// Modify the currently connected user.
+        /// </summary>
+        /// <param name="newUser">An user containing new user's properties to changes.</param>
+        /// <returns></returns>
         bool ModifyCurrentConnected(User newUser);
+
+        /// <summary>
+        /// Log in an user. If the connection succed, pass the connected user to <see cref="CurrentConnected"/>.
+        /// </summary>
+        /// <param name="mail">The User's mail.</param>
+        /// <param name="password">The User's (plain text) password.</param>
+        /// <returns>True if the connection succed, false otherwise.</returns>
         bool LogIn(string mail, string password);
+
+        /// <summary>
+        /// Log out the current connected user.
+        /// </summary>
         void LogOut();
     }
 }