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/MachineConnectionViewVM.cs          | 26 +++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

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

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/MachineConnectionViewVM.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/MachineConnectionViewVM.cs
index b8b888e86..23be8d274 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/MachineConnectionViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/ViewModels/MachineConnectionViewVM.cs
@@ -10,10 +10,16 @@ using Tango.SharedUI;
 
 namespace Tango.MachineStudio.UI.ViewModels
 {
+    /// <summary>
+    /// Represents the Machine Studio connection dialog, view model.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.Notifications.DialogViewVM" />
     public class MachineConnectionViewVM : DialogViewVM
     {
         private ExternalBridgeScanner _scanner;
-
+        /// <summary>
+        /// Gets or sets the machine scanner.
+        /// </summary>
         public ExternalBridgeScanner Scanner
         {
             get { return _scanner; }
@@ -21,15 +27,24 @@ namespace Tango.MachineStudio.UI.ViewModels
         }
 
         private IExternalBridgeClient _selectedMachine;
-
+        /// <summary>
+        /// Gets or sets the selected machine.
+        /// </summary>
         public IExternalBridgeClient SelectedMachine
         {
             get { return _selectedMachine; }
             set { _selectedMachine = value; RaisePropertyChangedAuto(); InvalidateRelayCommands(); }
         }
 
+        /// <summary>
+        /// Gets or sets the connect command.
+        /// </summary>
         public RelayCommand ConnectCommand { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MachineConnectionViewVM"/> class.
+        /// </summary>
+        /// <param name="scanner">The scanner.</param>
         public MachineConnectionViewVM(ExternalBridgeScanner scanner)
         {
             Scanner = scanner;
@@ -37,6 +52,9 @@ namespace Tango.MachineStudio.UI.ViewModels
             Scanner.Start();
         }
 
+        /// <summary>
+        /// Connect to the currently selected machine.
+        /// </summary>
         private void Connect()
         {
             if (SelectedMachine != null)
@@ -45,10 +63,12 @@ namespace Tango.MachineStudio.UI.ViewModels
             }
         }
 
+        /// <summary>
+        /// Called when the dialog has been shown.
+        /// </summary>
         public override void OnShow()
         {
             base.OnShow();
-
             Scanner.AvailableMachines.Clear();
         }
     }
-- 
cgit v1.3.1