diff ServerMonitor/Forms/CheckBoxDialog.cs @ 9:7127d5b5ac75

Code cleanup and comments
author Brad Greco <brad@bgreco.net>
date Mon, 08 Apr 2019 21:29:54 -0400
parents 3e1a2131f897
children
line wrap: on
line diff
--- a/ServerMonitor/Forms/CheckBoxDialog.cs	Sat Mar 09 20:14:03 2019 -0500
+++ b/ServerMonitor/Forms/CheckBoxDialog.cs	Mon Apr 08 21:29:54 2019 -0400
@@ -1,18 +1,16 @@
 using System;
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Data;
 using System.Drawing;
-using System.Linq;
-using System.Text;
 using System.Windows.Forms;
 
 namespace ServerMonitorApp
 {
+    /// <summary>Message dialog with an additional checkbox.</summary>
     public partial class CheckBoxDialog : Form
     {
+        /// <summary>Message to show.</summary>
         public string Message { get; set; }
 
+        /// <summary>Check state of the checkbox.</summary>
         public bool Checked { get; private set; }
 
         public CheckBoxDialog()
@@ -26,6 +24,7 @@
             MessageLabel.Text = Message;
         }
 
+        /// <summary>Updates the public property with the checked state so it can be read by the dialog owner.</summary>
         private void PromptCheckBox_CheckedChanged(object sender, EventArgs e)
         {
             Checked = PromptCheckBox.Checked;