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.

---
 .../StudioApplication/IShutdownRequestBlocker.cs   |  8 ++++++++
 .../StudioApplication/IStudioApplicationManager.cs | 22 ++++++++++++++++++++++
 2 files changed, 30 insertions(+)

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

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IShutdownRequestBlocker.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IShutdownRequestBlocker.cs
index a157bd598..4d5f968a4 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IShutdownRequestBlocker.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IShutdownRequestBlocker.cs
@@ -6,8 +6,16 @@ using System.Threading.Tasks;
 
 namespace Tango.MachineStudio.Common.StudioApplication
 {
+    /// <summary>
+    /// Represents a component capable of receiving notification for when the Machine Studio shuts down.
+    /// The component can perform it's own shutdown operations, or cancel the current shutdown operation.
+    /// </summary>
     public interface IShutdownRequestBlocker
     {
+        /// <summary>
+        /// Called when the application is shutting down.
+        /// </summary>
+        /// <returns></returns>
         Task<bool> OnShutdownRequest();
     }
 }
diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IStudioApplicationManager.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IStudioApplicationManager.cs
index 42f4f7b65..dfdac67c7 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IStudioApplicationManager.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioApplication/IStudioApplicationManager.cs
@@ -7,12 +7,34 @@ using Tango.Integration.Services;
 
 namespace Tango.MachineStudio.Common.StudioApplication
 {
+    /// <summary>
+    /// Represents the Machine Studio application manager.
+    /// </summary>
     public interface IStudioApplicationManager
     {
+        /// <summary>
+        /// Gets a value indicating whether Machine Studio is shutting down.
+        /// </summary>
         bool IsShuttingDown { get;}
+
+        /// <summary>
+        /// Shutdown the application.
+        /// </summary>
         void ShutDown();
+
+        /// <summary>
+        /// Gets or sets the currently connected machine if any.
+        /// </summary>
         IExternalBridgeClient ConnectedMachine { get; set; }
+
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="ConnectedMachine"/> is valid.
+        /// </summary>
         bool IsMachineConnected { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="ConnectedMachine"/> is valid and connected through TCP/IP.
+        /// </summary>
         bool IsMachineConnectedViaTCP { get;  }
     }
 }
-- 
cgit v1.3.1