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

---
 .../Modules/DefaultStudioModuleLoader.cs           | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

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

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/Modules/DefaultStudioModuleLoader.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/Modules/DefaultStudioModuleLoader.cs
index 473e66d38..5944af2d1 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/Modules/DefaultStudioModuleLoader.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.UI/Modules/DefaultStudioModuleLoader.cs
@@ -16,11 +16,20 @@ using Tango.MachineStudio.Stubs;
 
 namespace Tango.MachineStudio.UI.Modules
 {
+    /// <summary>
+    /// Represents the Machine Studio default <see cref="IStudioModuleLoader">module loader</see>.
+    /// </summary>
+    /// <seealso cref="Tango.Core.ExtendedObject" />
+    /// <seealso cref="Tango.MachineStudio.Common.Modules.IStudioModuleLoader" />
     public class DefaultStudioModuleLoader : ExtendedObject, IStudioModuleLoader
     {
         private IAuthenticationProvider _authenticationProvider;
         private bool _loaded;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DefaultStudioModuleLoader"/> class.
+        /// </summary>
+        /// <param name="authenticationProvider">The authentication provider.</param>
         public DefaultStudioModuleLoader(IAuthenticationProvider authenticationProvider)
         {
             _authenticationProvider = authenticationProvider;
@@ -29,12 +38,20 @@ namespace Tango.MachineStudio.UI.Modules
             _authenticationProvider.CurrentUserChanged += _authenticationProvider_CurrentUserChanged;
         }
 
+        /// <summary>
+        /// Handles the authentication provider user changed event.
+        /// </summary>
+        /// <param name="sender">The sender.</param>
+        /// <param name="e">The e.</param>
         private void _authenticationProvider_CurrentUserChanged(object sender, DAL.Observables.User e)
         {
             LoadModules();
         }
 
         private ObservableCollection<IStudioModule> _allModules;
+        /// <summary>
+        /// Gets all loaded modules.
+        /// </summary>
         public ObservableCollection<IStudioModule> AllModules
         {
             get { return _allModules; }
@@ -42,12 +59,18 @@ namespace Tango.MachineStudio.UI.Modules
         }
 
         private ObservableCollection<IStudioModule> _userModules;
+        /// <summary>
+        /// Gets all the user permitted modules.
+        /// </summary>
         public ObservableCollection<IStudioModule> UserModules
         {
             get { return _userModules; }
             private set { _userModules = value; RaisePropertyChangedAuto(); }
         }
 
+        /// <summary>
+        /// Loads all available Machine Studio modules.
+        /// </summary>
         public void LoadModules()
         {
             if (!_loaded)
-- 
cgit v1.3.1