See configreader.cpp line 764 to see how to declare deprecated items. This is reasona...

[user/henk/code/inspircd.git] / include / modules.h

diff --git a/include/modules.h b/include/modules.h
index abc783ca9e5e7e1dd6ffd0701e6d0414bb5a95c5..8354f34b41e432cf309a0d22aa259feba3cdee80 100644 (file)
--- 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);