From 06407c97a181f7bfd976b8890d859bb12f4450ad Mon Sep 17 00:00:00 2001
From: CrackThrough <crackthrough@gmail.com>
Date: Sun, 6 Nov 2022 22:16:34 +0900
Subject: [PATCH] fix: add missing docs for public/internal members

---
 Runtime/Event.cs            | 10 ++++++++--
 Runtime/SkyHookException.cs | 15 +++++++++++----
 Runtime/SkyHookManager.cs   | 11 ++++++++++-
 Runtime/SkyHookNative.cs    | 33 ++++++++++++++++++++++++---------
 4 files changed, 53 insertions(+), 16 deletions(-)

diff --git a/Runtime/Event.cs b/Runtime/Event.cs
index 3b6900c..1b02741 100644
--- a/Runtime/Event.cs
+++ b/Runtime/Event.cs
@@ -3,16 +3,19 @@ using System.Runtime.InteropServices;
 
 namespace SkyHook
 {
+  /// <summary>
+  /// Recorded key updates from SkyHook.
+  /// </summary>
   [StructLayout(LayoutKind.Sequential)]
   [SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
   public struct SkyHookEvent
   {
     /// <summary>
-    /// When the key was pressed.
+    /// When the key's state was updated.
     /// </summary>
     public readonly ulong Time;
     /// <summary>
-    /// The key is pressed or released.
+    /// Whether the key is pressed or released.
     /// </summary>
     public readonly EventType Type;
     /// <summary>
@@ -25,6 +28,9 @@ namespace SkyHook
     public readonly ushort Key;
   }
 
+  /// <summary>
+  /// The type of <see cref="SkyHookEvent"/>'s event.
+  /// </summary>
   public enum EventType
   {
     KeyPressed,
diff --git a/Runtime/SkyHookException.cs b/Runtime/SkyHookException.cs
index ba95428..bd1a685 100644
--- a/Runtime/SkyHookException.cs
+++ b/Runtime/SkyHookException.cs
@@ -2,8 +2,15 @@ using System;
 
 namespace SkyHook
 {
-  public class SkyHookException : Exception
-  {
-    public SkyHookException(string message) : base(message) { }
-  }
+    /// <summary>
+    /// An <see cref="Exception"/> that specifically occurred in SkyHook.
+    /// </summary>
+    public class SkyHookException : Exception
+    {
+	    /// <summary>
+	    /// Initializes an instance of <see cref="SkyHookException"/>.
+	    /// </summary>
+	    /// <param name="message">A message to pass along with exception.</param>
+		public SkyHookException(string message) : base(message) { }
+    }
 }
\ No newline at end of file
diff --git a/Runtime/SkyHookManager.cs b/Runtime/SkyHookManager.cs
index 732462e..9b0f1b0 100644
--- a/Runtime/SkyHookManager.cs
+++ b/Runtime/SkyHookManager.cs
@@ -1,15 +1,21 @@
 using System;
 using System.Threading;
-using System.Threading.Tasks;
 using UnityEngine;
 using UnityEngine.Events;
 
 namespace SkyHook
 {
+    /// <summary>
+    /// Manages SkyHook activity.
+    /// A "<see cref="GameObject.DontDestroyOnLoad"/>ed" instance will be created automatically upon use.
+    /// </summary>
     public class SkyHookManager : MonoBehaviour
     {
         private static SkyHookManager _instance;
 
+        /// <summary>
+        /// Whether this process is focused.
+        /// </summary>
         public static bool IsFocused;
 
         /// <summary>
@@ -20,6 +26,9 @@ namespace SkyHook
         // ReSharper disable once FieldCanBeMadeReadOnly.Global
         public bool requireFocus = true;
 
+        /// <summary>
+        /// Whether the hook is active now.
+        /// </summary>
         public bool isHookActive;
 
         /// <summary>
diff --git a/Runtime/SkyHookNative.cs b/Runtime/SkyHookNative.cs
index 347571b..0937e33 100644
--- a/Runtime/SkyHookNative.cs
+++ b/Runtime/SkyHookNative.cs
@@ -2,16 +2,31 @@ using System.Runtime.InteropServices;
 
 namespace SkyHook
 {
-  internal static class SkyHookNative
-  {
-    public delegate void Callback(SkyHookEvent ev);
+    /// <summary>
+    /// Native method calls for SkyHook.
+    /// </summary>
+    internal static class SkyHookNative
+    {
+        /// <summary>
+        /// The native callback handled by <see cref="SkyHookManager"/>.
+        /// </summary>
+        public delegate void Callback(SkyHookEvent ev);
 
-    private const string Lib = "skyhook";
+        private const string Lib = "skyhook";
 
-    [DllImport(Lib, EntryPoint = "start_hook", CallingConvention = CallingConvention.Cdecl)]
-    public static extern string StartHook(Callback callback);
+        /// <summary>
+        /// The native version of <see cref="SkyHookManager.StartHook"/> method handled by <see cref="SkyHookManager"/>.
+        /// </summary>
+        /// <param name="callback">A native callback.</param>
+        /// <returns><c>null</c> if no error, or an error message.</returns>
+        [DllImport(Lib, EntryPoint = "start_hook", CallingConvention = CallingConvention.Cdecl)]
+        public static extern string StartHook(Callback callback);
 
-    [DllImport(Lib, EntryPoint = "stop_hook", CallingConvention = CallingConvention.Cdecl)]
-    public static extern string StopHook();
-  }
+        /// <summary>
+        /// The native version of <see cref="SkyHookManager.StopHook"/> method handled by <see cref="SkyHookManager"/>.
+        /// </summary>
+        /// <returns><c>null</c> if no error, or an error message.</returns>
+        [DllImport(Lib, EntryPoint = "stop_hook", CallingConvention = CallingConvention.Cdecl)]
+        public static extern string StopHook();
+    }
 }
\ No newline at end of file