Document apr_fnmatch.h

git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@60295 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 29 insertions, 3 deletions

diff --git a/include/apr_fnmatch.h b/include/apr_fnmatch.h
index ba27efd1c..beb99c7a3 100644
--- a/include/apr_fnmatch.h
+++ b/include/apr_fnmatch.h
@@ -1,4 +1,4 @@
-/*-
+/*
  * Copyright (c) 1992, 1993
  *	The Regents of the University of California.  All rights reserved.
  *
@@ -49,12 +49,38 @@ extern "C" {
 #define	FNM_PATHNAME	0x02	/* Slash must be matched by slash. */
 #define	FNM_PERIOD	0x04	/* Period must be matched by period. */
 /* This flag is an Apache addition */
-#define FNM_CASE_BLIND  0x08    /* Compare characters case ap_pool_t nsensitively. */
+#define FNM_CASE_BLIND  0x08    /* Compare characters case-insensitively. */
+
+/*
+
+=head1 ap_status_t ap_fnmatch(const char *pattern, const char *strings, int flags)
+
+B<Try to match the string to the given pattern.>
+
+    arg 1) The pattern to match to
+    arg 2) The string we are trying to match
+    arg 3) flags to use in the match.  Bitwise OR of:
+                FNM_NOESCAPE   --  Disable backslash escaping
+                FNM_PATHNAME   --  Slash must be matched by slash
+                FNM_PERIOD     --  Period must be matched by period
+                FNM_CASE_BLIND --  Compare characters case-insensitively.
+
+=cut
+ */
 
 APR_EXPORT(ap_status_t) ap_fnmatch(const char *pattern, const char *strings,
 			    int flags);
 
-/* this function is an Apache addition */
+/*
+
+=head1 ap_status_t ap_is_fnmatch(const char *pattern)
+
+B<Determine if the given pattern is a regular expression.>
+
+    arg 1) The pattern to search for glob characters.
+
+=cut
+ */
 APR_EXPORT(int) ap_is_fnmatch(const char *pattern);
 
 #ifdef __cplusplus