You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by tr...@apache.org on 2014/04/15 14:18:34 UTC
svn commit: r1587545 - in /apr/apr/trunk/include: apr_file_info.h
apr_fnmatch.h apr_thread_mutex.h
Author: trawick
Date: Tue Apr 15 12:18:34 2014
New Revision: 1587545
URL: http://svn.apache.org/r1587545
Log:
minor API doc improvements
Modified:
apr/apr/trunk/include/apr_file_info.h
apr/apr/trunk/include/apr_fnmatch.h
apr/apr/trunk/include/apr_thread_mutex.h
Modified: apr/apr/trunk/include/apr_file_info.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_file_info.h?rev=1587545&r1=1587544&r2=1587545&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_file_info.h (original)
+++ apr/apr/trunk/include/apr_file_info.h Tue Apr 15 12:18:34 2014
@@ -208,7 +208,7 @@ struct apr_finfo_t {
const char *fname;
/** The file's name (no path) in filesystem case */
const char *name;
- /** The file's handle, if accessed (can be submitted to apr_duphandle) */
+ /** Unused */
struct apr_file_t *filehand;
};
Modified: apr/apr/trunk/include/apr_fnmatch.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_fnmatch.h?rev=1587545&r1=1587544&r2=1587545&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_fnmatch.h (original)
+++ apr/apr/trunk/include/apr_fnmatch.h Tue Apr 15 12:18:34 2014
@@ -60,9 +60,7 @@ extern "C" {
#define APR_FNM_NOESCAPE 0x01 /**< Disable backslash escaping. */
#define APR_FNM_PATHNAME 0x02 /**< Slash must be matched by slash. */
#define APR_FNM_PERIOD 0x04 /**< Period must be matched by period. */
-#define APR_FNM_CASE_BLIND 0x08 /**< Compare characters case-insensitively.
- * @remark This flag is an Apache addition
- */
+#define APR_FNM_CASE_BLIND 0x08 /**< Compare characters case-insensitively. */
/**
* Try to match the string to the given pattern, return APR_SUCCESS if
@@ -130,13 +128,19 @@ APR_DECLARE(apr_status_t) apr_fnmatch(co
APR_DECLARE(int) apr_fnmatch_test(const char *pattern);
/**
- * Find all files that match a specified pattern.
- * @param pattern The pattern to use for finding files.
+ * Find all files that match a specified pattern in a directory.
+ * @param dir_pattern The pattern to use for finding files, appended
+ * to the search directory. The pattern is anything following the
+ * final forward or backward slash in the parameter. If no slash
+ * is found, the current directory is searched.
* @param result Array to use when storing the results
* @param p The pool to use.
- * @return non-zero if pattern has any glob characters in it
+ * @return APR_SUCCESS if no processing errors occurred, APR error
+ * code otherwise
+ * @remark The returned array may be empty even if APR_SUCCESS was
+ * returned.
*/
-APR_DECLARE(apr_status_t) apr_match_glob(const char *pattern,
+APR_DECLARE(apr_status_t) apr_match_glob(const char *dir_pattern,
apr_array_header_t **result,
apr_pool_t *p);
Modified: apr/apr/trunk/include/apr_thread_mutex.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_thread_mutex.h?rev=1587545&r1=1587544&r2=1587545&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_thread_mutex.h (original)
+++ apr/apr/trunk/include/apr_thread_mutex.h Tue Apr 15 12:18:34 2014
@@ -59,7 +59,7 @@ typedef struct apr_thread_mutex_t apr_th
* </PRE>
* @param pool the pool from which to allocate the mutex.
* @warning Be cautious in using APR_THREAD_MUTEX_DEFAULT. While this is the
- * most optimial mutex based on a given platform's performance charateristics,
+ * most optimal mutex based on a given platform's performance characteristics,
* it will behave as either a nested or an unnested lock.
*/
APR_DECLARE(apr_status_t) apr_thread_mutex_create(apr_thread_mutex_t **mutex,