X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fwildcard.h;h=259d86184cc86ba8e736dcbb79dcc2211c17c9a6;hb=f3624af468d769f0cb05cf17cd18111f5faa9ec3;hp=196350134a55c4c5730dc4fc6b0327c3c42b1542;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git

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);
+