From f939f472183ceebc3328ea9e80e73bc4f240a1c3 Mon Sep 17 00:00:00 2001
From: David Anderson <dvander@alliedmods.net>
Date: Sat, 19 Jan 2008 20:58:10 +0000
Subject: [PATCH] added some more doc to events

--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401857
---
 plugins/include/events.inc | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/plugins/include/events.inc b/plugins/include/events.inc
index fc189830..300703bd 100644
--- a/plugins/include/events.inc
+++ b/plugins/include/events.inc
@@ -108,6 +108,9 @@ native UnhookEvent(const String:name[], EventHook:callback, EventHookMode:mode=E
 /**
  * Creates a game event to be fired later.
  *
+ * The Handle should not be closed via CloseHandle().  It must be closed via 
+ * FireEvent() or CancelCreatedEvent().
+ *
  * @param name			Name of event.
  * @param force			If set to true, this forces the event to be created even if it's not being hooked.
  *						Note that this will not force it if the event doesn't exist at all.
@@ -119,6 +122,8 @@ native Handle:CreateEvent(const String:name[], bool:force=false);
 /**
  * Fires a game event.
  *
+ * This function closes the event Handle after completing.
+ *
  * @param event			Handle to the event.
  * @param dontBroadcast	Optional boolean that determines if event should be broadcast to clients.
  * @noreturn
@@ -169,6 +174,11 @@ native GetEventInt(Handle:event, const String:key[]);
 /**
  * Sets the integer value of a game event's key.
  *
+ * Integer value refers to anything that can be reduced to an integer.
+ * The various size specifiers, such as "byte" and "short" are still 
+ * integers, and only refer to how much data will actually be sent 
+ * over the network (if applicable).
+ *
  * @param event			Handle to the event.
  * @param key			Name of event key.
  * @param value			New integer value.