Comment small API change (returning -1 from OnCheckBan to explicitly deny the ban)

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

1 files changed, 2 insertions, 1 deletions

diff --git a/include/modules.h b/include/modules.h
index abc783ca9..8354f34b4 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -1126,7 +1126,8 @@ class CoreExport Module : public Extensible
 	 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
 	 * @param user The user joining the channel
 	 * @param chan The channel being joined
-	 * @return 1 to explicitly allow the join, 0 to proceed as normal
+	 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
+	 * join to the channel.
 	 */
 	virtual int OnCheckBan(User* user, Channel* chan);