updated XML docs

bgmulinari · Dec 2, 2024 · 5317c8d · 5317c8d
1 parent afa3f68
commit 5317c8d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/B1SLayer/B1SLayer.xml b/B1SLayer/B1SLayer.xml
diff --git a/B1SLayer/SLConnection.cs b/B1SLayer/SLConnection.cs
@@ -347,16 +347,18 @@ private IFlurlClient BuildFlurlClient()
     #region Session Management Methods
 
     /// <summary>
-    /// If the current session is expired or non-existent, performs a POST Login request with the provided information.
-    /// Manually performing the Login is often unnecessary because it will be performed automatically anyway whenever needed.
+    /// Performs a POST Login request with the provided information, regardless of the current session state.
     /// </summary>
+    /// <remarks>
+    /// Manually performing the Login is often unnecessary because it will be performed automatically anyway whenever needed.
+    /// </remarks>
     public async Task<SLLoginResponse> LoginAsync() => await ExecuteLoginAsync(true);
 
     /// <summary>
     /// Performs the POST Login request to the Service Layer.
     /// </summary>
     /// <param name="expectReturn">
-    /// Wheter the login information should be returned.
+    /// Whether the login information should be returned.
     /// </param>
     private async Task<SLLoginResponse> ExecuteLoginAsync(bool expectReturn = false)
     {