Added code comments for:

MachineStudio.DB

2 files changed, 36 insertions, 0 deletions

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/RegisteredView.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/RegisteredView.cs
index fc9051edb..cdd32eaa5 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/RegisteredView.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/RegisteredView.cs
@@ -10,12 +10,25 @@ using Tango.MachineStudio.Common.Controls;
 
 namespace Tango.MachineStudio.DB.Managers
 {
+    /// <summary>
+    /// Represents a registered MDI child (data table) view
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.Controls.MdiChild" />
     public class RegisteredView : MdiChild
     {
         private static Random rnd = new Random();
 
+        /// <summary>
+        /// Adds the view to the display.
+        /// </summary>
         public RelayCommand AddCommand { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RegisteredView"/> class.
+        /// </summary>
+        /// <param name="header">The header.</param>
+        /// <param name="view">The view.</param>
+        /// <param name="action">The action.</param>
         public RegisteredView(String header, FrameworkElement view, Action action)
         {
             Location = new Point(rnd.Next(30, 200), rnd.Next(30, 200));
@@ -44,12 +57,23 @@ namespace Tango.MachineStudio.DB.Managers
             }
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RegisteredView"/> class.
+        /// </summary>
+        /// <param name="header">The header.</param>
+        /// <param name="view">The view.</param>
         public RegisteredView(String header, FrameworkElement view) : this(header, view, null)
         {
             Header = header;
             View = view;
         }
 
+        /// <summary>
+        /// Returns a <see cref="System.String" /> that represents this instance.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="System.String" /> that represents this instance.
+        /// </returns>
         public override string ToString()
         {
             return Header;
diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/ViewsManager.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/ViewsManager.cs
index 2bb5969bc..e136c5983 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/ViewsManager.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.DB/Managers/ViewsManager.cs
@@ -11,12 +11,24 @@ using Tango.MachineStudio.DB.Views.DBViews;
 
 namespace Tango.MachineStudio.DB.Managers
 {
+    /// <summary>
+    /// Represents the data table views manager.
+    /// </summary>
     public static class ViewsManager
     {
+        /// <summary>
+        /// Gets or sets the displayed views.
+        /// </summary>
         public static ObservableCollection<RegisteredView> DisplayedViews { get; set; }
 
+        /// <summary>
+        /// Gets or sets all the views.
+        /// </summary>
         public static ObservableCollection<RegisteredView> DbViews { get; set; }
 
+        /// <summary>
+        /// Initializes the <see cref="ViewsManager"/> class.
+        /// </summary>
         static ViewsManager()
         {
             DisplayedViews = new ObservableCollection<RegisteredView>();