apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rj...@apache.org
Subject svn commit: r1528854 - in /apr/apr-util/branches/1.5.x: ./ include/apr_dbd.h include/apr_hooks.h include/apr_optional_hooks.h include/apr_queue.h include/apr_reslist.h
Date Thu, 03 Oct 2013 13:32:44 GMT
Author: rjung
Date: Thu Oct  3 13:32:43 2013
New Revision: 1528854

URL: http://svn.apache.org/r1528854
Log:
Fix doc errors in APR header files.

PR: 55133
Submitted by: Mike Rumph <mike.rumph oracle.com>

Backport of r1496407 from trunk.

Modified:
    apr/apr-util/branches/1.5.x/   (props changed)
    apr/apr-util/branches/1.5.x/include/apr_dbd.h
    apr/apr-util/branches/1.5.x/include/apr_hooks.h
    apr/apr-util/branches/1.5.x/include/apr_optional_hooks.h
    apr/apr-util/branches/1.5.x/include/apr_queue.h
    apr/apr-util/branches/1.5.x/include/apr_reslist.h

Propchange: apr/apr-util/branches/1.5.x/
------------------------------------------------------------------------------
  Merged /apr/apr/trunk:r1496407

Modified: apr/apr-util/branches/1.5.x/include/apr_dbd.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/apr_dbd.h?rev=1528854&r1=1528853&r2=1528854&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/apr_dbd.h (original)
+++ apr/apr-util/branches/1.5.x/include/apr_dbd.h Thu Oct  3 13:32:43 2013
@@ -107,10 +107,10 @@ APU_DECLARE(apr_status_t) apr_dbd_get_dr
 
 /** apr_dbd_open_ex: open a connection to a backend
  *
+ *  @param driver - driver struct.
  *  @param pool - working pool
  *  @param params - arguments to driver (implementation-dependent)
  *  @param handle - pointer to handle to return
- *  @param driver - driver struct.
  *  @param error - descriptive error.
  *  @return APR_SUCCESS for success
  *  @return APR_EGENERAL if driver exists but connection failed
@@ -147,10 +147,10 @@ APU_DECLARE(apr_status_t) apr_dbd_open_e
 
 /** apr_dbd_open: open a connection to a backend
  *
+ *  @param driver - driver struct.
  *  @param pool - working pool
  *  @param params - arguments to driver (implementation-dependent)
  *  @param handle - pointer to handle to return
- *  @param driver - driver struct.
  *  @return APR_SUCCESS for success
  *  @return APR_EGENERAL if driver exists but connection failed
  *  @see apr_dbd_open_ex
@@ -161,8 +161,8 @@ APU_DECLARE(apr_status_t) apr_dbd_open(c
 
 /** apr_dbd_close: close a connection to a backend
  *
- *  @param handle - handle to close
  *  @param driver - driver struct.
+ *  @param handle - handle to close
  *  @return APR_SUCCESS for success or error status
  */
 APU_DECLARE(apr_status_t) apr_dbd_close(const apr_dbd_driver_t *driver,

Modified: apr/apr-util/branches/1.5.x/include/apr_hooks.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/apr_hooks.h?rev=1528854&r1=1528853&r2=1528854&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/apr_hooks.h (original)
+++ apr/apr-util/branches/1.5.x/include/apr_hooks.h Thu Oct  3 13:32:43 2013
@@ -313,24 +313,24 @@ APU_DECLARE_DATA extern apr_pool_t *apr_
 
 /**
  * A global variable to determine if debugging information about the
- * hooks functions should be printed
+ * hooks functions should be printed.
  */ 
 APU_DECLARE_DATA extern int apr_hook_debug_enabled;
 
 /**
- * The name of the module that is currently registering a function
+ * The name of the module that is currently registering a function.
  */ 
 APU_DECLARE_DATA extern const char *apr_hook_debug_current;
 
 /**
- * Register a hook function to be sorted
+ * Register a hook function to be sorted.
  * @param szHookName The name of the Hook the function is registered for
  * @param aHooks The array which stores all of the functions for this hook
  */
 APU_DECLARE(void) apr_hook_sort_register(const char *szHookName, 
                                         apr_array_header_t **aHooks);
 /**
- * Sort all of the registerd functions for a given hook
+ * Sort all of the registered functions for a given hook.
  */
 APU_DECLARE(void) apr_hook_sort_all(void);
 

Modified: apr/apr-util/branches/1.5.x/include/apr_optional_hooks.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/apr_optional_hooks.h?rev=1528854&r1=1528853&r2=1528854&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/apr_optional_hooks.h (original)
+++ apr/apr-util/branches/1.5.x/include/apr_optional_hooks.h Thu Oct  3 13:32:43 2013
@@ -33,11 +33,11 @@ extern "C" {
  * @{
  */
 /**
- * Function to implemnt the APR_OPTIONAL_HOOK Macro
+ * Function to implement the APR_OPTIONAL_HOOK Macro
  * @internal
  * @see APR_OPTIONAL_HOOK
  *
- * @param name The name of the hook
+ * @param szName The name of the hook
  * @param pfn A pointer to a function that will be called
  * @param aszPre a NULL-terminated array of strings that name modules whose hooks should
precede this one
  * @param aszSucc a NULL-terminated array of strings that name modules whose hooks should
succeed this one

Modified: apr/apr-util/branches/1.5.x/include/apr_queue.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/apr_queue.h?rev=1528854&r1=1528853&r2=1528854&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/apr_queue.h (original)
+++ apr/apr-util/branches/1.5.x/include/apr_queue.h Thu Oct  3 13:32:43 2013
@@ -22,7 +22,7 @@
  * @brief Thread Safe FIFO bounded queue
  * @note Since most implementations of the queue are backed by a condition
  * variable implementation, it isn't available on systems without threads.
- * Although condition variables are some times available without threads.
+ * Although condition variables are sometimes available without threads.
  */
 
 #include "apu.h"

Modified: apr/apr-util/branches/1.5.x/include/apr_reslist.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/apr_reslist.h?rev=1528854&r1=1528853&r2=1528854&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/apr_reslist.h (original)
+++ apr/apr-util/branches/1.5.x/include/apr_reslist.h Thu Oct  3 13:32:43 2013
@@ -44,7 +44,7 @@ typedef struct apr_reslist_t apr_reslist
 /* Generic constructor called by resource list when it needs to create a
  * resource.
  * @param resource opaque resource
- * @param param flags
+ * @param params flags
  * @param pool  Pool
  */
 typedef apr_status_t (*apr_reslist_constructor)(void **resource, void *params,
@@ -53,7 +53,7 @@ typedef apr_status_t (*apr_reslist_const
 /* Generic destructor called by resource list when it needs to destroy a
  * resource.
  * @param resource opaque resource
- * @param param flags
+ * @param params flags
  * @param pool  Pool
  */
 typedef apr_status_t (*apr_reslist_destructor)(void *resource, void *params,
@@ -111,12 +111,17 @@ APU_DECLARE(apr_status_t) apr_reslist_de
  * Retrieve a resource from the list, creating a new one if necessary.
  * If we have met our maximum number of resources, we will block
  * until one becomes available.
+ * @param reslist The resource list.
+ * @param resource An address where the pointer to the resource
+ *                will be stored.
  */
 APU_DECLARE(apr_status_t) apr_reslist_acquire(apr_reslist_t *reslist,
                                               void **resource);
 
 /**
  * Return a resource back to the list of available resources.
+ * @param reslist The resource list.
+ * @param resource The resource to return to the list.
  */
 APU_DECLARE(apr_status_t) apr_reslist_release(apr_reslist_t *reslist,
                                               void *resource);
@@ -140,6 +145,8 @@ APU_DECLARE(apr_uint32_t) apr_reslist_ac
  * Invalidate a resource in the pool - e.g. a database connection
  * that returns a "lost connection" error and can't be restored.
  * Use this instead of apr_reslist_release if the resource is bad.
+ * @param reslist The resource list.
+ * @param resource The resource to invalidate.
  */
 APU_DECLARE(apr_status_t) apr_reslist_invalidate(apr_reslist_t *reslist,
                                                  void *resource);



Mime
View raw message