Mark VcKanji and VcHangul as obsolete

Author: TolikPylypchuk

SharpHook/Data/KeyCode.cs

@@ -644,10 +644,12 @@ public enum KeyCode : ushort
 
     /// <summary>IME Kanji mode</summary>
     /// <remarks>Available on: Windows</remarks>
+    [Obsolete("VcHanja should be used instead")]
     VcKanji = 0x0019,
 
     /// <summary>IME Hangul mode</summary>
     /// <remarks>Available on: Windows, Linux</remarks>
+    [Obsolete("VcKana should be used instead")]
     VcHangul = 0x00E9,
 
     /// <summary>IME Junja mode</summary>

SharpHook/Data/MouseWheelEventData.cs

@@ -44,13 +44,13 @@ public struct MouseWheelEventData : IEquatable<MouseWheelEventData>
     /// <value>The wheel delta.</value>
     /// <remarks>
     /// <para>
-    /// On Windows this value is equal to the <c>WHEEL_DELTA</c> constant (<c>120</c>).
+    /// On Windows, this value is equal to the <c>WHEEL_DELTA</c> constant (<c>120</c>).
     /// </para>
     /// <para>
-    /// On macOS this value is the number of pixels per line.
+    /// On macOS, this value is the number of pixels per line.
     /// </para>
     /// <para>
-    /// On Linux this value is always equal to <c>100</c>.
+    /// On Linux, this value is always equal to <c>100</c>.
     /// </para>
     /// </remarks>
     public ushort Delta;

SharpHook/EventSimulator.cs

@@ -43,7 +43,7 @@ public EventSimulator(IEventSimulationProvider? simulationProvider) =>
     /// The default delay is 50 milliseconds.
     /// </para>
     /// <para>
-    /// On Windows and macOS this property is ignored.
+    /// On Windows and macOS, this property is ignored.
     /// </para>
     /// </remarks>
     /// <exception cref="ArgumentOutOfRangeException">
@@ -98,7 +98,7 @@ public UioHookResult SimulateKeyRelease(KeyCode keyCode) =>
     /// surrogate pairs, e.g. emojis) is supported.
     /// </para>
     /// <para>
-    /// On Windows text simulation should work correctly and consistently.
+    /// On Windows, text simulation should work correctly and consistently.
     /// </para>
     /// <para>
     /// On macOS applications are not required to process text simulation, but most of them should handle it correctly.
@@ -247,7 +247,7 @@ public UioHookResult SimulateMouseMovementRelative(short x, short y) =>
     /// <returns>The result of the operation.</returns>
     /// <remarks>
     /// <para>
-    /// On Windows the value <c>120</c> represents the default wheel step. As such, multiples of <c>120</c> can be used,
+    /// On Windows, the value <c>120</c> represents the default wheel step. As such, multiples of <c>120</c> can be used,
     /// but it's not required. The value of <paramref name="type" /> is ignored.
     /// </para>
     /// <para>

SharpHook/IEventSimulator.cs

@@ -23,7 +23,7 @@ public interface IEventSimulator
     /// The default delay is 50 milliseconds.
     /// </para>
     /// <para>
-    /// On Windows and macOS this property is ignored.
+    /// On Windows and macOS, this property is ignored.
     /// </para>
     /// </remarks>
     /// <exception cref="ArgumentOutOfRangeException">
@@ -56,10 +56,10 @@ public interface IEventSimulator
     /// surrogate pairs, e.g. emojis) is supported.
     /// </para>
     /// <para>
-    /// On Windows text simulation should work correctly and consistently.
+    /// On Windows, text simulation should work correctly and consistently.
     /// </para>
     /// <para>
-    /// On macOS applications are not required to process text simulation, but most of them should handle it correctly.
+    /// On macOS, applications are not required to process text simulation, but most of them should handle it correctly.
     /// </para>
     /// <para>
     /// X11 doesn't support text simulation directly. Instead, for each character, an unused key code is remapped to
