From a20fd4bd769aeccd1fd1f20273f895c92a5b5bb8 Mon Sep 17 00:00:00 2001
From: Roy Ben-Shabat <Roy@Twine-s.com>
Date: Sun, 14 Jan 2018 15:24:49 +0200
Subject: Added code comments for: MachineStudio.Common.

---
 .../Authentication/IAuthenticationProvider.cs          | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Authentication')

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Authentication/IAuthenticationProvider.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Authentication/IAuthenticationProvider.cs
index 488a2f6dc..e2d4072ba 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Authentication/IAuthenticationProvider.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Authentication/IAuthenticationProvider.cs
@@ -7,14 +7,32 @@ using Tango.DAL.Observables;
 
 namespace Tango.MachineStudio.Common.Authentication
 {
+    /// <summary>
+    /// Represents the Machine Studio user authentication provider responsible for the current logged-in user.
+    /// </summary>
     public interface IAuthenticationProvider
     {
+        /// <summary>
+        /// Occurs when the current logged-in user has changed.
+        /// </summary>
         event EventHandler<User> CurrentUserChanged;
 
+        /// <summary>
+        /// Gets the current logged-in user.
+        /// </summary>
         User CurrentUser { get; }
 
+        /// <summary>
+        /// Performs a user login by the specified email and password.
+        /// </summary>
+        /// <param name="email">The email.</param>
+        /// <param name="password">The password.</param>
+        /// <returns></returns>
         User Login(String email, String password);
 
+        /// <summary>
+        /// Logs-out the current logged-in user.
+        /// </summary>
         void Logout();
     }
 }
-- 
cgit v1.3.1