Commented on new return value of OnUserPreKick for explicitly allowing kicks

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@3087 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 1 insertions, 1 deletions

diff --git a/include/modules.h b/include/modules.h
index 6df44305d..2ba139e7e 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -462,7 +462,7 @@ class Module : public classbase
 	 * @param user The user being kicked
 	 * @param chan The channel the user is being kicked from
 	 * @param reason The kick reason
-	 * @return 1 to prevent the kick, 0 to allow it
+	 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
          */
 	virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);