@@ -170,16 +170,16 @@ public interface IEventSimulator
     /// <returns>The result of the operation.</returns>
     /// <remarks>
     /// <para>
-    /// On Windows the value <c>120</c> represents the default wheel step. As such, multiples of <c>120</c> can be used,
+    /// On Windows, the value <c>120</c> represents the default wheel step. As such, multiples of <c>120</c> can be used,
     /// but it's not required. The value of <paramref name="type" /> is ignored.
     /// </para>
     /// <para>
-    /// On macOS it's recommended to use values between <c>-10</c> and <c>10</c>. This will result in quite a small
+    /// On macOS, it's recommended to use values between <c>-10</c> and <c>10</c>. This will result in quite a small
     /// scroll amount with pixel scrolling, so <see cref="MouseWheelScrollType.BlockScroll" /> is recommended for line
     /// scrolling instead of pixel scrolling.
     /// </para>
     /// <para>
-    /// On Linux there is no fixed recommendation, but multiples of <c>100</c> can be used. The value of
+    /// On Linux, there is no fixed recommendation, but multiples of <c>100</c> can be used. The value of
     /// <paramref name="type" /> is ignored.
     /// </para>
     /// </remarks>

SharpHook/Logging/LogEntryParser.cs

@@ -8,7 +8,7 @@ namespace SharpHook.Logging;
 /// </summary>
 /// <remarks>
 /// The log text is formatted using the <c>vsprintf</c> function from the C runtime and then the result is parsed to
-/// extract the arguments. This means that on Windows this class requires the Visual C++ Redistributable package to be
+/// extract the arguments. This means that on Windows, this class requires the Visual C++ Redistributable package to be
 /// installed.
 /// </remarks>
 [ExcludeFromCodeCoverage]

SharpHook/SharpHook.xml

@@ -201,13 +201,13 @@ Mouse wheel simulation is a little more complex than other events.
 A positive `MouseWheelEventData.Rotation` value indicates scrolling up or left, and a negative value indicates scrolling
 down or right.
 
-On Windows the value 120 represents the default wheel step. As such, multiples of 120 can be used as the
+On Windows, the value 120 represents the default wheel step. As such, multiples of 120 can be used as the
 rotation value, but it's not required. The value of `MouseWheelEventData.Type` is ignored.
 
-On macOS it's recommended to use values between -10 and 10. This will result in quite a small scroll amount with pixel
+On macOS, it's recommended to use values between -10 and 10. This will result in quite a small scroll amount with pixel
 scrolling, so `MouseWheelScrollType.BlockScroll` is recommended for line scrolling instead of pixel scrolling.
 
-On Linux there is no fixed recommendation, but multiples of 100 can be used. The value of `MouseWheelEventData.Type`
+On Linux, there is no fixed recommendation, but multiples of 100 can be used. The value of `MouseWheelEventData.Type`
 is ignored.
 
 ## Simulating Text Entry
@@ -224,7 +224,7 @@ slowly and is not guaranteed to be correct.
 `UioHook` contains the `SetPostTextDelayX11` method which can be used to increase (or decrease) the delay if needed -
 longer delays add consistency but may be more jarring to end users. `UioHook` also contains the `GetPostTextDelayX11`
 which can be used to get the currently configured delay – the default is 50 milliseconds. Delays are configurable on a
-nanosecond level. On Windows and macOS `SetPostTextDelayX11` does nothing, and `GetPostTextDelayX11` always returns 0.
+nanosecond level. On Windows and macOS, `SetPostTextDelayX11` does nothing, and `GetPostTextDelayX11` always returns 0.
 `IEventSimulator` contains the `TextSimulationDelayOnX11` property which is wrapper arount the aforementioned methods.
 
 The methods described above are also defined in the `SharpHook.Providers.IEventSimulationProvider` interface.