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

---
 .../ViewModels/LoginViewVM.cs                      | 25 ++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/LoginViewVM.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/LoginViewVM.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/LoginViewVM.cs
index 6fe90fa99..c5936eea8 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/LoginViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/LoginViewVM.cs
@@ -16,6 +16,10 @@ using Tango.SharedUI;
 
 namespace Tango.MachineStudio.UI.ViewModels
 {
+    /// <summary>
+    /// Represents the Machine Studio login view, view model.
+    /// </summary>
+    /// <seealso cref="Tango.SharedUI.ViewModel" />
     public class LoginViewVM : ViewModel
     {
         private IAuthenticationProvider _authenticationProvider;
@@ -24,6 +28,9 @@ namespace Tango.MachineStudio.UI.ViewModels
         private Rfc2898Cryptographer cryptographer;
 
         private String _email;
+        /// <summary>
+        /// Gets or sets the email.
+        /// </summary>
         [Required(ErrorMessage = "Email is required")]
         [EmailAddress(ErrorMessage = "Please enter a valid email")]
         public String Email
@@ -33,16 +40,26 @@ namespace Tango.MachineStudio.UI.ViewModels
         }
 
         private bool _rememberMe;
-
+        /// <summary>
+        /// Gets or sets a value indicating whether to remember the last user email and password.
+        /// </summary>
         public bool RememberMe
         {
             get { return _rememberMe; }
             set { _rememberMe = value; RaisePropertyChangedAuto(); }
         }
 
-
+        /// <summary>
+        /// Gets or sets the login command.
+        /// </summary>
         public RelayCommand<String> LoginCommand { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LoginViewVM"/> class.
+        /// </summary>
+        /// <param name="authenticationProvider">The authentication provider.</param>
+        /// <param name="navigationManager">The navigation manager.</param>
+        /// <param name="notificationProvider">The notification provider.</param>
         public LoginViewVM(IAuthenticationProvider authenticationProvider, INavigationManager navigationManager, INotificationProvider notificationProvider)
         {
             _notificationProvider = notificationProvider;
@@ -55,6 +72,10 @@ namespace Tango.MachineStudio.UI.ViewModels
             RememberMe = SettingsManager.Default.MachineStudio.RememberMe;
         }
 
+        /// <summary>
+        /// Logins the requested user.
+        /// </summary>
+        /// <param name="password">The password.</param>
         private void Login(String password)
         {
             if (Validate())
-- 
cgit v1.3.1