apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From i...@apache.org
Subject cvs commit: apr/include apr_errno.h apr_hash.h apr_lib.h apr_strings.h apr_tables.h apr_time.h apr_user.h apr_uuid.h apr_want.h apr_xlate.h
Date Fri, 24 Aug 2001 17:55:45 GMT
ianh        01/08/24 10:55:45

  Modified:    include  apr_errno.h apr_hash.h apr_lib.h apr_strings.h
                        apr_tables.h apr_time.h apr_user.h apr_uuid.h
                        apr_want.h apr_xlate.h
  Log:
  ALL APR Include files (except for Arch specific stuff) now
  have Doxygen format headers
  
  Revision  Changes    Path
  1.79      +1 -1      apr/include/apr_errno.h
  
  Index: apr_errno.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_errno.h,v
  retrieving revision 1.78
  retrieving revision 1.79
  diff -u -r1.78 -r1.79
  --- apr_errno.h	2001/08/11 17:57:11	1.78
  +++ apr_errno.h	2001/08/24 17:55:45	1.79
  @@ -67,7 +67,7 @@
   
   /**
    * @file apr_errno.h
  - * @brief Error Codes
  + * @brief APR Error Codes
    */
   /**
    * @defgroup APR_Error_Codes Error Codes
  
  
  
  1.30      +1 -1      apr/include/apr_hash.h
  
  Index: apr_hash.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_hash.h,v
  retrieving revision 1.29
  retrieving revision 1.30
  diff -u -r1.29 -r1.30
  --- apr_hash.h	2001/08/17 03:33:55	1.29
  +++ apr_hash.h	2001/08/24 17:55:45	1.30
  @@ -64,7 +64,7 @@
   #endif
   /**
    * @file apr_hash.h
  - * @brief Hash Tables
  + * @brief APR Hash Tables
    */
   
   /**
  
  
  
  1.55      +1 -1      apr/include/apr_lib.h
  
  Index: apr_lib.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_lib.h,v
  retrieving revision 1.54
  retrieving revision 1.55
  diff -u -r1.54 -r1.55
  --- apr_lib.h	2001/08/14 04:05:16	1.54
  +++ apr_lib.h	2001/08/24 17:55:45	1.55
  @@ -56,7 +56,7 @@
   #define APR_LIB_H
   /**
    * @file apr_lib.h
  - * @brief general purpose library routines
  + * @brief APR general purpose library routines
    */
   
   #include "apr.h"
  
  
  
  1.22      +16 -25    apr/include/apr_strings.h
  
  Index: apr_strings.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_strings.h,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- apr_strings.h	2001/07/25 21:32:45	1.21
  +++ apr_strings.h	2001/08/24 17:55:45	1.22
  @@ -89,11 +89,15 @@
   #ifdef __cplusplus
   extern "C" {
   #endif /* __cplusplus */
  -
   /**
  - * @package APR strings library
  + * @file apr_strings.h
  + * @brief APR Strings library
    */
  -
  +/**
  + * @defgroup APR_Strings String routines
  + * @ingroup APR
  + * @{
  + */
   /**
    * Do a natural order comparison of two strings.
    * @param a The first string to compare
  @@ -101,7 +105,6 @@
    * @return Either <0, 0, or >0.  If the first string is less than the second
    *          this returns <0, if they are equivalent it returns 0, and if the
    *          first string is greater than second string it retuns >0.
  - * @deffunc int apr_strnatcmp(char const *a, char const *b)
    */
   APR_DECLARE(int) apr_strnatcmp(char const *a, char const *b);
   
  @@ -113,7 +116,6 @@
    * @return Either <0, 0, or >0.  If the first string is less than the second
    *         this returns <0, if they are equivalent it returns 0, and if the
    *         first string is greater than second string it retuns >0.
  - * @deffunc int apr_strnatcasecmp(char const *a, char const *b)
    */
   APR_DECLARE(int) apr_strnatcasecmp(char const *a, char const *b);
   
  @@ -122,7 +124,6 @@
    * @param p The pool to allocate out of
    * @param s The string to duplicate
    * @return The new string
  - * @deffunc char *apr_pstrdup(apr_pool_t *p, const char *s)
    */
   APR_DECLARE(char *) apr_pstrdup(apr_pool_t *p, const char *s);
   
  @@ -133,7 +134,6 @@
    * @param s The string to duplicate
    * @param n The number of characters to duplicate
    * @return The new string
  - * @deffunc char *apr_pstrndup(apr_pool_t *p, const char *s, apr_size_t n)
    */
   APR_DECLARE(char *) apr_pstrndup(apr_pool_t *p, const char *s, apr_size_t n);
   
  @@ -144,7 +144,6 @@
    * @param m The memory to duplicate
    * @param n The number of bytes to duplicate
    * @return The new block of memory
  - * @deffunc void *apr_pmemdup(apr_pool_t *p, const void *m, apr_size_t n)
    */
   APR_DECLARE(void *) apr_pmemdup(apr_pool_t *p, const void *m, apr_size_t n);
   
  @@ -153,7 +152,6 @@
    * @param p The pool to allocate out of
    * @param ... The strings to concatenate.  The final string must be NULL
    * @return The new string
  - * @deffunc char *apr_pstrcat(apr_pool_t *p, ...)
    */
   APR_DECLARE_NONSTD(char *) apr_pstrcat(apr_pool_t *p, ...);
   
  @@ -164,7 +162,6 @@
    * @param fmt The format of the string
    * @param ap The arguments to use while printing the data
    * @return The new string
  - * @deffunc char *apr_pvsprintf(apr_pool_t *p, const char *fmt, va_list ap)
    */
   APR_DECLARE(char *) apr_pvsprintf(apr_pool_t *p, const char *fmt, va_list ap);
   
  @@ -175,7 +172,6 @@
    * @param fmt The format of the string
    * @param ... The arguments to use while printing the data
    * @return The new string
  - * @deffunc char *apr_psprintf(apr_pool_t *p, const char *fmt, ...)
    */
   APR_DECLARE_NONSTD(char *) apr_psprintf(apr_pool_t *p, const char *fmt, ...)
           __attribute__((format(printf,2,3)));
  @@ -188,7 +184,7 @@
    *                 null-termination, so if src is longer than
    *                 dst_size, the actual number of characters copied is
    *                 dst_size - 1.
  - * @tip  
  + * @remark
    * <PRE>
    * We re-implement this function to implement these specific changes:
    *       1) strncpy() doesn't always null terminate and we want it to.
  @@ -198,7 +194,6 @@
    *          destination string, we return a pointer to the terminating '\0'
    *          to allow us to check for truncation.
    * </PRE>
  - * @deffunc char *apr_cpystrn(char *dst, const char *src, apr_size_t dst_size)
    */
   APR_DECLARE(char *) apr_cpystrn(char *dst, const char *src,
                                   apr_size_t dst_size);
  @@ -208,7 +203,6 @@
    * @param dest The destination string.  It is okay to modify the string
    *             in place.  Namely dest == src
    * @param src The string to rid the spaces from.
  - * @deffunc char *apr_collapse_spaces(char *dest, const char *src)
    */
   APR_DECLARE(char *) apr_collapse_spaces(char *dest, const char *src);
   
  @@ -218,7 +212,6 @@
    * @param str The arguments to convert
    * @param argv_out Output location.  This is a pointer to an array of strings.
    * @param token_context Pool to use.
  - * @deffunc apr_status_t apr_tokenize_to_argv(const char *arg_str, char ***argv_out, apr_pool_t
*token_context);
    */
   APR_DECLARE(apr_status_t) apr_tokenize_to_argv(const char *arg_str,
                                                  char ***argv_out,
  @@ -234,11 +227,13 @@
    * @param sep The set of delimiters
    * @param last Internal state saved by apr_strtok() between calls.
    * @return The next token from the string
  - * @deffunc char *apr_strtok(char *str, const char *sep, char **last)
    */
   APR_DECLARE(char *) apr_strtok(char *str, const char *sep, char **last);
   
  -/*
  +/**
  + * @defgroup APR_Strings_Snprintf snprintf implementations
  + *
  + * @warning
    * These are snprintf implementations based on apr_vformatter().
    *
    * Note that various standards and implementations disagree on the return
  @@ -253,6 +248,7 @@
    * In no event does apr_snprintf return a negative number.  It's not possible
    * to distinguish between an output which was truncated, and an output which
    * exactly filled the buffer.
  + * @{
    */
   
   /**
  @@ -262,7 +258,6 @@
    * @param len The size of the buffer
    * @param format The format string
    * @param ... The arguments to use to fill out the format string.
  - * @deffunc int apr_snprintf(char *buf, apr_size_t len, const char *format, ...)
    */
   APR_DECLARE_NONSTD(int) apr_snprintf(char *buf, apr_size_t len,
                                        const char *format, ...)
  @@ -275,17 +270,16 @@
    * @param len The size of the buffer
    * @param format The format string
    * @param ap The arguments to use to fill out the format string.
  - * @deffunc int apr_vsnprintf(char *buf, apr_size_t len, const char *format, va_list ap)
    */
   APR_DECLARE(int) apr_vsnprintf(char *buf, apr_size_t len, const char *format,
                                  va_list ap);
   
  +/** @} */
   /**
    * create a string representation of an int, allocated from a pool
    * @param p The pool from which to allocate
    * @param n The number to format
    * @return The string representation of the number
  - * @deffunc int apr_itoa(apr_pool_t *p, int n)
    */
   APR_DECLARE(char *) apr_itoa(apr_pool_t *p, int n);
   
  @@ -294,7 +288,6 @@
    * @param p The pool from which to allocate
    * @param n The number to format
    * @return The string representation of the number
  - * @deffunc int apr_ltoa(apr_pool_t *p, long n)
    */
   APR_DECLARE(char *) apr_ltoa(apr_pool_t *p, long n);
   
  @@ -303,7 +296,6 @@
    * @param p The pool from which to allocate
    * @param n The number to format
    * @return The string representation of the number
  - * @deffunc int apr_ltoa(apr_pool_t *p, apr_off_t n)
    */
   APR_DECLARE(char *) apr_off_t_toa(apr_pool_t *p, apr_off_t n);
   
  @@ -313,11 +305,10 @@
    * @param size The size to format
    * @param buf The 5 byte text buffer (counting the trailing null)
    * @return The buf passed to apr_strfsize()
  - * @deffunc char *apr_strfsize(apr_off_t size, char *buf)
  - * @tip All negative sizes report '  - ', apr_strfsize only formats positive values.
  + * @remark All negative sizes report '  - ', apr_strfsize only formats positive values.
    */
   APR_DECLARE(char *) apr_strfsize(apr_off_t size, char *buf);
  -
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.23      +49 -60    apr/include/apr_tables.h
  
  Index: apr_tables.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_tables.h,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- apr_tables.h	2001/08/15 21:02:53	1.22
  +++ apr_tables.h	2001/08/24 17:55:45	1.23
  @@ -71,18 +71,24 @@
    */
   
   /**
  - * @package APR Table library
  + * @file apr_tables.h
  + * @brief APR Table library
    */
  -
  -/*
  +/**
  + * @defgroup APR_Table Table routines
  + * @ingroup APR
  + *
    * Memory allocation stuff, like pools, arrays, and tables.  Pools
    * and tables are opaque structures to applications, but arrays are
    * published.
  + * @{
    */
  +/** the table abstract data type */
   typedef struct apr_table_t apr_table_t;
  -typedef struct apr_array_header_t apr_array_header_t;
   
   /** An opaque array type */
  +typedef struct apr_array_header_t apr_array_header_t;
  +
   struct apr_array_header_t {
       /** The pool the array is allocated out of */
       apr_pool_t *pool;
  @@ -130,7 +136,6 @@
    * Get the elements from a table
    * @param t The table
    * @return An array containing the contents of the table
  - * @deffunc apr_array_header_t *apr_table_elts(apr_table_t *t)
    */
   #define apr_table_elts(t) ((apr_array_header_t *)(t))
   
  @@ -138,7 +143,6 @@
    * Determine if the table is empty
    * @param t The table to check
    * @return True if empty, Falso otherwise
  - * @deffunc int apr_is_empty_table(apr_table_t *t)
    */
   #define apr_is_empty_table(t) (((t) == NULL) \
                                  || (((apr_array_header_t *)(t))->nelts == 0))
  @@ -149,7 +153,6 @@
    * @param nelts the number of elements in the initial array
    * @param elt_size The size of each element in the array.
    * @return The new array
  - * @deffunc apr_array_header_t *apr_array_make(apr_pool_t *p, int nelts, int elt_size)
    */
   APR_DECLARE(apr_array_header_t *) apr_array_make(apr_pool_t *p,
                                                    int nelts, int elt_size);
  @@ -158,9 +161,8 @@
    * Add a new element to an array
    * @param arr The array to add an element to.
    * @return Location for the new element in the array.
  - * @tip If there are no free spots in the array, then this function will
  - *      allocate new space for the new element.
  - * @deffunc void *apr_array_push(apr_array_header_t *arr)
  + * @remark If there are no free spots in the array, then this function will
  + *         allocate new space for the new element.
    */
   APR_DECLARE(void *) apr_array_push(apr_array_header_t *arr);
   
  @@ -169,7 +171,6 @@
    * @param dst The destination array, and the one to go first in the combined 
    *            array
    * @param src The source array to add to the destination array
  - * @deffunc void apr_array_cat(apr_array_header_t *dst, const apr_array_header_t *src)
    */
   APR_DECLARE(void) apr_array_cat(apr_array_header_t *dst,
   			        const apr_array_header_t *src);
  @@ -179,10 +180,9 @@
    * @param p The pool to allocate the copy of the array out of
    * @param arr The array to copy
    * @return An exact copy of the array passed in
  - * @deffunc apr_array_header_t *apr_array_copy(apr_pool_t *p, const apr_array_header_t
*arr)
  - * @tip The alternate apr_array_copy_hdr copies only the header, and arranges 
  - * for the elements to be copied if (and only if) the code subsequently does 
  - * a push or arraycat.
  + * @remark The alternate apr_array_copy_hdr copies only the header, and arranges 
  + *         for the elements to be copied if (and only if) the code subsequently
  + *         does a push or arraycat.
    */
   APR_DECLARE(apr_array_header_t *) apr_array_copy(apr_pool_t *p,
                                         const apr_array_header_t *arr);
  @@ -192,8 +192,7 @@
    * @param p The pool to allocate the copy of the array out of
    * @param arr The array to copy
    * @return An exact copy of the array passed in
  - * @deffunc apr_array_header_t *apr_array_copy_hdr(apr_pool_t *p, const apr_array_header_t
*arr)
  - * @tip The alternate apr_array_copy copies the *entire* array.
  + * @remark The alternate apr_array_copy copies the *entire* array.
    */
   APR_DECLARE(apr_array_header_t *) apr_array_copy_hdr(apr_pool_t *p,
                                         const apr_array_header_t *arr);
  @@ -204,7 +203,6 @@
    * @param first The array to put first in the new array.
    * @param second The array to put second in the new array.
    * @param return A new array containing the data from the two arrays passed in.
  - * @deffunc apr_array_header_t *apr_array_append(apr_pool_t *p, const apr_array_header_t
*first, const apr_array_header_t *second)
   */
   APR_DECLARE(apr_array_header_t *) apr_array_append(apr_pool_t *p,
                                         const apr_array_header_t *first,
  @@ -220,7 +218,6 @@
    * @param arr The array to generate the string from
    * @param sep The separator to use
    * @return A string containing all of the data in the array.
  - * @deffunc char *apr_array_pstrcat(apr_pool_t *p, const apr_array_header_t *arr, const
char sep)
    */
   APR_DECLARE(char *) apr_array_pstrcat(apr_pool_t *p,
   				      const apr_array_header_t *arr,
  @@ -232,7 +229,6 @@
    * @param nelts The number of elements in the initial table.
    * @return The new table.
    * @warning This table can only store text data
  - * @deffunc apr_table_t *apr_table_make(apr_pool_t *p, int nelts)
    */
   APR_DECLARE(apr_table_t *) apr_table_make(apr_pool_t *p, int nelts);
   
  @@ -241,7 +237,6 @@
    * @param p The pool to allocate the new table out of
    * @param t The table to copy
    * @return A copy of the table passed in
  - * @deffunc apr_table_t *apr_table_copy(apr_pool_t *p, const apr_table_t *t)
    */
   APR_DECLARE(apr_table_t *) apr_table_copy(apr_pool_t *p,
                                             const apr_table_t *t);
  @@ -249,7 +244,6 @@
   /**
    * Delete all of the elements from a table
    * @param t The table to clear
  - * @deffunc void apr_table_clear(apr_table_t *t)
    */
   APR_DECLARE(void) apr_table_clear(apr_table_t *t);
   
  @@ -259,7 +253,6 @@
    * @param t The table to search for the key
    * @param key The key to search for
    * @return The value associated with the key
  - * @deffunc const char *apr_table_get(const apr_table_t *t, const char *key)
    */
   APR_DECLARE(const char *) apr_table_get(const apr_table_t *t, const char *key);
   
  @@ -269,9 +262,8 @@
    * @param t The table to add the data to.
    * @param key The key fo use
    * @param val The value to add
  - * @tip When adding data, this function makes a copy of both the key and the
  - *      value.
  - * @deffunc void apr_table_set(apr_table_t *t, const char *key, const char *val)
  + * @remark When adding data, this function makes a copy of both the key and the
  + *         value.
    */
   APR_DECLARE(void) apr_table_set(apr_table_t *t, const char *key,
                                   const char *val);
  @@ -282,10 +274,9 @@
    * @param t The table to add the data to.
    * @param key The key fo use
    * @param val The value to add
  - * @tip When adding data, this function does not make a copy of the key or the
  - *      value, so care should be taken to ensure that the values will not 
  - *      change after they have been added..
  - * @deffunc void apr_table_setn(apr_table_t *t, const char *key, const char *val)
  + * @warning When adding data, this function does not make a copy of the key or 
  + *          the value, so care should be taken to ensure that the values will 
  + *          not change after they have been added..
    */
   APR_DECLARE(void) apr_table_setn(apr_table_t *t, const char *key,
                                    const char *val);
  @@ -294,7 +285,6 @@
    * Remove data from the table
    * @param t The table to remove data from
    * @param key The key of the data being removed
  - * @deffunc void apr_table_unset(apr_table_t *t, const char *key)
    */
   APR_DECLARE(void) apr_table_unset(apr_table_t *t, const char *key);
   
  @@ -304,8 +294,7 @@
    * @param t The table to search for the data
    * @param key The key to merge data for
    * @param val The data to add
  - * @tip If the key is not found, then this function acts like apr_table_add
  - * @deffunc void apr_table_merge(apr_table_t *t, const char *key, const char *val)
  + * @remark If the key is not found, then this function acts like apr_table_add
    */
   APR_DECLARE(void) apr_table_merge(apr_table_t *t, const char *key,
                                     const char *val);
  @@ -316,8 +305,7 @@
    * @param t The table to search for the data
    * @param key The key to merge data for
    * @param val The data to add
  - * @tip If the key is not found, then this function acts like apr_table_addn
  - * @deffunc void apr_table_mergen(apr_table_t *t, const char *key, const char *val)
  + * @remark If the key is not found, then this function acts like apr_table_addn
    */
   APR_DECLARE(void) apr_table_mergen(apr_table_t *t, const char *key,
                                      const char *val);
  @@ -328,9 +316,8 @@
    * @param t The table to add to
    * @param key The key to use
    * @param val The value to add.
  - * @tip When adding data, this function makes a copy of both the key and the
  - *      value.
  - * @deffunc void apr_table_add(apr_table_t *t, const char *key, const char *val)
  + * @remark When adding data, this function makes a copy of both the key and the
  + *         value.
    */
   APR_DECLARE(void) apr_table_add(apr_table_t *t, const char *key,
                                   const char *val);
  @@ -341,10 +328,9 @@
    * @param t The table to add to
    * @param key The key to use
    * @param val The value to add.
  - * @tip When adding data, this function does not make a copy of the key or the
  - *      value, so care should be taken to ensure that the values will not 
  - *      change after they have been added..
  - * @deffunc void apr_table_addn(apr_table_t *t, const char *key, const char *val)
  + * @remark When adding data, this function does not make a copy of the key or the
  + *         value, so care should be taken to ensure that the values will not 
  + *         change after they have been added..
    */
   APR_DECLARE(void) apr_table_addn(apr_table_t *t, const char *key,
                                    const char *val);
  @@ -355,7 +341,6 @@
    * @param overlay The first table to put in the new table
    * @param base The table to add at the end of the new table
    * @return A new table containing all of the data from the two passed in
  - * @deffunc apr_table_t *apr_table_overlay(apr_pool_t *p, const apr_table_t *overlay, const
apr_table_t *base);
    */
   APR_DECLARE(apr_table_t *) apr_table_overlay(apr_pool_t *p,
                                                const apr_table_t *overlay,
  @@ -373,7 +358,6 @@
    * @param ... The vararg.  If this is NULL, then all elements in the table are
    *            run through the function, otherwise only those whose key matches
    *            are run.
  - * @deffunc void apr_table_do(int (*comp) (void *, const char *, const char *), void *rec,
const apr_table_t *t, ...)
    */
   APR_DECLARE_NONSTD(void) apr_table_do(int (*comp)(void *, const char *, const char *),
                                void *rec, const apr_table_t *t, ...);
  @@ -390,12 +374,28 @@
    * @param vp The vararg table.  If this is NULL, then all elements in the 
    *                table are run through the function, otherwise only those 
    *                whose key matches are run.
  - * @deffunc void apr_table_vdo(int (*comp) (void *, const char *, const char *), void *rec,
const apr_table_t *t, va_list vp)
    */
   APR_DECLARE(void) apr_table_vdo(int (*comp)(void *, const char *, const char *),
                                   void *rec, const apr_table_t *t, va_list);
   
  -/* Conceptually, apr_table_overlap does this:
  +/** flag for overlap to use apr_table_setn */
  +#define APR_OVERLAP_TABLES_SET   (0)
  +/** flag for overlap to use apr_table_mergen */
  +#define APR_OVERLAP_TABLES_MERGE (1)
  +/**
  + * For each element in table b, either use setn or mergen to add the data
  + * to table a.  Which method is used is determined by the flags passed in.
  + * @param a The table to add the data to.
  + * @param b The table to iterate over, adding its data to table a
  + * @param flags How to add the table to table a.  One of:
  + *          APR_OVERLAP_TABLES_SET        Use apr_table_setn
  + *          APR_OVERLAP_TABLES_MERGE      Use apr_table_mergen
  + * @remark  This function is highly optimized, and uses less memory and CPU cycles
  + *          than a function that just loops through table b calling other functions.
  + */
  +/**
  + *<PRE>
  + * Conceptually, apr_table_overlap does this:
    *
    *  apr_array_header_t *barr = apr_table_elts(b);
    *  apr_table_entry_t *belt = (apr_table_entry_t *)barr->elts;
  @@ -416,24 +416,13 @@
    *  Notice the assumptions on the keys and values in b -- they must be
    *  in an ancestor of a's pool.  In practice b and a are usually from
    *  the same pool.
  + * </PRE>
    */
  -#define APR_OVERLAP_TABLES_SET   (0)
  -#define APR_OVERLAP_TABLES_MERGE (1)
  -/**
  - * For each element in table b, either use setn or mergen to add the data
  - * to table a.  Which method is used is determined by the flags passed in.
  - * @param a The table to add the data to.
  - * @param b The table to iterate over, adding its data to table a
  - * @param flags How to add the table to table a.  One of:
  - *          APR_OVERLAP_TABLES_SET        Use apr_table_setn
  - *          APR_OVERLAP_TABLES_MERGE      Use apr_table_mergen
  - * @tip This function is highly optimized, and uses less memory and CPU cycles
  - *      than a function that just loops through table b calling other functions.
  - * @deffunc void apr_table_overlap(apr_table_t *a, const apr_table_t *b, unsigned flags)
  - */
  +
   APR_DECLARE(void) apr_table_overlap(apr_table_t *a, const apr_table_t *b,
                                        unsigned flags);
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.41      +18 -20    apr/include/apr_time.h
  
  Index: apr_time.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_time.h,v
  retrieving revision 1.40
  retrieving revision 1.41
  diff -u -r1.40 -r1.41
  --- apr_time.h	2001/06/30 09:50:27	1.40
  +++ apr_time.h	2001/08/24 17:55:45	1.41
  @@ -62,26 +62,32 @@
   #ifdef __cplusplus
   extern "C" {
   #endif /* __cplusplus */
  -
   /**
  - * @package APR Time library
  + * @file apr_time.h
  + * @brief APR Time Library
    */
  -
  +/**
  + * @defgroup APR_Time Time Routines
  + * @ingroup APR
  + * @{
  + */
  +/** month names */
   APR_DECLARE_DATA extern const char apr_month_snames[12][4];
  +/** day names */
   APR_DECLARE_DATA extern const char apr_day_snames[7][4];
   
   
  -/* number of microseconds since 00:00:00 january 1, 1970 UTC */
  +/** number of microseconds since 00:00:00 january 1, 1970 UTC */
   typedef apr_int64_t apr_time_t;
   
   
  -/* mechanism to properly type apr_time_t literals */
  +/** mechanism to properly type apr_time_t literals */
   #define APR_TIME_C(val) APR_INT64_C(val)
   
  -/* mechanism to properly print apr_time_t values */
  +/** mechanism to properly print apr_time_t values */
   #define APR_TIME_T_FMT APR_INT64_T_FMT
   
  -/* intervals for I/O timeouts, in microseconds */
  +/** intervals for I/O timeouts, in microseconds */
   typedef apr_int64_t apr_interval_time_t;
   typedef apr_int32_t apr_short_interval_time_t;
   
  @@ -90,16 +96,16 @@
   
   /**
    * return the current time
  - * @deffunc apr_time_t apr_time_now(void)
    */
   APR_DECLARE(apr_time_t) apr_time_now(void);
   
  -typedef struct apr_exploded_time_t apr_exploded_time_t;
   /**
    * a structure similar to ANSI struct tm with the following differences:
    *  - tm_usec isn't an ANSI field
    *  - tm_gmtoff isn't an ANSI field (it's a bsdism)
    */
  +typedef struct apr_exploded_time_t apr_exploded_time_t;
  +
   struct apr_exploded_time_t {
       /** microseconds past tm_sec */
       apr_int32_t tm_usec;
  @@ -129,7 +135,6 @@
    * convert an ansi time_t to an apr_time_t
    * @param result the resulting apr_time_t
    * @param input the time_t to convert
  - * @deffunc apr_status_t apr_ansi_time_to_apr_time(apr_time_t *result, time_t input)
    */
   APR_DECLARE(apr_status_t) apr_ansi_time_to_apr_time(apr_time_t *result, 
                                                       time_t input);
  @@ -141,7 +146,6 @@
    * @param input the time to explode
    * @param offs the number of seconds offset to apply
    * @param zone the zone description
  - * @deffunc apr_status_t apr_explode_time(apr_exploded_time_t *result, apr_time_t input,
apr_int32_t offs)
    */
   APR_DECLARE(apr_status_t) apr_explode_time(apr_exploded_time_t *result,
                                              apr_time_t input,
  @@ -151,7 +155,6 @@
    * convert a time to its human readable components in GMT timezone
    * @param result the exploded time
    * @param input the time to explode
  - * @deffunc apr_status_t apr_explode_gmt(apr_exploded_time_t *result, apr_time_t input)
    */
   APR_DECLARE(apr_status_t) apr_explode_gmt(apr_exploded_time_t *result, 
                                             apr_time_t input);
  @@ -160,7 +163,6 @@
    * convert a time to its human readable components in local timezone
    * @param result the exploded time
    * @param input the time to explode
  - * @deffunc apr_status_t apr_explode_localtime(apr_exploded_time_t *result, apr_time_t
input)
    */
   APR_DECLARE(apr_status_t) apr_explode_localtime(apr_exploded_time_t *result, 
                                                   apr_time_t input);
  @@ -170,7 +172,6 @@
    * e.g. elapsed usec since epoch
    * @param result the resulting imploded time
    * @param input the input exploded time
  - * @deffunc apr_status_t apr_implode_time(apr_time_t *result, apr_exploded_time_t *input)
    */
   APR_DECLARE(apr_status_t) apr_implode_time(apr_time_t *result, 
                                              apr_exploded_time_t *input);
  @@ -180,7 +181,6 @@
    * always represents GMT
    * @param result the resulting imploded time
    * @param input the input exploded time
  - * @deffunc apr_status_t apr_implode_gmt(apr_time_t *result, apr_exploded_time_t *input)
    */
   APR_DECLARE(apr_status_t) apr_implode_gmt(apr_time_t *result, 
                                             apr_exploded_time_t *input);
  @@ -188,11 +188,11 @@
   /**
    * Sleep for the specified number of micro-seconds.
    * @param t desired amount of time to sleep.
  - * @deffunc void apr_sleep(apr_interval_time_t t)
  - * @tip May sleep for longer than the specified time. 
  + * @warning May sleep for longer than the specified time. 
    */
   APR_DECLARE(void) apr_sleep(apr_interval_time_t t);
   
  +/** length of a RFC822 Date */
   #define APR_RFC822_DATE_LEN (30)
   /**
    * apr_rfc822_date formats dates in the RFC822
  @@ -201,10 +201,10 @@
    * including trailing \0
    * @param date_str String to write to.
    * @param t the time to convert 
  - * @deffunc apr_status_t apr_rfc822_date(char *date_str, apr_time_t t)
    */
   APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);
   
  +/** length of a CTIME date */
   #define APR_CTIME_LEN (25)
   /**
    * apr_ctime formats dates in the ctime() format
  @@ -213,7 +213,6 @@
    * including trailing \0 
    * @param date_str String to write to.
    * @param t the time to convert 
  - * @deffunc apr_status_t apr_ctime(char *date_str, apr_time_t t)
    */
   APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t);
   
  @@ -224,7 +223,6 @@
    * @param max The maximum length of the string
    * @param format The format for the time string
    * @param tm The time to convert
  - * @deffunc apr_status_t apr_strftime(char *s, apr_size_t *retsize, apr_size_t max, const
char *format, apr_exploded_time_t *tm)
    */
   APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, 
                                          apr_size_t max, const char *format, 
  
  
  
  1.15      +23 -25    apr/include/apr_user.h
  
  Index: apr_user.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_user.h,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- apr_user.h	2001/07/26 21:49:32	1.14
  +++ apr_user.h	2001/08/24 17:55:45	1.15
  @@ -64,12 +64,17 @@
   #endif /* __cplusplus */
   
   /**
  - * @package APR user id services
  + * @file apr_user.h
  + * @brief APR User ID Services 
    */
  +/**
  + * @defgroup APR_User User id services
  + * @ingroup APR
  + * @{
  + */
   
   /**
    * Structure for determining user ownership.
  - * @defvar apr_uid_t
    */
   #ifdef WIN32
   typedef PSID                      apr_uid_t;
  @@ -79,7 +84,6 @@
   
   /**
    * Structure for determining group ownership.
  - * @defvar apr_gid_t
    */
   #ifdef WIN32
   typedef PSID                      apr_gid_t;
  @@ -87,60 +91,55 @@
   typedef gid_t                     apr_gid_t;
   #endif
   
  -#if APR_HAS_USER
  +#if APR_HAS_USER 
   
  -/***
  +/**
    * Get the userid (and groupid) of the calling process
    * @param userid   Returns the user id
    * @param groupid  Returns the user's group id
    * @param p The pool from which to allocate working space
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_current_userid(apr_uid_t *userid, apr_gid_t *groupid, apr_pool_t
*p)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   APR_DECLARE(apr_status_t) apr_current_userid(apr_uid_t *userid,
                                                apr_gid_t *groupid,
                                                apr_pool_t *p);
   
  -/***
  +/**
    * Get the user name for a specified userid
    * @param username Pointer to new string containing user name (on output)
    * @param userid The userid
    * @param p The pool from which to allocate the string
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_get_username(char **username, apr_uid_t userid, apr_pool_t
*p)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   APR_DECLARE(apr_status_t) apr_get_username(char **username, apr_uid_t userid, apr_pool_t
*p);
   
  -/***
  +/**
    * Get the userid (and groupid) for the specified username
    * @param userid   Returns the user id
    * @param groupid  Returns the user's group id
    * @param username The username to lookup
    * @param p The pool from which to allocate working space
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_get_userid(apr_uid_t *userid, apr_gid_t *groupid, const char
*username, apr_pool_t *p)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   APR_DECLARE(apr_status_t) apr_get_userid(apr_uid_t *userid, apr_gid_t *groupid,
                                            const char *username, apr_pool_t *p);
   
  -/***
  +/**
    * Get the home directory for the named user
    * @param dirname Pointer to new string containing directory name (on output)
    * @param username The named user
    * @param p The pool from which to allocate the string
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_get_home_directory(char **dirname, const char *username, apr_pool_t
*p)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   APR_DECLARE(apr_status_t) apr_get_home_directory(char **dirname, const char *username,
apr_pool_t *p);
   
  -/***
  +/**
    * Compare two user identifiers for equality.
    * @param left One uid to test
    * @param right Another uid to test
    * @return APR_SUCCESS if the apr_uid_t strutures identify the same user,
    * APR_EMISMATCH if not, APR_BADARG if an apr_uid_t is invalid.
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_compare_users(apr_uid_t left, apr_uid_t right)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   #if defined(WIN32)
   APR_DECLARE(apr_status_t) apr_compare_users(apr_uid_t left, apr_uid_t right);
  @@ -148,24 +147,22 @@
   #define apr_compare_users(left,right) ((left == right) ? APR_SUCCESS : APR_EMISMATCH)
   #endif
   
  -/***
  +/**
    * Get the group name for a specified groupid
    * @param dirname Pointer to new string containing group name (on output)
    * @param userid The groupid
    * @param p The pool from which to allocate the string
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_get_groupname(char **groupname, apr_gid_t userid, apr_pool_t
*p);
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   APR_DECLARE(apr_status_t) apr_get_groupname(char **groupname, apr_gid_t groupid, apr_pool_t
*p);
   
  -/***
  +/**
    * Compare two group identifiers for equality.
    * @param left One gid to test
    * @param right Another gid to test
    * @return APR_SUCCESS if the apr_gid_t strutures identify the same group,
    * APR_EMISMATCH if not, APR_BADARG if an apr_gid_t is invalid.
  - * @tip This function is available only if APR_HAS_USER is defined.
  - * @deffunc apr_status_t apr_compare_groups(apr_gid_t left, apr_gid_t right)
  + * @remark This function is available only if APR_HAS_USER is defined.
    */
   #if defined(WIN32)
   APR_DECLARE(apr_status_t) apr_compare_groups(apr_gid_t left, apr_gid_t right);
  @@ -175,6 +172,7 @@
   
   #endif  /* ! APR_HAS_USER */
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.8       +1 -1      apr/include/apr_uuid.h
  
  Index: apr_uuid.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_uuid.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- apr_uuid.h	2001/08/12 05:50:46	1.7
  +++ apr_uuid.h	2001/08/24 17:55:45	1.8
  @@ -54,7 +54,7 @@
   
   /**
    * @file apr_uuid.h
  - * @brief routines that maninpulate UUID's
  + * @brief APR UUID library
    */
   #ifndef APR_UUID_H
   #define APR_UUID_H
  
  
  
  1.7       +6 -3      apr/include/apr_want.h
  
  Index: apr_want.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_want.h,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- apr_want.h	2001/02/16 04:15:47	1.6
  +++ apr_want.h	2001/08/24 17:55:45	1.7
  @@ -53,8 +53,11 @@
    */
   
   #include "apr.h"        /* configuration data */
  -
  -/*
  +/**
  + * @file apr_want.h
  + * @brief APR_WANT_XXX documentation
  + *
  + * <PRE>
    * Features:
    *
    *   APR_WANT_STRFUNC:  strcmp, strcat, strcpy, etc
  @@ -74,6 +77,7 @@
    *
    * Note: it is safe to use this in a header (it won't interfere with other
    *       headers' or source files' use of apr_want.h)
  + * </PRE>
    */
   
   /* --------------------------------------------------------------------- */
  @@ -154,4 +158,3 @@
   #endif
   
   /* --------------------------------------------------------------------- */
  -
  
  
  
  1.16      +34 -16    apr/include/apr_xlate.h
  
  Index: apr_xlate.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_xlate.h,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- apr_xlate.h	2001/02/16 04:15:47	1.15
  +++ apr_xlate.h	2001/08/24 17:55:45	1.16
  @@ -64,10 +64,18 @@
   #endif /* __cplusplus */
   
   /**
  - * @package APR I18N translation library
  + * @file apr_xlate.h
  + * @brief APR I18N translation library
    */
   
  -/* APR_HAS_XLATE determines whether or not useful implementations of 
  +/**
  + * @defgroup APR_I18N I18N translation library
  + * @ingroup APR
  + * @{
  + */
  +
  +/**
  + * APR_HAS_XLATE determines whether or not useful implementations of 
    * apr_xlate_open() et al are provided. 
    *
    * If APR_HAS_XLATE is zero, apr_xlate_open() et al will all return 
  @@ -83,9 +91,7 @@
    * @param topage The name of the target charset
    * @param frompage The name of the source charset
    * @param pool The pool to use
  - * @deffunc apr_status_t apr_xlate_open(apr_xlate_t **convset, const char *topage, const
char *frompage, apr_pool_t *pool)
  - * @tip
  - * <PRE>
  + * @remark
    *  Specify APR_DEFAULT_CHARSET for one of the charset
    *  names to indicate the charset of the source code at
    *  compile time.  This is useful if there are literal
  @@ -95,6 +101,7 @@
    *  of the caller was not encoded in the same charset as
    *  APR at compile time.
    *
  + * @remark
    *  Specify APR_LOCALE_CHARSET for one of the charset
    *  names to indicate the charset of the current locale.
    * </PRE>
  @@ -104,7 +111,17 @@
                                            const char *frompage, 
                                            apr_pool_t *pool);
   
  +/** 
  + * This is to indicate the charset of the sourcecode at compile time
  + * names to indicate the charset of the source code at
  + * compile time.  This is useful if there are literal
  + * strings in the source code which must be translated
  + * according to the charset of the source code.
  + */
   #define APR_DEFAULT_CHARSET (const char *)0
  +/**
  + * To indicate charset names of the current locale 
  + */
   #define APR_LOCALE_CHARSET (const char *)1
   
   /**
  @@ -112,7 +129,6 @@
    * @param convset The handle allocated by apr_xlate_open, specifying the 
    *                parameters of conversion
    * @param onoff Output: whether or not the conversion is single-byte-only
  - * @deffunc apr_status_t apr_xlate_get_sb(apr_xlate_t *convset, int *onoff)
    */
   APR_DECLARE(apr_status_t) apr_xlate_get_sb(apr_xlate_t *convset, int *onoff);
   
  @@ -126,7 +142,6 @@
    * @param outbuf The address of the destination buffer
    * @param outbytes_left Input: the size of the output buffer
    *                      Output: the amount of the output buffer not yet used
  - * @deffunc apr_status_t apr_xlate_conv_buffer(apr_xlate_t *convset, const char *inbuf,
apr_size_t *inbytes_left, char *outbuf, apr_size_t *outbytes_left)
    */
   APR_DECLARE(apr_status_t) apr_xlate_conv_buffer(apr_xlate_t *convset, 
                                                   const char *inbuf, 
  @@ -134,7 +149,7 @@
                                                   char *outbuf,
                                                   apr_size_t *outbytes_left);
   
  -/* See the comment in apr_file_io.h about this hack */
  +/* @see apr_file_io.h the comment in apr_file_io.h about this hack */
   #ifdef APR_NOT_DONE_YET
   /**
    * The purpose of apr_xlate_conv_char is to translate one character
  @@ -144,7 +159,6 @@
    *                parameters of conversion
    * @param inchar The character to convert
    * @param outchar The converted character
  - * @deffunc apr_status_t apr_xlate_conv_char(apr_xlate_t *convset, char inchar, char outchar)
    */
   APR_DECLARE(apr_status_t) apr_xlate_conv_char(apr_xlate_t *convset, 
                                                 char inchar, char outchar);
  @@ -155,9 +169,8 @@
    * @param convset The handle allocated by apr_xlate_open, specifying the 
    *                parameters of conversion
    * @param inchar The single-byte character to convert.
  - * @deffunc apr_int32_t apr_xlate_conv_byte(apr_xlate_t *convset, unsigned char inchar)
  - * @tip This only works when converting between single-byte character sets.
  - *      -1 will be returned if the conversion can't be performed.
  + * @warning This only works when converting between single-byte character sets.
  + *          -1 will be returned if the conversion can't be performed.
    */
   APR_DECLARE(apr_int32_t) apr_xlate_conv_byte(apr_xlate_t *convset, 
                                                unsigned char inchar);
  @@ -165,15 +178,18 @@
   /**
    * Close a codepage translation handle.
    * @param convset The codepage translation handle to close
  - * @deffunc apr_status_t apr_xlate_close(apr_xlate_t *convset)
    */
   APR_DECLARE(apr_status_t) apr_xlate_close(apr_xlate_t *convset);
   
   #else
  -
  +/** 
  + * handle for the Translation routines
  + * (currently not implemented)
  + */
   typedef void                         apr_xlate_t;
   
  -/* For platforms where we don't bother with translating between charsets,
  +/**
  + * For platforms where we don't bother with translating between charsets,
    * these are macros which always return failure.
    */
   
  @@ -186,7 +202,8 @@
   
   #define apr_xlate_conv_byte(convset, inchar) (-1)
   
  -/* The purpose of apr_xlate_conv_char is to translate one character
  +/**
  + * The purpose of apr_xlate_conv_char is to translate one character
    * at a time.  This needs to be written carefully so that it works
    * with double-byte character sets. 
    */
  @@ -196,6 +213,7 @@
   
   #endif  /* ! APR_HAS_XLATE */
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  

Mime
View raw message