chore(api): update include docs (#25)

Author: Rushaway

addons/sourcemod/scripting/KnockbackRestrict.sp

@@ -105,7 +105,7 @@ public Plugin myinfo = {
 	name 		= "KnockbackRestrict",
 	author		= "Dolly, Rushaway",
 	description = "Adjust knockback of certain weapons for the kbanned players",
-	version 	= "3.4.8",
+	version 	= KR_VERSION,
 	url			= "https://github.com/srcdslab/sm-plugin-KnockbackRestrict"
 };
 

addons/sourcemod/scripting/include/KnockbackRestrict.inc

@@ -11,6 +11,12 @@
 #endif
 #define _KnockbackRestrict_included_
 
+#define KR_V_MAJOR   "3"
+#define KR_V_MINOR   "4"
+#define KR_V_PATCH   "9"
+
+#define KR_VERSION   KR_V_MAJOR..."."...KR_V_MINOR..."."...KR_V_PATCH
+
 public SharedPlugin __pl_KnockbackRestrict = 
 {
 	name = "KnockbackRestrict",
@@ -67,7 +73,25 @@ native bool KR_ClientStatus(int client);
  *********************************************************/
 native int KR_GetClientKbansNumber(int client);
 
-
+/**
+ * Called when a client is knockback restricted.
+ *
+ * @param client        Client index
+ * @param admin         Admin index
+ * @param length        Ban length in minutes (0 = permanent, -1 = temporary)
+ * @param reason        Ban reason
+ * @param kbansNumber   Number of active knockback restrictions for this client
+ * @noreturn
+ */
 forward void KR_OnClientKbanned(int client, int admin, int length, const char[] reason, int kbansNumber);
 
+/**
+ * Called when a client's knockback restriction is removed.
+ *
+ * @param client        Client index
+ * @param admin         Admin index
+ * @param reason        Unban reason
+ * @param kbansNumber   Number of active knockback restrictions for this client
+ * @noreturn
+ */
 forward void KR_OnClientKunbanned(int client, int admin, const char[] reason, int kbansNumber);