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.

---
 .../Tango.MachineStudio.Common/IStudioModule.cs    | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)

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

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
index 902a45a2f..21377fb5f 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
@@ -9,20 +9,45 @@ using Tango.DAL.Observables;
 
 namespace Tango.MachineStudio.Common
 {
+    /// <summary>
+    /// Represents a Machine Studio module.
+    /// </summary>
+    /// <seealso cref="System.IDisposable" />
     public interface IStudioModule : IDisposable
     {
+        /// <summary>
+        /// Gets the module name.
+        /// </summary>
         String Name { get; }
 
+        /// <summary>
+        /// Gets the module description.
+        /// </summary>
         String Description { get; }
 
+        /// <summary>
+        /// Gets the module cover image.
+        /// </summary>
         BitmapSource Image { get; }
 
+        /// <summary>
+        /// Gets the module entry point view.
+        /// </summary>
         FrameworkElement MainView { get; }
 
+        /// <summary>
+        /// Gets the permission required to see and load this module.
+        /// </summary>
         Permissions Permission { get; }
 
+        /// <summary>
+        /// Gets a value indicating whether this module has been initialized.
+        /// </summary>
         bool IsInitialized { get; }
 
+        /// <summary>
+        /// Perform any operations required to initialize this module.
+        /// </summary>
         void Initialize();
     }
 }
-- 
cgit v1.3.1