Added code comments for:

MachineStudio.Common.

1 files changed, 69 insertions, 2 deletions

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/INotificationProvider.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/INotificationProvider.cs
index 937a39ec2..30e5626a1 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/INotificationProvider.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/INotificationProvider.cs
@@ -10,34 +10,101 @@ using System.Windows.Media;
 
 namespace Tango.MachineStudio.Common.Notifications
 {
+    /// <summary>
+    /// Represents the Machine Studio user notification provider responsible for displaying information, alerts and dialogs to the user.
+    /// </summary>
     public interface INotificationProvider
     {
+        /// <summary>
+        /// Gets the collection of active task items.
+        /// </summary>
         ObservableCollection<TaskItem> TaskItems { get; }
 
+        /// <summary>
+        /// Gets the current displayed task item.
+        /// </summary>
         TaskItem CurrentTaskItem { get; }
 
+        /// <summary>
+        /// Gets a value indicating whether there are any queued task items.
+        /// </summary>
         bool HasTaskItems { get; }
 
+        /// <summary>
+        /// Pushes the specified task item to the queue.
+        /// </summary>
+        /// <param name="taskItem">The task item.</param>
         void PushTaskItem(TaskItem taskItem);
 
+        /// <summary>
+        /// Create and push a new task item from the specified message.
+        /// </summary>
+        /// <param name="message">The message.</param>
+        /// <returns></returns>
         TaskItem PushTaskItem(String message);
 
+        /// <summary>
+        /// Removed the specified task item from the queue.
+        /// </summary>
+        /// <param name="taskItem">The task item.</param>
         void PopTaskItem(TaskItem taskItem);
 
+        /// <summary>
+        /// Creates a new instance of the specified View type and displays it as a modal dialog.
+        /// </summary>
+        /// <typeparam name="View">The type of the view.</typeparam>
+        /// <typeparam name="VM">The type of the view model.</typeparam>
+        /// <param name="onAccept">Accept button callback.</param>
+        /// <param name="onCancel">Cancel button callback.</param>
         void ShowModalDialog<View, VM>(Action<VM> onAccept, Action onCancel) where View : FrameworkElement where VM : DialogViewVM;
 
+        /// <summary>
+        /// Creates a new view by a naming convention of the specified view model type.
+        /// </summary>
+        /// <typeparam name="VM">The type of the view model.</typeparam>
+        /// <param name="onAccept">Accept button callback.</param>
+        /// <param name="onCancel">Cancel button callback.</param>
         void ShowModalDialog<VM>(Action<VM> onAccept, Action onCancel) where VM : DialogViewVM;
 
+        /// <summary>
+        /// Creates a new view by a naming convention of the specified view model type.
+        /// </summary>
+        /// <typeparam name="VM">The type of the view model.</typeparam>
+        /// <param name="onAccept">Accept button callback.</param>
         void ShowModalDialog<VM>(Action<VM> onAccept) where VM : DialogViewVM;
 
-        bool? ShowDialog(PackIconKind icon, Brush iconColor, String message, bool hasCancel);
+        /// <summary>
+        /// Display a message box.
+        /// </summary>
+        /// <param name="icon">The icon.</param>
+        /// <param name="iconColor">Color of the icon.</param>
+        /// <param name="message">The message.</param>
+        /// <param name="hasCancel">if set to <c>true</c> displays the cancel button.</param>
+        /// <returns></returns>
+        bool? ShowMessageBox(PackIconKind icon, Brush iconColor, String message, bool hasCancel);
 
+        /// <summary>
+        /// Shows an information message box.
+        /// </summary>
+        /// <param name="message">The message.</param>
         void ShowInfo(String message);
 
-        void ShowWarnning(String message);
+        /// <summary>
+        /// Shows warning message box.
+        /// </summary>
+        /// <param name="message">The message.</param>
+        void ShowWarning(String message);
 
+        /// <summary>
+        /// Shows an error message box.
+        /// </summary>
+        /// <param name="message">The message.</param>
         void ShowError(String message);
 
+        /// <summary>
+        /// Shows a question message box.
+        /// </summary>
+        /// <param name="message">The message.</param>
         bool ShowQuestion(String message);
     }
 }