Skip to content
This repository was archived by the owner on Apr 21, 2021. It is now read-only.

Commit f5b0822

Browse files
committed
comments
1 parent fbbe1ac commit f5b0822

7 files changed

+33
-24
lines changed

EventHook/ApplicationWatcher.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace EventHook
99
{
1010
/// <summary>
11-
/// An enum for the type of application event
11+
/// An enum for the type of application event.
1212
/// </summary>
1313
public enum ApplicationEvents
1414
{
@@ -18,7 +18,7 @@ public enum ApplicationEvents
1818
}
1919

2020
/// <summary>
21-
/// An object that holds information on application event
21+
/// An object that holds information on application event.
2222
/// </summary>
2323
public class WindowData
2424
{
@@ -31,7 +31,7 @@ public class WindowData
3131
}
3232

3333
/// <summary>
34-
/// An event argument object send to user
34+
/// An event argument object send to user.
3535
/// </summary>
3636
public class ApplicationEventArgs : EventArgs
3737
{
@@ -40,9 +40,9 @@ public class ApplicationEventArgs : EventArgs
4040
}
4141

4242
/// <summary>
43-
/// A wrapper around shell hook to hook application window change events
43+
/// A wrapper around shell hook to hook application window change events.
4444
/// Uses a producer-consumer pattern to improve performance and to avoid operating system forcing unhook on delayed
45-
/// user callbacks
45+
/// user callbacks.
4646
/// </summary>
4747
public class ApplicationWatcher
4848
{

EventHook/ClipboardWatcher.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace EventHook
99
{
1010
/// <summary>
11-
/// Type of clipboard content
11+
/// Type of clipboard content.
1212
/// </summary>
1313
public enum ClipboardContentTypes
1414
{
@@ -20,7 +20,7 @@ public enum ClipboardContentTypes
2020
}
2121

2222
/// <summary>
23-
/// An argument send to user
23+
/// An argument send to user.
2424
/// </summary>
2525
public class ClipboardEventArgs : EventArgs
2626
{
@@ -29,9 +29,9 @@ public class ClipboardEventArgs : EventArgs
2929
}
3030

3131
/// <summary>
32-
/// Wraps around clipboardHook
32+
/// Wraps around clipboardHook.
3333
/// Uses a producer-consumer pattern to improve performance and to avoid operating system forcing unhook on delayed
34-
/// user callbacks
34+
/// user callbacks.
3535
/// </summary>
3636
public class ClipboardWatcher
3737
{

EventHook/Hooks/MouseHook.cs

+9-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ namespace EventHook.Hooks
1010
internal class RawMouseEventArgs : EventArgs
1111
{
1212
internal MouseMessages Message { get; set; }
13-
internal POINT Point { get; set; }
13+
internal Point Point { get; set; }
1414
}
1515

16+
/// <summary>
17+
/// The mouse messages.
18+
/// </summary>
1619
public enum MouseMessages
1720
{
1821
WM_LBUTTONDOWN = 0x0201,
@@ -25,8 +28,11 @@ public enum MouseMessages
2528
WM_WHEELBUTTONUP = 0x208
2629
}
2730

31+
/// <summary>
32+
/// The point co-ordinate.
33+
/// </summary>
2834
[StructLayout(LayoutKind.Sequential)]
29-
public struct POINT
35+
public struct Point
3036
{
3137
public readonly int x;
3238
public readonly int y;
@@ -35,7 +41,7 @@ public struct POINT
3541
[StructLayout(LayoutKind.Sequential)]
3642
internal struct MSLLHOOKSTRUCT
3743
{
38-
internal POINT pt;
44+
internal Point pt;
3945
internal readonly uint mouseData;
4046
internal readonly uint flags;
4147
internal readonly uint time;

EventHook/Hooks/WindowHookEx.cs

+3
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,9 @@ delegate void WinEventProc(IntPtr hookHandle, WindowEvent @event,
177177
#endregion
178178
}
179179

180+
/// <summary>
181+
/// The window event arguments.
182+
/// </summary>
180183
public class WindowEventArgs
181184
{
182185
public WindowEventArgs(IntPtr handle) {

EventHook/KeyboardWatcher.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
namespace EventHook
88
{
99
/// <summary>
10-
/// Key press data
10+
/// Key press data.
1111
/// </summary>
1212
public class KeyInputEventArgs : EventArgs
1313
{
1414
public KeyData KeyData { get; set; }
1515
}
1616

1717
/// <summary>
18-
/// Key data
18+
/// Key data.
1919
/// </summary>
2020
public class KeyData
2121
{
@@ -25,7 +25,7 @@ public class KeyData
2525
}
2626

2727
/// <summary>
28-
/// Key press event type
28+
/// Key press event type.
2929
/// </summary>
3030
public enum KeyEvent
3131
{
@@ -34,9 +34,9 @@ public enum KeyEvent
3434
}
3535

3636
/// <summary>
37-
/// Wraps low level keyboard hook
37+
/// Wraps low level keyboard hook.
3838
/// Uses a producer-consumer pattern to improve performance and to avoid operating system forcing unhook on delayed
39-
/// user callbacks
39+
/// user callbacks.
4040
/// </summary>
4141
public class KeyboardWatcher
4242
{

EventHook/MouseWatcher.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@
77
namespace EventHook
88
{
99
/// <summary>
10-
/// Event argument to pass data through user callbacks
10+
/// Event argument to pass data through user callbacks.
1111
/// </summary>
1212
public class MouseEventArgs : EventArgs
1313
{
1414
public MouseMessages Message { get; set; }
15-
public POINT Point { get; set; }
15+
public Point Point { get; set; }
1616
}
1717

1818
/// <summary>
19-
/// Wraps low level mouse hook
19+
/// Wraps low level mouse hook.
2020
/// Uses a producer-consumer pattern to improve performance and to avoid operating system forcing unhook on delayed
21-
/// user callbacks
21+
/// user callbacks.
2222
/// </summary>
2323
public class MouseWatcher
2424
{

EventHook/PrintWatcher.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace EventHook
1111
{
1212
/// <summary>
13-
/// An object holding key information on a particular print event
13+
/// An object holding key information on a particular print event.
1414
/// </summary>
1515
public class PrintEventData
1616
{
@@ -22,15 +22,15 @@ public class PrintEventData
2222
}
2323

2424
/// <summary>
25-
/// An argument passed along user call backs
25+
/// An argument passed along user call backs.
2626
/// </summary>
2727
public class PrintEventArgs : EventArgs
2828
{
2929
public PrintEventData EventData { get; set; }
3030
}
3131

3232
/// <summary>
33-
/// A class that wraps around printServer object
33+
/// A class that wraps around printServer object.
3434
/// </summary>
3535
public class PrintWatcher
3636
{

0 commit comments

Comments
 (0)