apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jerenkra...@apache.org
Subject cvs commit: apr-util/include/private apr_dbm_private.h
Date Sun, 10 Nov 2002 09:24:14 GMT
jerenkrantz    2002/11/10 01:24:13

  Modified:    .        CHANGES
               include  apr_anylock.h apr_buckets.h apr_date.h apr_dbm.h
                        apr_hooks.h apr_md4.h apr_md5.h
                        apr_optional_hooks.h apr_queue.h apr_reslist.h
                        apr_rmm.h apr_sdbm.h apr_sha1.h apr_strmatch.h
                        apr_uri.h apr_xlate.h apr_xml.h
               include/private apr_dbm_private.h
  Log:
  Go through doxygen output and remove as many errors and warnings as I could.
  
  No code changes.
  
  Revision  Changes    Path
  1.86      +2 -0      apr-util/CHANGES
  
  Index: CHANGES
  ===================================================================
  RCS file: /home/cvs/apr-util/CHANGES,v
  retrieving revision 1.85
  retrieving revision 1.86
  diff -u -u -r1.85 -r1.86
  --- CHANGES	9 Oct 2002 08:17:31 -0000	1.85
  +++ CHANGES	10 Nov 2002 09:24:13 -0000	1.86
  @@ -1,5 +1,7 @@
   Changes with APR-util 0.9.2
   
  +  *) Update doxygen tags.  [Justin Erenkrantz]
  +
     *) Add apr_ldap.hw for Windows build.
        [Andre Schild <A.Schild@aarboard.ch>]
   
  
  
  
  1.5       +14 -8     apr-util/include/apr_anylock.h
  
  Index: apr_anylock.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_anylock.h,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -u -r1.4 -r1.5
  --- apr_anylock.h	13 Mar 2002 20:40:48 -0000	1.4
  +++ apr_anylock.h	10 Nov 2002 09:24:13 -0000	1.5
  @@ -63,25 +63,29 @@
   #include "apr_thread_mutex.h"
   #include "apr_thread_rwlock.h"
   
  +/** Structure that may contain any APR lock type */
   typedef struct apr_anylock_t {
  +    /** Indicates what type of lock is in lock */
       enum tm_lock {
  -        apr_anylock_none,
  -        apr_anylock_procmutex,
  -        apr_anylock_threadmutex,
  -        apr_anylock_readlock,
  -        apr_anylock_writelock
  +        apr_anylock_none,           /**< None */
  +        apr_anylock_procmutex,      /**< Process-based */
  +        apr_anylock_threadmutex,    /**< Thread-based */
  +        apr_anylock_readlock,       /**< Read lock */
  +        apr_anylock_writelock       /**< Write lock */
       } type;
  +    /** Union of all possible APR locks */
       union apr_anylock_u_t {
  -        apr_proc_mutex_t *pm;
  +        apr_proc_mutex_t *pm;       /**< Process mutex */
   #if APR_HAS_THREADS
  -        apr_thread_mutex_t *tm;
  -        apr_thread_rwlock_t *rw;
  +        apr_thread_mutex_t *tm;     /**< Thread mutex */
  +        apr_thread_rwlock_t *rw;    /**< Read-write lock */
   #endif
       } lock;
   } apr_anylock_t;
   
   #if APR_HAS_THREADS
   
  +/** Lock an apr_anylock_t structure */
   #define APR_ANYLOCK_LOCK(lck)                \
       (((lck)->type == apr_anylock_none)         \
         ? APR_SUCCESS                              \
  @@ -108,6 +112,7 @@
   
   #if APR_HAS_THREADS
   
  +/** Try to lock an apr_anylock_t structure */
   #define APR_ANYLOCK_TRYLOCK(lck)                \
       (((lck)->type == apr_anylock_none)            \
         ? APR_SUCCESS                                 \
  @@ -134,6 +139,7 @@
   
   #if APR_HAS_THREADS
   
  +/** Unlock an apr_anylock_t structure */
   #define APR_ANYLOCK_UNLOCK(lck)              \
       (((lck)->type == apr_anylock_none)         \
         ? APR_SUCCESS                              \
  
  
  
  1.147     +37 -18    apr-util/include/apr_buckets.h
  
  Index: apr_buckets.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_buckets.h,v
  retrieving revision 1.146
  retrieving revision 1.147
  diff -u -u -r1.146 -r1.147
  --- apr_buckets.h	13 Oct 2002 22:28:29 -0000	1.146
  +++ apr_buckets.h	10 Nov 2002 09:24:13 -0000	1.147
  @@ -87,9 +87,10 @@
   /** default bucket buffer size - 8KB minus room for memory allocator headers */
   #define APR_BUCKET_BUFF_SIZE 8000
   
  +/** Determines how a bucket or brigade should be read */
   typedef enum {
  -    APR_BLOCK_READ,   /* block until data becomes available */
  -    APR_NONBLOCK_READ /* return immediately if no data is available */
  +    APR_BLOCK_READ,   /**< block until data becomes available */
  +    APR_NONBLOCK_READ /**< return immediately if no data is available */
   } apr_read_type_e;
   
   /**
  @@ -148,11 +149,19 @@
    * Forward declaration of the main types.
    */
   
  +/** @see apr_bucket_brigade */
   typedef struct apr_bucket_brigade apr_bucket_brigade;
  +/** @see apr_bucket */
   typedef struct apr_bucket apr_bucket;
  +/** @see apr_bucket_alloc_t */
   typedef struct apr_bucket_alloc_t apr_bucket_alloc_t;
   
  +/** @see apr_bucket_type_t */
   typedef struct apr_bucket_type_t apr_bucket_type_t;
  +
  +/**
  + * Basic bucket type
  + */
   struct apr_bucket_type_t {
       /**
        * The name of the bucket type
  @@ -301,6 +310,9 @@
   };
   
   
  +/**
  + * Function called when a brigade should be flushed
  + */
   typedef apr_status_t (*apr_brigade_flush)(apr_bucket_brigade *bb, void *ctx);
   
   /**
  @@ -547,6 +559,7 @@
    * occur because of bucket splits or buckets that refer to globally
    * cached data. */
   
  +/** @see apr_bucket_refcount */
   typedef struct apr_bucket_refcount apr_bucket_refcount;
   /**
    * The structure used to manage the shared resource must start with an
  @@ -561,7 +574,7 @@
   
   /*  *****  Reference-counted bucket types  *****  */
   
  -
  +/** @see apr_bucket_heap */
   typedef struct apr_bucket_heap apr_bucket_heap;
   /**
    * A bucket referring to data allocated off the heap.
  @@ -579,6 +592,7 @@
       void (*free_func)(void *data);
   };
   
  +/** @see apr_bucket_pool */
   typedef struct apr_bucket_pool apr_bucket_pool;
   /**
    * A bucket referring to data allocated from a pool
  @@ -616,6 +630,7 @@
   };
   
   #if APR_HAS_MMAP
  +/** @see apr_bucket_mmap */
   typedef struct apr_bucket_mmap apr_bucket_mmap;
   /**
    * A bucket referring to an mmap()ed file
  @@ -628,6 +643,7 @@
   };
   #endif
   
  +/** @see apr_bucket_file */
   typedef struct apr_bucket_file apr_bucket_file;
   /**
    * A bucket referring to an file
  @@ -647,19 +663,20 @@
   #endif /* APR_HAS_MMAP */
   };
   
  +/** @see apr_bucket_structs */
   typedef union apr_bucket_structs apr_bucket_structs;
   /**
    * A union of all bucket structures so we know what
    * the max size is.
    */
   union apr_bucket_structs {
  -    apr_bucket      b;
  -    apr_bucket_heap heap;
  -    apr_bucket_pool pool;
  +    apr_bucket      b;      /**< Bucket */
  +    apr_bucket_heap heap;   /**< Heap */
  +    apr_bucket_pool pool;   /**< Pool */
   #if APR_HAS_MMAP
  -    apr_bucket_mmap mmap;
  +    apr_bucket_mmap mmap;   /**< MMap */
   #endif
  -    apr_bucket_file file;
  +    apr_bucket_file file;   /**< File */
   };
   
   /**
  @@ -672,8 +689,9 @@
   /*  *****  Bucket Brigade Functions  *****  */
   /**
    * Create a new bucket brigade.  The bucket brigade is originally empty.
  - * @param The pool to associate with the brigade.  Data is not allocated out
  - *        of the pool, but a cleanup is registered.
  + * @param p The pool to associate with the brigade.  Data is not allocated out
  + *          of the pool, but a cleanup is registered.
  + * @param list The bucket allocator to use
    * @return The empty bucket brigade
    */
   APU_DECLARE(apr_bucket_brigade *) apr_brigade_create(apr_pool_t *p,
  @@ -691,7 +709,7 @@
    * buckets within the bucket brigade's bucket list.  This is similar to
    * apr_brigade_destroy(), except that it does not deregister the brigade's
    * pool cleanup function.
  - * @param b The bucket brigade to clean up
  + * @param data The bucket brigade to clean up
    * @remark Generally, you should use apr_brigade_destroy().  This function
    *         can be useful in situations where you have a single brigade that
    *         you wish to reuse many times by destroying all of the buckets in
  @@ -761,7 +779,7 @@
    * @param bb The bucket brigade to create the iovec from
    * @param c On return, the allocated char array
    * @param len On return, the length of the char array.
  - * @param p The pool to allocate the string from.
  + * @param pool The pool to allocate the string from.
    */
   APU_DECLARE(apr_status_t) apr_brigade_pflatten(apr_bucket_brigade *bb, 
                                                  char **c,
  @@ -824,7 +842,7 @@
    * @param b The bucket brigade to add to
    * @param flush The flush function to use if the brigade is full
    * @param ctx The structure to pass to the flush function
  - * @param iovec The strings to add (address plus length for each)
  + * @param vec The strings to add (address plus length for each)
    * @param nvec The number of entries in iovec
    * @return APR_SUCCESS or error code
    */
  @@ -972,6 +990,7 @@
    * Setaside data so that stack data is not destroyed on returning from
    * the function
    * @param e The bucket to setaside
  + * @param p The pool to setaside into
    */
   #define apr_bucket_setaside(e,p) (e)->type->setaside(e,p)
   
  @@ -1347,7 +1366,7 @@
   #if APR_HAS_MMAP
   /**
    * Create a bucket referring to mmap()ed memory.
  - * @param mmap The mmap to insert into the bucket
  + * @param mm The mmap to insert into the bucket
    * @param start The offset of the first byte in the mmap
    *              that this bucket refers to
    * @param length The number of bytes referred to by this bucket
  @@ -1362,7 +1381,7 @@
   /**
    * Make the bucket passed in a bucket refer to an MMAP'ed file
    * @param b The bucket to make into a MMAP bucket
  - * @param mmap The mmap to insert into the bucket
  + * @param mm The mmap to insert into the bucket
    * @param start The offset of the first byte in the mmap
    *              that this bucket refers to
    * @param length The number of bytes referred to by this bucket
  @@ -1375,7 +1394,7 @@
   
   /**
    * Create a bucket referring to a socket.
  - * @param thissocket The socket to put in the bucket
  + * @param thissock The socket to put in the bucket
    * @param list The freelist from which this bucket should be allocated
    * @return The new bucket, or NULL if allocation failed
    */
  @@ -1384,7 +1403,7 @@
   /**
    * Make the bucket passed in a bucket refer to a socket
    * @param b The bucket to make into a SOCKET bucket
  - * @param thissocket The socket to put in the bucket
  + * @param thissock The socket to put in the bucket
    * @return The new bucket, or NULL if allocation failed
    */
   APU_DECLARE(apr_bucket *) apr_bucket_socket_make(apr_bucket *b, 
  @@ -1441,7 +1460,7 @@
   /**
    * Enable or disable memory-mapping for a FILE bucket (default is enabled)
    * @param b The bucket
  - * @param enable Whether memory-mapping should be enabled
  + * @param enabled Whether memory-mapping should be enabled
    * @return APR_SUCCESS normally, or an error code if the operation fails
    */
   APU_DECLARE(apr_status_t) apr_bucket_file_enable_mmap(apr_bucket *b,
  
  
  
  1.9       +2 -2      apr-util/include/apr_date.h
  
  Index: apr_date.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_date.h,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -u -r1.8 -r1.9
  --- apr_date.h	24 May 2002 02:35:02 -0000	1.8
  +++ apr_date.h	10 Nov 2002 09:24:13 -0000	1.9
  @@ -81,13 +81,13 @@
   extern "C" {
   #endif
   
  -
  +/** A bad date. */
   #define APR_DATE_BAD ((apr_time_t)0)
   
   /**
    * Compare a string to a mask
    * @param data The string to compare
  - * @mask Mask characters (arbitrary maximum is 256 characters, just in case):
  + * @param mask Mask characters (arbitrary maximum is 256 characters):
    * <PRE>
    *   @ - uppercase letter
    *   $ - lowercase letter
  
  
  
  1.19      +3 -14     apr-util/include/apr_dbm.h
  
  Index: apr_dbm.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_dbm.h,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -u -r1.18 -r1.19
  --- apr_dbm.h	23 Aug 2002 11:49:00 -0000	1.18
  +++ apr_dbm.h	10 Nov 2002 09:24:13 -0000	1.19
  @@ -117,7 +117,6 @@
    * </PRE>
    * @param perm Permissions to apply to if created
    * @param cntxt The pool to use when creating the dbm
  - * @deffunc apr_status_t apr_dbm_open(apr_dbm_t **dbm, const char *name, int mode
    * @tip The dbm name may not be a true file name, as many dbm packages
    * append suffixes for seperate data and index files.
    */
  @@ -141,7 +140,6 @@
    * </PRE>
    * @param perm Permissions to apply to if created
    * @param cntxt The pool to use when creating the dbm
  - * @deffunc apr_status_t apr_dbm_open(apr_dbm_t **dbm, const char *name, int mode
    * @tip The dbm name may not be a true file name, as many dbm packages
    * append suffixes for seperate data and index files.
    */
  @@ -152,7 +150,6 @@
   /**
    * Close a dbm file previously opened by apr_dbm_open
    * @param dbm The database to close
  - * @deffunc void apr_dbm_close(apr_dbm_t *dbm)
    */
   APU_DECLARE(void) apr_dbm_close(apr_dbm_t *dbm);
   
  @@ -160,8 +157,7 @@
    * Fetch a dbm record value by key
    * @param dbm The database 
    * @param key The key datum to find this record
  - * @param value The value datum retrieved for this record
  - * @deffunc apr_status_t apr_dbm_fetch(apr_dbm_t *dbm, apr_datum_t key
  + * @param pvalue The value datum retrieved for this record
    */
   APU_DECLARE(apr_status_t) apr_dbm_fetch(apr_dbm_t *dbm, apr_datum_t key,
                                           apr_datum_t *pvalue);
  @@ -170,7 +166,6 @@
    * @param dbm The database 
    * @param key The key datum to store this record by
    * @param value The value datum to store in this record
  - * @deffunc apr_status_t apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t value)
    */
   APU_DECLARE(apr_status_t) apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, 
                                           apr_datum_t value);
  @@ -179,7 +174,6 @@
    * Delete a dbm record value by key
    * @param dbm The database 
    * @param key The key datum of the record to delete
  - * @deffunc apr_status_t apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key)
    * @tip It is not an error to delete a non-existent record.
    */
   APU_DECLARE(apr_status_t) apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key);
  @@ -188,23 +182,20 @@
    * Search for a key within the dbm
    * @param dbm The database 
    * @param key The datum describing a key to test
  - * @deffunc int apr_dbm_exists(apr_dbm_t *dbm, apr_datum_t key)
    */
   APU_DECLARE(int) apr_dbm_exists(apr_dbm_t *dbm, apr_datum_t key);
   
   /**
    * Retrieve the first record key from a dbm
    * @param dbm The database 
  - * @param key The key datum of the first record
  - * @deffunc apr_status_t apr_dbm_firstkey(apr_dbm_t *dbm, apr_datum_t *pkey)
  + * @param pkey The key datum of the first record
    */
   APU_DECLARE(apr_status_t) apr_dbm_firstkey(apr_dbm_t *dbm, apr_datum_t *pkey);
   
   /**
    * Retrieve the next record key from a dbm
    * @param dbm The database 
  - * @param key The key datum of the next record
  - * @deffunc apr_status_t apr_dbm_nextkey(apr_dbm_t *dbm, apr_datum_t *pkey)
  + * @param pkey The key datum of the next record
    */
   APU_DECLARE(apr_status_t) apr_dbm_nextkey(apr_dbm_t *dbm, apr_datum_t *pkey);
   
  @@ -212,7 +203,6 @@
    * Proactively toss any memory associated with the apr_datum_t.
    * @param dbm The database 
    * @param data The datum to free.
  - * @deffunc void apr_dbm_freedatum(apr_dbm_t *dbm, apr_datum_t data)
    */
   APU_DECLARE(void) apr_dbm_freedatum(apr_dbm_t *dbm, apr_datum_t data);
   
  @@ -224,7 +214,6 @@
    * @param errbuf Location to store the error text
    * @param errbufsize The size of the provided buffer
    * @return The errbuf parameter, for convenience.
  - * @deffunc const char * apr_dbm_geterror(apr_dbm_t *dbm, int *errcode, char *errbuf, apr_size_t
errbufsize)
    */
   APU_DECLARE(char *) apr_dbm_geterror(apr_dbm_t *dbm, int *errcode,
                                        char *errbuf, apr_size_t errbufsize);
  
  
  
  1.46      +10 -3     apr-util/include/apr_hooks.h
  
  Index: apr_hooks.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_hooks.h,v
  retrieving revision 1.45
  retrieving revision 1.46
  diff -u -u -r1.45 -r1.46
  --- apr_hooks.h	6 Jul 2002 19:44:50 -0000	1.45
  +++ apr_hooks.h	10 Nov 2002 09:24:13 -0000	1.46
  @@ -97,9 +97,11 @@
   #define APR_HOOK_STRUCT(members) \
   static struct { members } _hooks;
   
  +/** macro to link the hook structure */
   #define APR_HOOK_LINK(name) \
       apr_array_header_t *link_##name;
   
  +/** macro to implement the hook */
   #define APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ns,link,name) \
   link##_DECLARE(void) ns##_hook_##name(ns##_HOOK_##name##_t *pf,const char * const *aszPre,
\
                                         const char * const *aszSucc,int nOrder) \
  @@ -131,7 +133,7 @@
    * @param link The linkage declaration prefix of the hook
    * @param name The name of the hook
    * @param args_decl The declaration of the arguments for the hook
  - * @param args_used The names for the arguments for the hook
  + * @param args_use The names for the arguments for the hook
    * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
    * provide export linkage from the module that IMPLEMENTs the hook, and
    * import linkage from external modules that link to the hook's module.
  @@ -159,9 +161,12 @@
    * other than OK or DECLINE
    * @param ns The namespace prefix of the hook functions
    * @param link The linkage declaration prefix of the hook
  + * @param ret Type to return
    * @param name The name of the hook
    * @param args_decl The declaration of the arguments for the hook
  - * @param args_used The names for the arguments for the hook
  + * @param args_use The names for the arguments for the hook
  + * @param ok Success value
  + * @param decline Decline value
    * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
    * provide export linkage from the module that IMPLEMENTs the hook, and
    * import linkage from external modules that link to the hook's module.
  @@ -195,8 +200,10 @@
    * @param ns The namespace prefix of the hook functions
    * @param link The linkage declaration prefix of the hook
    * @param name The name of the hook
  + * @param ret Type to return
    * @param args_decl The declaration of the arguments for the hook
  - * @param args_used The names for the arguments for the hook
  + * @param args_use The names for the arguments for the hook
  + * @param decline Decline value
    * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
    * provide export linkage from the module that IMPLEMENTs the hook, and
    * import linkage from external modules that link to the hook's module.
  
  
  
  1.5       +2 -0      apr-util/include/apr_md4.h
  
  Index: apr_md4.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_md4.h,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -u -r1.4 -r1.5
  --- apr_md4.h	13 Mar 2002 20:40:48 -0000	1.4
  +++ apr_md4.h	10 Nov 2002 09:24:13 -0000	1.5
  @@ -95,8 +95,10 @@
    * @{
    */
   
  +/** The digestsize for MD4 */
   #define APR_MD4_DIGESTSIZE 16
   
  +/** @see apr_md4_ctx_t */
   typedef struct apr_md4_ctx_t apr_md4_ctx_t;
   
   /** MD4 context. */
  
  
  
  1.2       +2 -0      apr-util/include/apr_md5.h
  
  Index: apr_md5.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_md5.h,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -u -r1.1 -r1.2
  --- apr_md5.h	17 Jul 2002 02:53:26 -0000	1.1
  +++ apr_md5.h	10 Nov 2002 09:24:13 -0000	1.2
  @@ -102,8 +102,10 @@
    * @{
    */
   
  +/** The MD5 digest size */
   #define MD5_DIGESTSIZE 16
   
  +/** @see apr_md5_ctx_t */
   typedef struct apr_md5_ctx_t apr_md5_ctx_t;
   
   /** MD5 context. */
  
  
  
  1.8       +8 -3      apr-util/include/apr_optional_hooks.h
  
  Index: apr_optional_hooks.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_optional_hooks.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -u -r1.7 -r1.8
  --- apr_optional_hooks.h	13 Mar 2002 20:40:48 -0000	1.7
  +++ apr_optional_hooks.h	10 Nov 2002 09:24:13 -0000	1.8
  @@ -91,6 +91,7 @@
   /**
    * Hook to an optional hook.
    *
  + * @param ns The namespace prefix of the hook functions
    * @param name 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
  @@ -105,20 +106,24 @@
   
   /**
    * @internal
  - * return the hook structure for a give hook
    * @param szName - the name of the function
  + * @return the hook structure for a given hook
    */
  - 
   APU_DECLARE(apr_array_header_t *) apr_optional_hook_get(const char *szName);
   
   /**
    * Implement an optional hook that runs until one of the functions
    * returns something other than OK or DECLINE.
    *
  + * @param ns The namespace prefix of the hook functions
  + * @param link The linkage declaration prefix of the hook
  + * @param ret The type of the return value of the hook
    * @param ret The type of the return value of the hook
    * @param name The name of the hook
    * @param args_decl The declaration of the arguments for the hook
  - * @param args_used The names for the arguments for the hook
  + * @param args_use The names for the arguments for the hook
  + * @param ok Success value
  + * @param decline Decline value
    */
   #define APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ns,link,ret,name,args_decl,args_use,ok,decline)
\
   link##_DECLARE(ret) ns##_run_##name args_decl \
  
  
  
  1.3       +6 -5      apr-util/include/apr_queue.h
  
  Index: apr_queue.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_queue.h,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -u -r1.2 -r1.3
  --- apr_queue.h	19 Aug 2002 16:37:44 -0000	1.2
  +++ apr_queue.h	10 Nov 2002 09:24:13 -0000	1.3
  @@ -75,8 +75,9 @@
   
   /** 
    * create a FIFO queue
  + * @param queue The new queue
    * @param queue_capacity maximum size of the queue
  - * @pool to use
  + * @param a pool to allocate queue from
    */
   apr_status_t apr_queue_create(apr_queue_t **queue, 
                               int queue_capacity, 
  @@ -86,7 +87,7 @@
    * push/add a object to the queue, blocking if the queue is already full
    *
    * @param queue the queue
  - * @param the data
  + * @param data the data
    * @returns APR_EINTR the blocking was interrupted (try again)
    * @returns APR_EOF the queue has been terminated
    * @returns APR_SUCCESS on a successfull push
  @@ -97,7 +98,7 @@
    * pop/get an object from the queue, blocking if the queue is already empty
    *
    * @param queue the queue
  - * @param the data
  + * @param data the data
    * @returns APR_EINTR the blocking was interrupted (try again)
    * @returns APR_EOF if the queue has been terminated
    * @returns APR_SUCCESS on a successfull pop
  @@ -108,7 +109,7 @@
    * push/add a object to the queue, returning immediatly if the queue is full
    *
    * @param queue the queue
  - * @param the data
  + * @param data the data
    * @returns APR_EINTR the blocking operation was interrupted (try again)
    * @returns APR_EAGAIN the queue is full
    * @returns APR_EOF the queue has been terminated
  @@ -120,7 +121,7 @@
    * pop/get an object to the queue, returning immediatly if the queue is empty
    *
    * @param queue the queue
  - * @param the data
  + * @param data the data
    * @returns APR_EINTR the blocking operation was interrupted (try again)
    * @returns APR_EAGAIN the queue is empty
    * @returns APR_EOF the queue has been terminated
  
  
  
  1.4       +16 -7     apr-util/include/apr_reslist.h
  
  Index: apr_reslist.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_reslist.h,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -u -r1.3 -r1.4
  --- apr_reslist.h	1 Sep 2002 21:13:01 -0000	1.3
  +++ apr_reslist.h	10 Nov 2002 09:24:13 -0000	1.4
  @@ -81,13 +81,21 @@
   /** Opaque resource list object */
   typedef struct apr_reslist_t apr_reslist_t;
   
  -/**
  - * Generic prototypes for the constructor and destructor that
  - * is called by the resource list any time it needs to create
  - * or destroy a resource.
  +/* Generic constructor called by resource list when it needs to create a
  + * resource.
  + * @param resource opaque resource
  + * @param param flags
  + * @param pool  Pool
    */
   typedef apr_status_t (*apr_reslist_constructor)(void **resource, void *params,
                                                   apr_pool_t *pool);
  +
  +/* Generic destructor called by resource list when it needs to destroy a
  + * resource.
  + * @param resource opaque resource
  + * @param param flags
  + * @param pool  Pool
  + */
   typedef apr_status_t (*apr_reslist_destructor)(void *resource, void *params,
                                                  apr_pool_t *pool);
   
  @@ -100,11 +108,12 @@
    *            creates new resources only when needed.
    * @param smax Resources will be destroyed to meet this maximum
    *             restriction as they expire.
  - * @param hmaxx Absolute maximum limit on the number of total resources.
  - * @param expire If non-zero, sets the maximum amount of time a resource
  + * @param hmax Absolute maximum limit on the number of total resources.
  + * @param ttl If non-zero, sets the maximum amount of time a resource
    *               may be available while exceeding the soft limit.
    * @param con Constructor routine that is called to create a new resource.
    * @param de Destructor routine that is called to destroy an expired resource.
  + * @param params Passed to constructor and deconstructor
    * @param pool The pool from which to create this resoure list. Also the
    *             same pool that is passed to the constructor and destructor
    *             routines.
  @@ -123,7 +132,7 @@
    * FIXME: Should this block until all resources become available,
    *        or maybe just destroy all the free ones, or maybe destroy
    *        them even though they might be in use by something else?
  - * @param rmm The relocatable memory block to destroy
  + * @param reslist The reslist to destroy
    */
   APU_DECLARE(apr_status_t) apr_reslist_destroy(apr_reslist_t *reslist);
   
  
  
  
  1.8       +7 -0      apr-util/include/apr_rmm.h
  
  Index: apr_rmm.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_rmm.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -u -r1.7 -r1.8
  --- apr_rmm.h	1 Sep 2002 21:13:01 -0000	1.7
  +++ apr_rmm.h	10 Nov 2002 09:24:13 -0000	1.8
  @@ -120,6 +120,13 @@
    * @param reqsize How much memory to allocate
    */
   APU_DECLARE(apr_rmm_off_t) apr_rmm_malloc(apr_rmm_t *rmm, apr_size_t reqsize);
  +
  +/**
  + * Realloc memory from the block of relocatable memory.
  + * @param rmm The relocatable memory block
  + * @param entity The memory allocation to realloc
  + * @param reqsize The new size
  + */
   APU_DECLARE(apr_rmm_off_t) apr_rmm_realloc(apr_rmm_t *rmm, void *entity, apr_size_t reqsize);
   
   /**
  
  
  
  1.11      +8 -6      apr-util/include/apr_sdbm.h
  
  Index: apr_sdbm.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_sdbm.h,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -u -r1.10 -r1.11
  --- apr_sdbm.h	13 Mar 2002 20:40:48 -0000	1.10
  +++ apr_sdbm.h	10 Nov 2002 09:24:13 -0000	1.11
  @@ -92,13 +92,15 @@
   } apr_sdbm_datum_t;
   
   /* The extensions used for the database files */
  +/** SDBM Directory file extension */
   #define APR_SDBM_DIRFEXT	".dir"
  +/** SDBM page file extension */
   #define APR_SDBM_PAGFEXT	".pag"
   
   /* flags to sdbm_store */
  -#define APR_SDBM_INSERT     0
  -#define APR_SDBM_REPLACE    1
  -#define APR_SDBM_INSERTDUP  2
  +#define APR_SDBM_INSERT     0   /**< Insert */
  +#define APR_SDBM_REPLACE    1   /**< Replace */
  +#define APR_SDBM_INSERTDUP  2   /**< Insert with duplicates */
   
   /**
    * Open an sdbm database by file name
  @@ -113,8 +115,8 @@
    *           APR_DELONCLOSE     delete the sdbm when closed
    *           APR_SHARELOCK      support locking across process/machines
    * </PRE>
  - * @param perm Permissions to apply to if created
  - * @param pool The pool to use when creating the sdbm
  + * @param perms Permissions to apply to if created
  + * @param p The pool to use when creating the sdbm
    * @remark The sdbm name is not a true file name, as sdbm appends suffixes 
    * for seperate data and index files.
    */
  @@ -186,7 +188,7 @@
   
   /**
    * Retrieve the first record key from a dbm
  - * @param dbm The database 
  + * @param db The database 
    * @param key The key datum of the first record
    * @remark The keys returned are not ordered.  To traverse the list of keys
    * for an sdbm opened with APR_SHARELOCK, the caller must use apr_sdbm_lock
  
  
  
  1.22      +4 -3      apr-util/include/apr_sha1.h
  
  Index: apr_sha1.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_sha1.h,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -u -r1.21 -r1.22
  --- apr_sha1.h	13 Mar 2002 20:40:48 -0000	1.21
  +++ apr_sha1.h	10 Nov 2002 09:24:13 -0000	1.22
  @@ -85,11 +85,12 @@
   /** length of the SHA Password */
   #define APR_SHA1PW_IDLEN 5
   
  -/**
  - * SHA1 context structure
  - */
  +/** @see apr_sha1_ctx_t */
   typedef struct apr_sha1_ctx_t apr_sha1_ctx_t;
   
  +/** 
  + * SHA1 context structure
  + */
   struct apr_sha1_ctx_t {
       /** message digest */
       apr_uint32_t digest[5];
  
  
  
  1.4       +7 -4      apr-util/include/apr_strmatch.h
  
  Index: apr_strmatch.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_strmatch.h,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -u -r1.3 -r1.4
  --- apr_strmatch.h	25 May 2002 00:06:44 -0000	1.3
  +++ apr_strmatch.h	10 Nov 2002 09:24:13 -0000	1.4
  @@ -76,16 +76,19 @@
    * @{
    */
   
  +/** @see apr_strmatch_pattern */
   typedef struct apr_strmatch_pattern apr_strmatch_pattern;
  +
   /**
    * Precompiled search pattern
    */
   struct apr_strmatch_pattern {
  +    /** Function called to compare */
       const char *(*compare)(const apr_strmatch_pattern *this_pattern,
                              const char *s, apr_size_t slen);
  -    const char *pattern;
  -    apr_size_t length;
  -    void *context;  /* hook for subclasses to add precomputed metadata */
  +    const char *pattern;    /**< Current pattern */
  +    apr_size_t length;      /**< Current length */
  +    void *context;          /**< hook to add precomputed metadata */
   };
   
   #if defined(DOXYGEN)
  @@ -98,7 +101,7 @@
    *         NULL if not found
    */
   APU_DECLARE(const char *) apr_strmatch(const apr_strmatch_pattern *pattern,
  -                                       const char *s; apr_size_t s);
  +                                       const char *s, apr_size_t slen);
   #else
   #define apr_strmatch(pattern, s, slen) (*((pattern)->compare))((pattern), (s), (slen))
   #endif
  
  
  
  1.13      +19 -18    apr-util/include/apr_uri.h
  
  Index: apr_uri.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_uri.h,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -u -r1.12 -r1.13
  --- apr_uri.h	6 Jul 2002 19:44:50 -0000	1.12
  +++ apr_uri.h	10 Nov 2002 09:24:13 -0000	1.13
  @@ -82,24 +82,24 @@
    * @{
    */
   
  -#define APR_URI_FTP_DEFAULT_PORT         21
  -#define APR_URI_SSH_DEFAULT_PORT         22
  -#define APR_URI_TELNET_DEFAULT_PORT      23
  -#define APR_URI_GOPHER_DEFAULT_PORT      70
  -#define APR_URI_HTTP_DEFAULT_PORT        80
  -#define APR_URI_POP_DEFAULT_PORT        110
  -#define APR_URI_NNTP_DEFAULT_PORT       119
  -#define APR_URI_IMAP_DEFAULT_PORT       143
  -#define APR_URI_PROSPERO_DEFAULT_PORT   191
  -#define APR_URI_WAIS_DEFAULT_PORT       210
  -#define APR_URI_LDAP_DEFAULT_PORT       389
  -#define APR_URI_HTTPS_DEFAULT_PORT      443
  -#define APR_URI_RTSP_DEFAULT_PORT       554
  -#define APR_URI_SNEWS_DEFAULT_PORT      563
  -#define APR_URI_ACAP_DEFAULT_PORT       674
  -#define APR_URI_NFS_DEFAULT_PORT       2049
  -#define APR_URI_TIP_DEFAULT_PORT       3372
  -#define APR_URI_SIP_DEFAULT_PORT       5060
  +#define APR_URI_FTP_DEFAULT_PORT         21 /**< default FTP port */
  +#define APR_URI_SSH_DEFAULT_PORT         22 /**< default SSH port */
  +#define APR_URI_TELNET_DEFAULT_PORT      23 /**< default telnet port */
  +#define APR_URI_GOPHER_DEFAULT_PORT      70 /**< default Gopher port */
  +#define APR_URI_HTTP_DEFAULT_PORT        80 /**< default HTTP port */
  +#define APR_URI_POP_DEFAULT_PORT        110 /**< default POP port */
  +#define APR_URI_NNTP_DEFAULT_PORT       119 /**< default NNTP port */
  +#define APR_URI_IMAP_DEFAULT_PORT       143 /**< default IMAP port */
  +#define APR_URI_PROSPERO_DEFAULT_PORT   191 /**< default Prospero port */
  +#define APR_URI_WAIS_DEFAULT_PORT       210 /**< default WAIS port */
  +#define APR_URI_LDAP_DEFAULT_PORT       389 /**< default LDAP port */
  +#define APR_URI_HTTPS_DEFAULT_PORT      443 /**< default HTTPS port */
  +#define APR_URI_RTSP_DEFAULT_PORT       554 /**< default RTSP port */
  +#define APR_URI_SNEWS_DEFAULT_PORT      563 /**< default SNEWS port */
  +#define APR_URI_ACAP_DEFAULT_PORT       674 /**< default ACAP port */
  +#define APR_URI_NFS_DEFAULT_PORT       2049 /**< default NFS port */
  +#define APR_URI_TIP_DEFAULT_PORT       3372 /**< default TIP port */
  +#define APR_URI_SIP_DEFAULT_PORT       5060 /**< default SIP port */
   
   /** Flags passed to unparse_uri_components(): */
   /** suppress "scheme://user@site:port" */
  @@ -118,6 +118,7 @@
   /** Omit the "?queryarg" from the path */
   #define APR_URI_UNP_OMITQUERY       (1U<<5)
   
  +/** @see apr_uri_t */
   typedef struct apr_uri_t apr_uri_t;
   
   /**
  
  
  
  1.5       +1 -1      apr-util/include/apr_xlate.h
  
  Index: apr_xlate.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_xlate.h,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -u -r1.4 -r1.5
  --- apr_xlate.h	19 Jul 2002 20:05:26 -0000	1.4
  +++ apr_xlate.h	10 Nov 2002 09:24:13 -0000	1.5
  @@ -73,7 +73,7 @@
    * @ingroup APR
    * @{
    */
  -
  +/** Opaque translation buffer */
   typedef struct apr_xlate_t            apr_xlate_t;
   
   /**
  
  
  
  1.19      +13 -6     apr-util/include/apr_xml.h
  
  Index: apr_xml.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_xml.h,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -u -r1.18 -r1.19
  --- apr_xml.h	7 Nov 2002 03:54:15 -0000	1.18
  +++ apr_xml.h	10 Nov 2002 09:24:13 -0000	1.19
  @@ -81,7 +81,7 @@
   
   /* ### these will need to move at some point to a more logical spot */
   
  -/* simple strutures to keep a linked list of pieces of text */
  +/** @see apr_text */
   typedef struct apr_text apr_text;
   
   /** Structure to keep a linked list of pieces of text */
  @@ -93,6 +93,7 @@
       struct apr_text *next;
   };
   
  +/** @see apr_text_header */
   typedef struct apr_text_header apr_text_header;
   
   /** A list of pieces of text */
  @@ -165,15 +166,18 @@
   **     left within the XML tree), so the APR_XML_NS_NONE value won't ever
   **     really apply to these values.
   */
  -#define APR_XML_NS_DAV_ID	0	/* namespace ID for "DAV:" */
  -#define APR_XML_NS_NONE		-10	/* no namespace for this elem/attr */
  +#define APR_XML_NS_DAV_ID	0	/**< namespace ID for "DAV:" */
  +#define APR_XML_NS_NONE		-10	/**< no namespace for this elem/attr */
   
  -#define APR_XML_NS_ERROR_BASE	-100	/* used only during processing */
  +#define APR_XML_NS_ERROR_BASE	-100	/**< used only during processing */
  +/** Is this namespace an error? */
   #define APR_XML_NS_IS_ERROR(e)	((e) <= APR_XML_NS_ERROR_BASE)
   
  -
  +/** @see apr_xml_attr */
   typedef struct apr_xml_attr apr_xml_attr;
  +/** @see apr_xml_elem */
   typedef struct apr_xml_elem apr_xml_elem;
  +/** @see apr_xml_doc */
   typedef struct apr_xml_doc apr_xml_doc;
   
   /** apr_xml_attr: holds a parsed XML attribute */
  @@ -231,6 +235,7 @@
       void *priv;
   };
   
  +/** Is this XML element empty? */
   #define APR_XML_ELEM_IS_EMPTY(e) ((e)->first_child == NULL && \
                                     (e)->first_cdata.first == NULL)
   
  @@ -242,7 +247,7 @@
       apr_array_header_t *namespaces;
   };
   
  -
  +/** Opaque XML parser structure */
   typedef struct apr_xml_parser apr_xml_parser;
   
   /**
  @@ -370,6 +375,8 @@
    */
   APU_DECLARE(int) apr_xml_insert_uri(apr_array_header_t *uri_array,
                                       const char *uri);
  +
  +/** Get the URI item for this XML element */
   #define APR_XML_GET_URI_ITEM(ary, i) (((const char * const *)(ary)->elts)[i])
   
   #ifdef __cplusplus
  
  
  
  1.7       +3 -0      apr-util/include/private/apr_dbm_private.h
  
  Index: apr_dbm_private.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/private/apr_dbm_private.h,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -u -r1.6 -r1.7
  --- apr_dbm_private.h	21 Aug 2002 21:42:41 -0000	1.6
  +++ apr_dbm_private.h	10 Nov 2002 09:24:13 -0000	1.7
  @@ -130,12 +130,15 @@
    */
   struct apr_dbm_t
   { 
  +    /** Associated pool */
       apr_pool_t *pool;
   
       /** pointer to DB Implementation Specific data */
       void *file;
   
  +    /** Current integer error code */
       int errcode;
  +    /** Current string error code */
       const char *errmsg;
   
       /** the type of DBM */
  
  
  

Mime
View raw message