aboutsummaryrefslogtreecommitdiffstats
path: root/include/modules
diff options
context:
space:
mode:
authorGravatar Sadie Powell2022-04-17 12:13:35 +0100
committerGravatar Sadie Powell2022-04-17 12:13:35 +0100
commitb6c77b3e017ef0dd98d4863cc6a3eb2ab2f6c16b (patch)
tree1889e2c18fdccd45e20b4232fe36662a8ba5af34 /include/modules
parentAllow normalising extbans to a specific format. (diff)
Fix a missing doxygen comment.
Diffstat (limited to 'include/modules')
-rw-r--r--include/modules/extban.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/modules/extban.h b/include/modules/extban.h
index 8f636d201..8475b6df2 100644
--- a/include/modules/extban.h
+++ b/include/modules/extban.h
@@ -254,6 +254,12 @@ public:
return channel->CheckBan(user, text);
}
+ /** Determines whether the specified user matches this acting extban on the specified channel.
+ * @param user The user to check.
+ * @param channel The channel to check on.
+ * @return MOD_RES_ALLOW to explicitly allow their action, MOD_RES_DENY to expicitly deny their
+ * action, or MOD_RES_PASSTHRU to let the default behaviour apply.
+ */
ModResult GetStatus(User* user, Channel* channel)
{
if (!GetManager())