From a2259e92ba48646348ed7a0456d896f4117d311d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 17 Jun 2007 19:54:37 +0000 Subject: More comments git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7384 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/wildcard.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'include/wildcard.h') diff --git a/include/wildcard.h b/include/wildcard.h index 196350134..259d86184 100644 --- a/include/wildcard.h +++ b/include/wildcard.h @@ -13,7 +13,33 @@ #include "inspircd_config.h" +/** Match a string against a mask. + * @param str The string to check + * @param mask the mask to check against + * @return true if the strings match + */ CoreExport bool match(const char *str, const char *mask); +/** Match a string against a mask, and define wether or not to use CIDR rules + * @param str The string to check + * @param mask the mask to check against + * @param use_cidr_match True if CIDR matching rules should be applied first + * @return true if the strings match + */ CoreExport bool match(const char *str, const char *mask, bool use_cidr_match); +/** Match a string against a mask, defining wether case sensitivity applies. + * @param str The string to check + * @param mask the mask to check against + * @param case_sensitive True if the match is case sensitive + * @return True if the strings match + */ CoreExport bool match(bool case_sensitive, const char *str, const char *mask); +/** Match a string against a mask, defining wether case sensitivity applies, + * and defining wether or not to use CIDR rules first. + * @param case_sensitive True if the match is case sensitive + * @param str The string to check + * @param mask the mask to check against + * @param use_cidr_match True if CIDR matching rules should be applied first + * @return true if the strings match + */ CoreExport bool match(bool case_sensitive, const char *str, const char *mask, bool use_cidr_match); + -- cgit v1.2.3