From 0bd3760bec105a00efa0fe624da2eb82d85d06c9 Mon Sep 17 00:00:00 2001
From: Roy Ben-Shabat <Roy@Twine-s.com>
Date: Sun, 14 Jan 2018 16:16:08 +0200
Subject: Added code comments for: MachineStudio.DB

---
 .../Modules/Tango.MachineStudio.DB/DBModule.cs     | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/DBModule.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/DBModule.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/DBModule.cs
index 0928d2a1f..4f751d9da 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/DBModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/DBModule.cs
@@ -11,27 +11,59 @@ using Tango.MachineStudio.DB.Views;
 
 namespace Tango.MachineStudio.DB
 {
+    /// <summary>
+    /// Represents a Machine Studio database module.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
     public class DBModule : IStudioModule
     {
+        /// <summary>
+        /// The is initialized
+        /// </summary>
         private bool _isInitialized;
 
+        /// <summary>
+        /// Gets the module name.
+        /// </summary>
         public string Name => "Data Base";
 
+        /// <summary>
+        /// Gets the module description.
+        /// </summary>
         public string Description => "Provides access to raw database tables.";
 
+        /// <summary>
+        /// Gets the module cover image.
+        /// </summary>
         public BitmapSource Image => SharedUI.Helpers.ResourceHelper.GetImageFromResources("Images/db.png");
 
+        /// <summary>
+        /// Gets the module entry point view.
+        /// </summary>
         public FrameworkElement MainView => new MainDBView();
 
+        /// <summary>
+        /// Gets a value indicating whether this module has been initialized.
+        /// </summary>
         public bool IsInitialized => _isInitialized;
 
+        /// <summary>
+        /// Gets the permission required to see and load this module.
+        /// </summary>
         public Permissions Permission => Permissions.RunDataBaseModule;
 
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        /// <exception cref="NotImplementedException"></exception>
         public void Dispose()
         {
             throw new NotImplementedException();
         }
 
+        /// <summary>
+        /// Perform any operations required to initialize this module.
+        /// </summary>
         public void Initialize()
         {
             if (!_isInitialized)
-- 
cgit v1.3.1