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

---
 .../DefaultStudioApplicationManager.cs             | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/StudioApplication')

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/StudioApplication/DefaultStudioApplicationManager.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/StudioApplication/DefaultStudioApplicationManager.cs
index 36b5074cb..68af7bdc3 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/StudioApplication/DefaultStudioApplicationManager.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/StudioApplication/DefaultStudioApplicationManager.cs
@@ -17,19 +17,40 @@ using Tango.Logging;
 
 namespace Tango.MachineStudio.UI.StudioApplication
 {
+    /// <summary>
+    /// Represents the default Machine Studio <see cref="IStudioApplicationManager">Application Manager</see>.
+    /// </summary>
+    /// <seealso cref="Tango.Core.ExtendedObject" />
+    /// <seealso cref="Tango.MachineStudio.Common.StudioApplication.IStudioApplicationManager" />
     public class DefaultStudioApplicationManager : ExtendedObject, IStudioApplicationManager
     {
+        /// <summary>
+        /// The navigation manager
+        /// </summary>
         private INavigationManager _navigationManager;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DefaultStudioApplicationManager" /> class.
+        /// </summary>
+        /// <param name="navigationManager">The navigation manager.</param>
         public DefaultStudioApplicationManager(INavigationManager navigationManager)
         {
             _navigationManager = navigationManager;
         }
 
+        /// <summary>
+        /// Gets a value indicating whether Machine Studio is shutting down.
+        /// </summary>
         public bool IsShuttingDown { get; private set; }
 
+        /// <summary>
+        /// The connected machine
+        /// </summary>
         private IExternalBridgeClient _connectedMachine;
 
+        /// <summary>
+        /// Gets or sets the currently connected machine if any.
+        /// </summary>
         public IExternalBridgeClient ConnectedMachine
         {
             get { return _connectedMachine; }
@@ -48,11 +69,19 @@ namespace Tango.MachineStudio.UI.StudioApplication
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="P:Tango.MachineStudio.Common.StudioApplication.IStudioApplicationManager.ConnectedMachine" /> is valid and connected through TCP/IP.
+        /// </summary>
         public bool IsMachineConnectedViaTCP
         {
             get { return IsMachineConnected && ConnectedMachine is ExternalBridgeTcpClient; }
         }
 
+        /// <summary>
+        /// Handles the <see cref="ConnectedMachine"/> state changed event.
+        /// </summary>
+        /// <param name="sender">The sender.</param>
+        /// <param name="e">The e.</param>
         private void ConnectedMachine_StateChanged(object sender, Transport.TransportComponentState e)
         {
             if (e == Transport.TransportComponentState.Disconnected || e == Transport.TransportComponentState.Failed)
@@ -62,11 +91,17 @@ namespace Tango.MachineStudio.UI.StudioApplication
 
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="P:Tango.MachineStudio.Common.StudioApplication.IStudioApplicationManager.ConnectedMachine" /> is valid.
+        /// </summary>
         public bool IsMachineConnected
         {
             get { return ConnectedMachine != null; }
         }
 
+        /// <summary>
+        /// Shutdown the application.
+        /// </summary>
         public async void ShutDown()
         {
             if (IsShuttingDown) return;
-- 
cgit v1.3.1