diff ServerMonitor/Win32Helpers.cs @ 17:68d7834dc28e

More comments.
author Brad Greco <brad@bgreco.net>
date Sat, 25 May 2019 15:14:26 -0400
parents 052aa62cb42a
children 7645122aa7a9
line wrap: on
line diff
--- a/ServerMonitor/Win32Helpers.cs	Tue Apr 30 20:40:58 2019 -0400
+++ b/ServerMonitor/Win32Helpers.cs	Sat May 25 15:14:26 2019 -0400
@@ -1,13 +1,10 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Runtime.InteropServices;
-using System.Text;
-using System.Threading.Tasks;
 using System.Windows.Forms;
 
 namespace ServerMonitorApp
 {
+    /// <summary>Methods for interacting with the Win32 API.</summary>
     class Win32Helpers
     {
         [DllImport("user32.dll")]
@@ -65,6 +62,8 @@
             FLASHW_TIMERNOFG = 12
         }
 
+        /// <summary>Flashes a window icon in the taskbar.</summary>
+        /// <param name="form">The form to flash.</param>
         public static bool FlashWindowEx(Form form)
         {
             IntPtr hWnd = form.Handle;
@@ -79,6 +78,8 @@
             return FlashWindowEx(ref fInfo);
         }
 
+        /// <summary>Stops flashing a window icon in the taskbar.</summary>
+        /// <param name="form">The form to stop flashing.</param>
         public static bool StopFlashWindowEx(Form form)
         {
             IntPtr hWnd = form.Handle;