Update XML comments Account controller

qdraw · Jan 25, 2024 · 1fa52fa · 1fa52fa
1 parent 76f21be
commit 1fa52fa
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/starsky/starsky/Controllers/AccountController.cs b/starsky/starsky/Controllers/AccountController.cs
@@ -121,11 +121,11 @@ public IActionResult LoginGet(string? returnUrl = null, bool? fromLogout = null)
         /// </summary>
         /// <param name="model">Email, password and remember me bool</param>
         /// <returns>Login status</returns>
-        /// <response code="200">successful login</response>
-        /// <response code="401">login failed</response>
-        /// <response code="405">ValidateAntiForgeryToken</response>
-        /// <response code="423">login failed due lock</response>
-        /// <response code="500">login failed due signIn errors</response>
+        /// <response code="200">Successful login</response>
+        /// <response code="401">Login failed</response>
+        /// <response code="405">ValidateAntiForgeryToken error</response>
+        /// <response code="423">Login failed due lock</response>
+        /// <response code="500">Login failed due signIn errors</response>
         [HttpPost("/api/account/login")]
         [ProducesResponseType(typeof(string),200)]
         [ProducesResponseType(typeof(string),401)]
@@ -162,8 +162,8 @@ public async Task<IActionResult> LoginPost(LoginViewModel model)
         /// <summary>
         /// Logout the current HttpContext out
         /// </summary>
-        /// <returns></returns>
-        /// <response code="200">successful logout</response>
+        /// <returns>Login Status</returns>
+        /// <response code="200">Successful logout</response>
         [HttpPost("/api/account/logout")]
         [ProducesResponseType(200)]
         [AllowAnonymous]
@@ -178,7 +178,7 @@ public IActionResult LogoutJson()
         /// </summary>
         /// <param name="returnUrl">insert url to redirect</param>
         /// <response code="302">redirect to return url</response>
-        /// <returns></returns>
+        /// <returns>Redirect to login page</returns>
         [HttpGet("/account/logout")]
         [ProducesResponseType(200)]
         [AllowAnonymous]
@@ -193,7 +193,7 @@ public IActionResult Logout(string? returnUrl = null)
         /// Update password for current user
         /// </summary>
         /// <param name="model">Password, ChangedPassword and ChangedConfirmPassword</param>
-        /// <returns>Login status</returns>
+        /// <returns>Change secret status</returns>
         /// <response code="200">successful login</response>
         /// <response code="400">Model is not correct</response>
         /// <response code="401"> please login first or your current password is not correct</response>