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

diff --git a/include/modules.h b/include/modules.h
index 6df44305d32bbff8e1b4d922967c5d56f74b580f..2ba139e7eb463fb24b847dbb3f764c170f8ff16f 100644 (file)
--- 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);