apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r..@apache.org
Subject cvs commit: apr/include apr.h.in apr.hw apr_compat.h apr_dso.h apr_file_io.h apr_fnmatch.h apr_md5.h apr_network_io.h apr_uuid.h
Date Sun, 12 Aug 2001 05:50:47 GMT
rbb         01/08/11 22:50:47

  Modified:    include  apr.h.in apr.hw apr_compat.h apr_dso.h
                        apr_file_io.h apr_fnmatch.h apr_md5.h
                        apr_network_io.h apr_uuid.h
  Log:
  Add the rest of the doxygen changes for APR.
  Submitted by:	Ian Holsman <ianh@cnet.com>
  
  Revision  Changes    Path
  1.89      +5 -1      apr/include/apr.h.in
  
  Index: apr.h.in
  ===================================================================
  RCS file: /home/cvs/apr/include/apr.h.in,v
  retrieving revision 1.88
  retrieving revision 1.89
  diff -u -r1.88 -r1.89
  --- apr.h.in	2001/07/25 18:00:57	1.88
  +++ apr.h.in	2001/08/12 05:50:46	1.89
  @@ -5,6 +5,10 @@
    * @file apr.h
    * @brief Basic APR header
    */
  +/**
  + * @defgroup APR APR Functions
  + * @{
  + */
   
   /* So that we can use inline on some critical functions, and use
    * GNUC attributes (such as to get -Wall warnings for printf-like
  @@ -291,5 +295,5 @@
   #else
   #error no decision has been made on APR_PATH_MAX for your platform
   #endif
  -
  +/** @} */
   #endif /* APR_H */
  
  
  
  1.75      +11 -0     apr/include/apr.hw
  
  Index: apr.hw
  ===================================================================
  RCS file: /home/cvs/apr/include/apr.hw,v
  retrieving revision 1.74
  retrieving revision 1.75
  diff -u -r1.74 -r1.75
  --- apr.hw	2001/07/25 18:00:57	1.74
  +++ apr.hw	2001/08/12 05:50:46	1.75
  @@ -56,6 +56,16 @@
    * Note: This is a Windows specific version of apr.h. It is copied as
    * apr.h at the start of a Windows build.
    */
  +/**
  + * @file apr.h
  + * @brief Basic APR header
  + */
  +
  +/**
  + * @defgroup APR APR Functions
  + * @{
  + */
  +
   
   #ifdef WIN32
   #ifndef APR_H
  @@ -343,3 +353,4 @@
   
   #endif /* APR_H */
   #endif /* WIN32 */
  +/** @} */
  
  
  
  1.8       +102 -1    apr/include/apr_compat.h
  
  Index: apr_compat.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_compat.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- apr_compat.h	2001/02/24 11:56:01	1.7
  +++ apr_compat.h	2001/08/12 05:50:46	1.8
  @@ -1,101 +1,202 @@
   #ifndef APR_COMPAT_H
   #define APR_COMPAT_H
  +/**
  + * @file apr_compat.h
  + * @brief APR Compatibilty Functions
  + * @deprecated These functions are only present for historical purposes
  + */
  +/**
  + * @defgroup APR_compat 1.3 Compatibility Functions
  + * @ingroup APR
  + * @{
  + */
   
   /* redefine 1.3.x symbols to those that now live in libapr */
   
  +/** @see APR_INLINE */
   #define ap_inline APR_INLINE
   
  +/** @deprecated @see apr_md5_ctx_t */
   #define ap_md5_ctx_t apr_md5_ctx_t
  +/** @deprecated @see apr_md5_encode */
   #define ap_MD5Encode apr_md5_encode
  +/** @deprecated @see apr_md5_final */
   #define ap_MD5Final apr_md5_final
  +/** @deprecated @see apr_md5_init */
   #define ap_MD5Init apr_md5_init
  +/** @deprecated @see apr_md5_update */
   #define ap_MD5Update apr_md5_update
  +/** @deprecated @see apr_array_append */
   #define ap_append_arrays apr_array_append
  +/** @deprecated @see apr_array_cat */
   #define ap_array_cat apr_array_cat
  +/** @deprecated @see apr_array_header_t */
   #define ap_array_header_t apr_array_header_t
  +/** @deprecated @see apr_array_pstrcat */
   #define ap_array_pstrcat apr_array_pstrcat
  +/** @deprecated @see apr_pool_free_blocks_num_bytes */
   #define ap_bytes_in_free_blocks apr_pool_free_blocks_num_bytes
  +/** @deprecated @see apr_pool_num_bytes */
   #define ap_bytes_in_pool apr_pool_num_bytes
  +/** @deprecated @see apr_check_file_time */
   #define ap_check_file_time apr_check_file_time
  +/** @deprecated @see apr_filetype_e */
   #define ap_filetype_e apr_filetype_e
  +/** @deprecated @see apr_pool_cleanup_for_exec */
   #define ap_cleanup_for_exec apr_pool_cleanup_for_exec
  +/** @deprecated @see apr_pool_clear */
   #define ap_clear_pool apr_pool_clear
  +/** @deprecated @see apr_table_clear */
   #define ap_clear_table apr_table_clear
  +/** @deprecated @see apr_array_copy */
   #define ap_copy_array apr_array_copy
  +/** @deprecated @see apr_array_copy_hdr */
   #define ap_copy_array_hdr apr_array_copy_hdr
  +/** @deprecated @see apr_table_copy */
   #define ap_copy_table apr_table_copy
  +/** @deprecated @see apr_cpystrn */
   #define ap_cpystrn apr_cpystrn
  +/** @deprecated @see apr_day_snames */
   #define ap_day_snames apr_day_snames
  +/** @deprecated @see apr_pool_destroy */
   #define ap_destroy_pool apr_pool_destroy
  +/** @deprecated @see apr_exploded_time_t */
   #define ap_exploded_time_t apr_exploded_time_t
  +/** @deprecated @see apr_fnmatch */
   #define ap_fnmatch apr_fnmatch
  +/** @deprecated @see apr_getopt */
   #define ap_getopt apr_getopt
  +/** @deprecated @see apr_inet_addr */
   #define ap_inet_addr apr_inet_addr
  +/** @deprecated @see apr_pool_alloc_init */
   #define ap_init_alloc apr_pool_alloc_init
  +/** @deprecated @see apr_is_empty_table */
   #define ap_is_empty_table apr_is_empty_table
  +/** @deprecated @see apr_is_fnmatch */
   #define ap_is_fnmatch apr_is_fnmatch
  +/** @deprecated @see apr_pool_cleanup_kill */
   #define ap_kill_cleanup apr_pool_cleanup_kill
  +/** @deprecated @see apr_array_make */
   #define ap_make_array apr_array_make
  +/** @deprecated @see apr_pool_sub_make */
   #define ap_make_sub_pool apr_pool_sub_make
  +/** @deprecated @see apr_table_make */
   #define ap_make_table apr_table_make
  +/** @deprecated @see apr_month_snames */
   #define ap_month_snames apr_month_snames
  +/** @deprecated @see apr_pool_note_subprocess*/
   #define ap_note_subprocess apr_pool_note_subprocess
  +/** @deprecated @see apr_pool_cleanup_null */
   #define ap_null_cleanup apr_pool_cleanup_null
  +/** @deprecated @see apr_dso_load */
   #define ap_os_dso_load apr_dso_load
  +/** @deprecated @see apr_dso_unload */
   #define ap_os_dso_unload apr_dso_unload
  +/** @deprecated @see apr_dso_sym */
   #define ap_os_dso_sym apr_dso_sym
  +/** @deprecated @see apr_dso_error */
   #define ap_os_dso_error apr_dso_error
  +/** @deprecated @see apr_proc_kill */
   #define ap_os_kill apr_proc_kill
  +/** @deprecated @see apr_table_overlap */
   #define ap_overlap_tables apr_table_overlap
  +/** @deprecated @see apr_table_overlay */
   #define ap_overlay_tables apr_table_overlay
  +/** @deprecated @see apr_palloc */
   #define ap_palloc apr_palloc
  +/** @deprecated @see apr_pcalloc */
   #define ap_pcalloc apr_pcalloc
  +/** @deprecated @see apr_pool_join */
   #define ap_pool_join apr_pool_join
  +/** @deprecated @see apr_psprintf */
   #define ap_psprintf apr_psprintf
  +/** @deprecated @see apr_pstrcat */
   #define ap_pstrcat apr_pstrcat
  +/** @deprecated @see apr_pstrdup */
   #define ap_pstrdup apr_pstrdup
  +/** @deprecated @see apr_pstrndup */
   #define ap_pstrndup apr_pstrndup
  +/** @deprecated @see apr_array_push */
   #define ap_push_array apr_array_push
  +/** @deprecated @see apr_pvsprintf */
   #define ap_pvsprintf apr_pvsprintf
  +/** @deprecated @see apr_pool_cleanup_register */
   #define ap_register_cleanup apr_pool_cleanup_register
  +/** @deprecated @see apr_proc_other_child_register */
   #define ap_register_other_child apr_proc_other_child_register
  +/** @deprecated @see apr_pool_cleanup_run */
   #define ap_run_cleanup apr_pool_cleanup_run
  +/** @deprecated @see apr_signal */
   #define ap_signal apr_signal
  +/** @deprecated @see apr_snprintf */
   #define ap_snprintf apr_snprintf
  +/** @deprecated @see apr_table_add */
   #define ap_table_add apr_table_add
  +/** @deprecated @see apr_table_addn */
   #define ap_table_addn apr_table_addn
  +/** @deprecated @see apr_table_do */
   #define ap_table_do apr_table_do
  +/** @deprecated @see apr_table_elts */
   #define ap_table_elts apr_table_elts
  +/** @deprecated @see apr_table_get */
   #define ap_table_get apr_table_get
  +/** @deprecated @see apr_table_merge */
   #define ap_table_merge apr_table_merge
  +/** @deprecated @see apr_table_mergen */
   #define ap_table_mergen apr_table_mergen
  +/** @deprecated @see apr_table_set */
   #define ap_table_set apr_table_set
  +/** @deprecated @see apr_table_setn */
   #define ap_table_setn apr_table_setn
  +/** @deprecated @see apr_table_unset */
   #define ap_table_unset apr_table_unset
  +/** @deprecated @see apr_proc_other_child_unregister */
   #define ap_unregister_other_child apr_proc_other_child_unregister
  +/** @deprecated @see apr_password_validate */
   #define ap_validate_password apr_password_validate
  +/** @deprecated @see apr_vformatter */
   #define ap_vformatter apr_vformatter
  +/** @deprecated @see apr_vsnprintf */
   #define ap_vsnprintf apr_vsnprintf
  +/** @deprecated @see apr_wait_t */
   #define ap_wait_t apr_wait_t
   
  +/** @deprecated @see apr_isalnum */
   #define ap_isalnum apr_isalnum
  +/** @deprecated @see apr_isalpha*/
   #define ap_isalpha apr_isalpha
  +/** @deprecated @see apr_iscntrl */
   #define ap_iscntrl apr_iscntrl
  +/** @deprecated @see apr_isdigit */
   #define ap_isdigit apr_isdigit
  +/** @deprecated @see apr_isgraph */
   #define ap_isgraph apr_isgraph
  +/** @deprecated @see apr_islower */
   #define ap_islower apr_islower
  +/** @deprecated @see apr_isascii */
   #define ap_isascii apr_isascii
  +/** @deprecated @see apr_isprint */
   #define ap_isprint apr_isprint
  +/** @deprecated @see apr_ispunct */
   #define ap_ispunct apr_ispunct
  +/** @deprecated @see apr_isspace */
   #define ap_isspace apr_isspace
  +/** @deprecated @see apr_isupper */
   #define ap_isupper apr_isupper
  +/** @deprecated @see apr_isxdigit */
   #define ap_isxdigit apr_isxdigit
  +/** @deprecated @see apr_tolower */
   #define ap_tolower apr_tolower
  +/** @deprecated @see apr_toupper */
   #define ap_toupper apr_toupper
   
  +/** @deprecated @see APR_USEC_PER_SEC */
   #define AP_USEC_PER_SEC APR_USEC_PER_SEC
  +/** @deprecated @see APR_RFC822_DATE_LEN */
   #define AP_RFC822_DATE_LEN APR_RFC822_DATE_LEN
  +/** @deprecated @see APR_OVERLAP_TABLES_MERGE */
   #define AP_OVERLAP_TABLES_MERGE APR_OVERLAP_TABLES_MERGE
  +/** @deprecated @see APR_OVERLAP_TABLES_SET */
   #define AP_OVERLAP_TABLES_SET APR_OVERLAP_TABLES_SET
  -
  +/** @} */
   #endif /* APR_COMPAT_H */
  
  
  
  1.29      +10 -7     apr/include/apr_dso.h
  
  Index: apr_dso.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_dso.h,v
  retrieving revision 1.28
  retrieving revision 1.29
  diff -u -r1.28 -r1.29
  --- apr_dso.h	2001/02/16 04:15:42	1.28
  +++ apr_dso.h	2001/08/12 05:50:46	1.29
  @@ -58,16 +58,23 @@
   #include "apr.h"
   #include "apr_pools.h"
   #include "apr_errno.h"
  +/**
  + * @file apr_dso.h
  + * @brief APR Dynamic Object Handling Routines
  + */
   
  +
   /**
  - * @package Dynamic Object Handling
  + * @defgroup APR_DSO Dynamic Object Handling
  + * @ingroup APR
  + * @{
    */
   
   #ifdef __cplusplus
   extern "C" {
   #endif
   
  -#if APR_HAS_DSO
  +#if APR_HAS_DSO || defined(DOXYGEN)
   
   /**
    * Structure for referencing dynamic objects
  @@ -86,7 +93,6 @@
    * @param res_handle Location to store new handle for the DSO.
    * @param path Path to the DSO library
    * @param ctx Pool to use.
  - * @deffunc apr_status_t apr_dso_load(apr_dso_handle_t **res_handle, const char *path, apr_pool_t *ctx)
    */
   APR_DECLARE(apr_status_t) apr_dso_load(apr_dso_handle_t **res_handle, 
                                          const char *path, apr_pool_t *ctx);
  @@ -94,7 +100,6 @@
   /**
    * Close a DSO library.
    * @param handle handle to close.
  - * @deffunc apr_status_t apr_dso_unload(apr_dso_handle_t *handle)
    */
   APR_DECLARE(apr_status_t) apr_dso_unload(apr_dso_handle_t *handle);
   
  @@ -103,7 +108,6 @@
    * @param ressym Location to store the loaded symbol
    * @param handle handle to load the symbol from.
    * @param symname Name of the symbol to load.
  - * @deffunc apr_status_t apr_dso_sym(apr_dso_handle_sym_t *ressym, apr_dso_handle_t *handle, const char *symname)
    */
   APR_DECLARE(apr_status_t) apr_dso_sym(apr_dso_handle_sym_t *ressym, 
                                         apr_dso_handle_t *handle,
  @@ -114,7 +118,6 @@
    * @param dso The dso handle that has been opened
    * @param buf Location to store the dso error
    * @param bufsize The size of the provided buffer
  - * @deffunc const char *apr_dso_error(apr_dso_handle_t *dso, char *buf, apr_size_t bufsize)
    */
   APR_DECLARE(const char *) apr_dso_error(apr_dso_handle_t *dso, char *buf, apr_size_t bufsize);
   
  @@ -123,5 +126,5 @@
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif
  
  
  
  1.107     +71 -88    apr/include/apr_file_io.h
  
  Index: apr_file_io.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_file_io.h,v
  retrieving revision 1.106
  retrieving revision 1.107
  diff -u -r1.106 -r1.107
  --- apr_file_io.h	2001/07/26 15:39:25	1.106
  +++ apr_file_io.h	2001/08/12 05:50:46	1.107
  @@ -54,7 +54,18 @@
   
   #ifndef APR_FILE_IO_H
   #define APR_FILE_IO_H
  +/**
  + * @file apr_file_io.h
  + * @brief APR File I/O Handling
  + */
  +/**
  + * @defgroup APR_File_IO_Handle I/O Handling Functions
  + * @ingroup APR_File_Handle
  + * @{
  + */
  +
   
  +
   #include "apr.h"
   #include "apr_pools.h"
   #include "apr_time.h"
  @@ -71,32 +82,39 @@
   #endif /* __cplusplus */
   
   /**
  - * @package APR File handling
  + * @defgroup apr_file_open File Open Flags/Routines
  + * @{
    */
   
  -/* Flags for apr_file_open */
  -#define APR_READ       1           /* Open the file for reading */
  -#define APR_WRITE      2           /* Open the file for writing */
  -#define APR_CREATE     4           /* Create the file if not there */
  -#define APR_APPEND     8           /* Append to the end of the file */
  -#define APR_TRUNCATE   16          /* Open the file and truncate to 0 length */
  -#define APR_BINARY     32          /* Open the file in binary mode */
  -#define APR_EXCL       64          /* Open should fail if APR_CREATE and file
  -				      exists. */
  -#define APR_BUFFERED   128         /* Open the file for buffered I/O */
  -#define APR_DELONCLOSE 256         /* Delete the file after close */
  -#define APR_XTHREAD    512         /* Platform dependent tag to open the file 
  -                                      for use across multiple threads */
  -#define APR_SHARELOCK  1024        /* Platform dependent support for higher
  -                                      level locked read/write access to support
  -                                      writes across process/machines */
  +#define APR_READ       1           /**< Open the file for reading */
  +#define APR_WRITE      2           /**< Open the file for writing */
  +#define APR_CREATE     4           /**< Create the file if not there */
  +#define APR_APPEND     8           /**< Append to the end of the file */
  +#define APR_TRUNCATE   16          /**< Open the file and truncate to 0 length */
  +#define APR_BINARY     32          /**< Open the file in binary mode */
  +#define APR_EXCL       64          /**< Open should fail if APR_CREATE and file
  +                                        exists. */
  +#define APR_BUFFERED   128         /**< Open the file for buffered I/O */
  +#define APR_DELONCLOSE 256         /**< Delete the file after close */
  +#define APR_XTHREAD    512         /**< Platform dependent tag to open the file
  +                                        for use across multiple threads */
  +#define APR_SHARELOCK  1024        /**< Platform dependent support for higher
  +                                        level locked read/write access to support
  +                                        writes across process/machines */
  + 
  +/** @} */
   
  +/**
  + * @defgroup APR_file_seek_flags File Seek Flags
  + * @{
  + */
  +
   /* flags for apr_file_seek */
   #define APR_SET SEEK_SET
   #define APR_CUR SEEK_CUR
   #define APR_END SEEK_END
   
  -/* should be same as whence type in lseek, POSIX defines this as int */
  +/** should be same as whence type in lseek, POSIX defines this as int */
   typedef int       apr_seek_where_t;
   
   /**
  @@ -106,21 +124,26 @@
   typedef struct apr_file_t         apr_file_t;
   
   /* File lock types/flags */
  -#define APR_FLOCK_SHARED        1       /* Shared lock. More than one process
  +/**
  + * @defgroup APR_file_lock_types File Lock Types
  + * @{
  + */
  +
  +#define APR_FLOCK_SHARED        1       /**< Shared lock. More than one process
                                              or thread can hold a shared lock
                                              at any given time. Essentially,
                                              this is a "read lock", preventing
                                              writers from establishing an
                                              exclusive lock. */
  -#define APR_FLOCK_EXCLUSIVE     2       /* Exclusive lock. Only one process
  +#define APR_FLOCK_EXCLUSIVE     2       /**< Exclusive lock. Only one process
                                              may hold an exclusive lock at any
                                              given time. This is analogous to
                                              a "write lock". */
   
  -#define APR_FLOCK_TYPEMASK      0x000F  /* mask to extract lock type */
  -#define APR_FLOCK_NONBLOCK      0x0010  /* do not block while acquiring the
  +#define APR_FLOCK_TYPEMASK      0x000F  /**< mask to extract lock type */
  +#define APR_FLOCK_NONBLOCK      0x0010  /**< do not block while acquiring the
                                              file lock */
  -
  +/** @} */
   /**
    * Open the specified file.
    * @param new_file The opened file descriptor.
  @@ -145,8 +168,8 @@
    * </PRE>
    * @param perm Access permissions for file.
    * @param cont The pool to use.
  - * @deffunc apr_status_t apr_file_open(apr_file_t **new_file, const char *fname, apr_int32_t flag, apr_fileperms_t perm, apr_pool_t *cont)
  - * @tip If perm is APR_OS_DEFAULT and the file is being created, appropriate 
  + * @ingroup apr_file_open
  + * @remark If perm is APR_OS_DEFAULT and the file is being created, appropriate 
    *      default permissions will be used.  *arg1 must point to a valid file_t, 
    *      or NULL (in which case it will be allocated)
    */
  @@ -157,7 +180,6 @@
   /**
    * Close the specified file.
    * @param file The file descriptor to close.
  - * @deffunc apr_status_t apr_file_close(apr_file_t *file)
    */
   APR_DECLARE(apr_status_t) apr_file_close(apr_file_t *file);
   
  @@ -165,8 +187,7 @@
    * delete the specified file.
    * @param path The full path to the file (using / on all systems)
    * @param cont The pool to use.
  - * @deffunc apr_status_t apr_file_remove(const char *path, apr_pool_t *cont)
  - * @tip If the file is open, it won't be removed until all instances are closed.
  + * @remark If the file is open, it won't be removed until all instances are closed.
    */
   APR_DECLARE(apr_status_t) apr_file_remove(const char *path, apr_pool_t *cont);
   
  @@ -175,9 +196,8 @@
    * @param from_path The full path to the original file (using / on all systems)
    * @param to_path The full path to the new file (using / on all systems)
    * @param pool The pool to use.
  - * @tip If a file exists at the new location, then it will be overwritten.  
  + * @warning If a file exists at the new location, then it will be overwritten.  
    *      Moving files or directories across devices may not be possible.
  - * @deffunc apr_status_t apr_file_rename(const char *from_path, const char *to_path, apr_pool_t *pool)
    */
   APR_DECLARE(apr_status_t) apr_file_rename(const char *from_path, 
                                             const char *to_path,
  @@ -186,8 +206,7 @@
   /**
    * Are we at the end of the file
    * @param fptr The apr file we are testing.
  - * @tip Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
  - * @deffunc apr_status_t apr_file_eof(apr_file_t *fptr)
  + * @remark Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
    */
   APR_DECLARE(apr_status_t) apr_file_eof(apr_file_t *fptr);
   
  @@ -195,7 +214,7 @@
    * open standard error as an apr file pointer.
    * @param thefile The apr file to use as stderr.
    * @param cont The pool to allocate the file out of.
  - * @deffunc apr_status_t apr_file_open_stderr(apr_file_t **thefile, apr_pool_t *cont)
  + * @ingroup apr_file_open
    */
   APR_DECLARE(apr_status_t) apr_file_open_stderr(apr_file_t **thefile,
                                             apr_pool_t *cont);
  @@ -204,7 +223,7 @@
    * open standard output as an apr file pointer.
    * @param thefile The apr file to use as stdout.
    * @param cont The pool to allocate the file out of.
  - * @deffunc apr_status_t apr_file_open_stdout(apr_file_t **thefile, apr_pool_t *cont)
  + * @ingroup apr_file_open
    */
   APR_DECLARE(apr_status_t) apr_file_open_stdout(apr_file_t **thefile,
                                             apr_pool_t *cont);
  @@ -213,7 +232,7 @@
    * open standard input as an apr file pointer.
    * @param thefile The apr file to use as stdin.
    * @param cont The pool to allocate the file out of.
  - * @deffunc apr_status_t apr_file_open_stdin(apr_file_t **thefile, apr_pool_t *cont)
  + * @ingroup apr_file_open
    */
   APR_DECLARE(apr_status_t) apr_file_open_stdin(apr_file_t **thefile,
                                                 apr_pool_t *cont);
  @@ -223,17 +242,17 @@
    * @param thefile The file descriptor to read from.
    * @param buf The buffer to store the data to.
    * @param nbytes On entry, the number of bytes to read; on exit, the number of bytes read.
  - * @tip apr_file_read will read up to the specified number of bytes, but never 
  - *      more.  If there isn't enough data to fill that number of bytes, all 
  - *      of the available data is read.  The third argument is modified to 
  - *      reflect the number of bytes read.  If a char was put back into the 
  - *      stream via ungetc, it will be the first character returned. 
  + * @remark apr_file_read will read up to the specified number of bytes, but 
  + *         never more.  If there isn't enough data to fill that number of 
  + *         bytes, all of the available data is read.  The third argument is 
  + *         modified to reflect the number of bytes read.  If a char was put 
  + *         back into the stream via ungetc, it will be the first character 
  + *         returned. 
    *
  - *      It is not possible for both bytes to be read and an APR_EOF or other 
  - *      error to be returned.
  + *         It is not possible for both bytes to be read and an APR_EOF or other 
  + *         error to be returned.
    *
  - *      APR_EINTR is never returned.
  - * @deffunc apr_status_t apr_file_read(apr_file_t *thefile, void *buf, apr_size_t *nbytes)
  + *         APR_EINTR is never returned.
    */
   APR_DECLARE(apr_status_t) apr_file_read(apr_file_t *thefile, void *buf,
                                      apr_size_t *nbytes);
  @@ -244,7 +263,7 @@
    * @param buf The buffer which contains the data.
    * @param nbytes On entry, the number of bytes to write; on exit, the number 
    *               of bytes written.
  - * @tip apr_file_write will write up to the specified number of bytes, but never 
  + * @remark apr_file_write will write up to the specified number of bytes, but never 
    *      more.  If the OS cannot write that many bytes, it will write as many 
    *      as it can.  The third argument is modified to reflect the * number 
    *      of bytes written. 
  @@ -252,7 +271,6 @@
    *      It is possible for both bytes to be written and an error to be returned.
    *
    *      APR_EINTR is never returned.
  - * @deffunc apr_status_t apr_file_write(apr_file_t *thefile, const void *buf, apr_size_t *nbytes)
    */
   APR_DECLARE(apr_status_t) apr_file_write(apr_file_t *thefile, const void *buf,
                                       apr_size_t *nbytes);
  @@ -265,13 +283,12 @@
    *             be smaller than APR_MAX_IOVEC_SIZE.  If it isn't, the function 
    *             will fail with APR_EINVAL.
    * @param nbytes The number of bytes written.
  - * @tip It is possible for both bytes to be written and an error to be returned.
  + * @remark It is possible for both bytes to be written and an error to be returned.
    *      APR_EINTR is never returned.
    *
    *      apr_file_writev is available even if the underlying operating system 
    *
    *      doesn't provide writev().
  - * @deffunc apr_status_t apr_file_writev(apr_file_t *thefile, const struct iovec *vec, apr_size_t nvec, apr_size_t *nbytes)
    */
   APR_DECLARE(apr_status_t) apr_file_writev(apr_file_t *thefile,
                                        const struct iovec *vec,
  @@ -284,7 +301,7 @@
    * @param buf The buffer to store the data to.
    * @param nbytes The number of bytes to read.
    * @param bytes_read If non-NULL, this will contain the number of bytes read.
  - * @tip apr_file_read will read up to the specified number of bytes, but never 
  + * @remark apr_file_read will read up to the specified number of bytes, but never 
    *      more.  If there isn't enough data to fill that number of bytes, 
    *      then the process/thread will block until it is available or EOF 
    *      is reached.  If a char was put back into the stream via ungetc, 
  @@ -294,7 +311,6 @@
    *      error to be returned.
    *
    *      APR_EINTR is never returned.
  - * @deffunc apr_status_t apr_file_read_full(apr_file_t *thefile, void *buf, apr_size_t nbytes, apr_size_t *bytes_read)
    */
   APR_DECLARE(apr_status_t) apr_file_read_full(apr_file_t *thefile, void *buf,
                                           apr_size_t nbytes,
  @@ -307,7 +323,7 @@
    * @param buf The buffer which contains the data.
    * @param nbytes The number of bytes to write.
    * @param bytes_written If non-NULL, this will contain the number of bytes written.
  - * @tip apr_file_write will write up to the specified number of bytes, but never 
  + * @remark apr_file_write will write up to the specified number of bytes, but never 
    *      more.  If the OS cannot write that many bytes, the process/thread 
    *      will block until they can be written. Exceptional error such as 
    *      "out of space" or "pipe closed" will terminate with an error.
  @@ -315,7 +331,6 @@
    *      It is possible for both bytes to be written and an error to be returned.
    *
    *      APR_EINTR is never returned.
  - * @deffunc apr_status_t apr_file_write_full(apr_file_t *thefile, const void *buf, apr_size_t nbytes, apr_size_t *bytes_written)
    */
   APR_DECLARE(apr_status_t) apr_file_write_full(apr_file_t *thefile, const void *buf,
                                            apr_size_t nbytes, 
  @@ -325,7 +340,6 @@
    * put a character into the specified file.
    * @param ch The character to write.
    * @param thefile The file descriptor to write to
  - * @deffunc apr_status_t apr_file_putc(char ch, apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_putc(char ch, apr_file_t *thefile);
   
  @@ -333,7 +347,6 @@
    * get a character from the specified file.
    * @param ch The character to write.
    * @param thefile The file descriptor to write to
  - * @deffunc apr_status_t apr_file_getc(char *ch, apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_getc(char *ch, apr_file_t *thefile);
   
  @@ -341,7 +354,6 @@
    * put a character back onto a specified stream.
    * @param ch The character to write.
    * @param thefile The file descriptor to write to
  - * @deffunc apr_status_t apr_file_ungetc(char ch, apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_ungetc(char ch, apr_file_t *thefile);
   
  @@ -350,7 +362,6 @@
    * @param str The buffer to store the string in. 
    * @param len The length of the string
    * @param thefile The file descriptor to read from
  - * @deffunc apr_status_t apr_file_gets(char *str, int len, apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t *thefile);
   
  @@ -358,14 +369,12 @@
    * Put the string into a specified file.
    * @param str The string to write. 
    * @param thefile The file descriptor to write to
  - * @deffunc apr_status_t apr_file_puts(const char *str, apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_puts(const char *str, apr_file_t *thefile);
   
   /**
    * Flush the file's buffer.
    * @param thefile The file descriptor to flush
  - * @deffunc apr_status_t apr_file_flush(apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_flush(apr_file_t *thefile);
   
  @@ -374,8 +383,7 @@
    * @param new_file The structure to duplicate into. 
    * @param old_file The file to duplicate.
    * @param p The pool to use for the new file.
  - * @tip *arg1 must point to a valid apr_file_t, or point to NULL
  - * @deffunc apr_status_t apr_file_dup(apr_file_t **new_file, apr_file_t *old_file, apr_pool_t *p)
  + * @remark *arg1 must point to a valid apr_file_t, or point to NULL
    */         
   APR_DECLARE(apr_status_t) apr_file_dup(apr_file_t **new_file,
                                         apr_file_t *old_file,
  @@ -391,9 +399,8 @@
    *            APR_END  --  add the offset to the current file size 
    * </PRE>
    * @param offset The offset to move the pointer to.
  - * @tip The third argument is modified to be the offset the pointer
  + * @remark The third argument is modified to be the offset the pointer
             was actually moved to.
  - * @deffunc apr_status_t apr_file_seek(apr_file_t *thefile, apr_seek_where_t where, apr_off_t *offset)
    */
   APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile, 
                                      apr_seek_where_t where,
  @@ -404,7 +411,6 @@
    * @param in The file descriptor to use as input to the pipe.
    * @param out The file descriptor to use as output from the pipe.
    * @param cont The pool to operate on.
  - * @deffunc apr_status_t apr_file_pipe_create(apr_file_t **in, apr_file_t **out, apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, apr_file_t **out,
                                             apr_pool_t *cont);
  @@ -414,7 +420,6 @@
    * @param filename The filename of the named pipe
    * @param perm The permissions for the newly created pipe.
    * @param cont The pool to operate on.
  - * @deffunc apr_status_t apr_file_namedpipe_create(const char *filename, apr_fileperms_t perm, apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_file_namedpipe_create(const char *filename, 
                                                  apr_fileperms_t perm, 
  @@ -424,7 +429,6 @@
    * Get the timeout value for a pipe or manipulate the blocking state.
    * @param thepipe The pipe we are getting a timeout for.
    * @param timeout The current timeout value in microseconds. 
  - * @deffunc apr_status_t apr_file_pipe_timeout_get(apr_file_t *thepipe, apr_interval_time_t *timeout)
    */
   APR_DECLARE(apr_status_t) apr_file_pipe_timeout_get(apr_file_t *thepipe, 
                                                  apr_interval_time_t *timeout);
  @@ -434,7 +438,6 @@
    * @param thepipe The pipe we are setting a timeout on.
    * @param timeout The timeout value in microseconds.  Values < 0 mean wait 
    *        forever, 0 means do not wait at all.
  - * @deffunc apr_status_t apr_file_pipe_timeout_set(apr_file_t *thepipe, apr_interval_time_t timeout)
    */
   APR_DECLARE(apr_status_t) apr_file_pipe_timeout_set(apr_file_t *thepipe, 
                                                  apr_interval_time_t timeout);
  @@ -449,14 +452,12 @@
    * block.
    * @param thefile The file to lock.
    * @param type The type of lock to establish on the file.
  - * @deffunc apr_status_t apr_file_lock(apr_file_t *thefile, int type)
    */
   APR_DECLARE(apr_status_t) apr_file_lock(apr_file_t *thefile, int type);
   
   /**
    * Remove any outstanding locks on the file.
    * @param thefile The file to unlock.
  - * @deffunc apr_status_t apr_file_unlock(apr_file_t *thefile)
    */
   APR_DECLARE(apr_status_t) apr_file_unlock(apr_file_t *thefile);
   
  @@ -466,7 +467,6 @@
    * return the file name of the current file.
    * @param new_path The path of the file.  
    * @param thefile The currently open file.
  - * @deffunc apr_status_t apr_file_name_get(const char **new_path, apr_file_t *thefile)
    */                     
   APR_DECLARE(apr_status_t) apr_file_name_get(const char **new_path, 
                                              apr_file_t *thefile);
  @@ -476,7 +476,6 @@
    * @param data The user data associated with the file.  
    * @param key The key to use for retreiving data associated with this file.
    * @param file The currently open file.
  - * @deffunc apr_status_t apr_file_data_get(void **data, const char *key, apr_file_t *file)
    */                     
   APR_DECLARE(apr_status_t) apr_file_data_get(void **data, const char *key, 
                                              apr_file_t *file);
  @@ -487,7 +486,6 @@
    * @param data The user data to associate with the file.  
    * @param key The key to use for assocaiteing data with the file.
    * @param cleanup The cleanup routine to use when the file is destroyed.
  - * @deffunc apr_status_t apr_file_data_set(apr_file_t *file, void *data, const char *key, apr_status_t (*cleanup)(void *))
    */                     
   APR_DECLARE(apr_status_t) apr_file_data_set(apr_file_t *file, void *data,
                                              const char *key,
  @@ -499,7 +497,6 @@
    * @param format The format string
    * @param ... The values to substitute in the format string
    * @return The number of bytes written
  - * @deffunc int apr_file_printf(apr_file_t *fptr, const char *format, ...)
    */ 
   APR_DECLARE_NONSTD(int) apr_file_printf(apr_file_t *fptr, const char *format, ...)
           __attribute__((format(printf,2,3)));
  @@ -508,12 +505,11 @@
    * set the specified file's permission bits.
    * @param fname The file (name) to apply the permissions to.
    * @param perms The permission bits to apply to the file.
  - * @tip Some platforms may not be able to apply all of the available 
  + * @warning Some platforms may not be able to apply all of the available 
    *      permission bits; APR_INCOMPLETE will be returned if some permissions 
    *      are specified which could not be set.
    *
    *      Platforms which do not implement this feature will return APR_ENOTIMPL.
  - * @deffunc apr_status_t apr_file_perms_set(const char *fname, apr_fileperms_t perms)
    */
   APR_DECLARE(apr_status_t) apr_file_perms_set(const char *fname,
                                              apr_fileperms_t perms);
  @@ -523,7 +519,6 @@
    * @param path the path for the directory to be created.  (use / on all systems)
    * @param perm Permissions for the new direcoty.
    * @param cont the pool to use.
  - * @deffunc apr_status_t apr_dir_make(const char *path, apr_fileperms_t perm, apr_pool_t *cont)
    */                        
   APR_DECLARE(apr_status_t) apr_dir_make(const char *path, apr_fileperms_t perm, 
                           apr_pool_t *cont);
  @@ -532,7 +527,6 @@
    * Remove directory from the file system.
    * @param path the path for the directory to be removed.  (use / on all systems)
    * @param cont the pool to use.
  - * @deffunc apr_status_t apr_dir_remove(const char *path, apr_pool_t *cont)
    */                        
   APR_DECLARE(apr_status_t) apr_dir_remove(const char *path, apr_pool_t *cont);
   
  @@ -541,7 +535,6 @@
    * @param finfo Where to store the information about the file.
    * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values 
    * @param thefile The file to get information about.
  - * @deffunc apr_status_t apr_file_info_get(apr_finfo_t *finfo, apr_int32_t wanted, apr_file_t *thefile)
    */ 
   APR_DECLARE(apr_status_t) apr_file_info_get(apr_finfo_t *finfo, 
                                             apr_int32_t wanted,
  @@ -559,33 +552,23 @@
    * Retrieve the flags that were passed into apr_file_open()
    * when the file was opened.
    * @return apr_int32_t the flags
  - * @deffunc apr_int32_t apr_file_flags_get(apr_file_t *f)
    */
   APR_DECLARE(apr_int32_t) apr_file_flags_get(apr_file_t *f);
   
   /**
    * Get the pool used by the file.
    * @return apr_pool_t the pool
  - * @deffunc apr_pool_t apr_file_pool_get(apr_file_t *f)
    */
  -APR_POOL_DECLARE_ACCESSOR(file);
  -
  -/**
  - * Set a file to be inherited by child processes.
  - * @param file The file to enable inheritance.
  - * @deffunc void apr_file_set_inherit(apr_file_t *file)
  - */
   APR_DECLARE(void) apr_file_set_inherit(apr_file_t *file);
   
   /**
    * Unset a file from being inherited by child processes.
    * @param file The file to disable inheritance.
  - * @deffunc void apr_file_unset_inherit(apr_file_t *file)
    */
   APR_DECLARE(void) apr_file_unset_inherit(apr_file_t *file);
   
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif  /* ! APR_FILE_IO_H */
  
  
  
  1.15      +18 -14    apr/include/apr_fnmatch.h
  
  Index: apr_fnmatch.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_fnmatch.h,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- apr_fnmatch.h	2001/01/18 20:07:19	1.14
  +++ apr_fnmatch.h	2001/08/12 05:50:46	1.15
  @@ -37,24 +37,30 @@
   #ifndef	_APR_FNMATCH_H_
   #define	_APR_FNMATCH_H_
   
  +/**
  + * @file apr_fnmatch.h
  + * @brief APR FNMatch Functions
  + */
  +/**
  + * @defgroup APR_FNMatch FNMatch Functions
  + * @ingroup APR
  + * @{
  + */
  +
   #include "apr_errno.h"
   
   #ifdef __cplusplus
   extern "C" {
   #endif
   
  -/**
  - * @package Fnmatch functions 
  - */
  -
  -#define	FNM_NOMATCH	1	/* Match failed. */
  +#define    FNM_NOMATCH    1    /**< Match failed. */
  + 
  +#define    FNM_NOESCAPE    0x01    /**< Disable backslash escaping. */
  +#define    FNM_PATHNAME    0x02    /**< Slash must be matched by slash. */
  +#define    FNM_PERIOD    0x04    /**< Period must be matched by period. */
  + 
  +#define FNM_CASE_BLIND  0x08    /**< Compare characters case-insensitively.  @remark This flag is an Apache addition */
   
  -#define	FNM_NOESCAPE	0x01	/* Disable backslash escaping. */
  -#define	FNM_PATHNAME	0x02	/* Slash must be matched by slash. */
  -#define	FNM_PERIOD	0x04	/* Period must be matched by period. */
  -/* This flag is an Apache addition */
  -#define FNM_CASE_BLIND  0x08    /* Compare characters case-insensitively. */
  -
   /**
    * Try to match the string to the given pattern.
    * @param pattern The pattern to match to
  @@ -66,7 +72,6 @@
    *              FNM_PERIOD         Period must be matched by period
    *              FNM_CASE_BLIND     Compare characters case-insensitively.
    * </PRE>
  - * @deffunc apr_status_t apr_fnmatch(const char *pattern, const char *strings, int flags)
    */
   
   APR_DECLARE(apr_status_t) apr_fnmatch(const char *pattern, 
  @@ -76,12 +81,11 @@
    * Determine if the given pattern is a regular expression.
    * @param pattern The pattern to search for glob characters.
    * @return non-zero if pattern has any glob characters in it
  - * @deffunc int apr_is_fnmatch(const char *pattern)
    */
   APR_DECLARE(int) apr_is_fnmatch(const char *pattern);
   
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif /* !_FNMATCH_H_ */
  
  
  
  1.26      +8 -7      apr/include/apr_md5.h
  
  Index: apr_md5.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_md5.h,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- apr_md5.h	2001/06/04 18:11:02	1.25
  +++ apr_md5.h	2001/08/12 05:50:46	1.26
  @@ -91,9 +91,15 @@
   #ifdef __cplusplus
   extern "C" {
   #endif
  +/**
  + * @file apr_md5.h
  + * @brief APR MD5 Routines
  + */
   
   /**
  - * @package APR MD5 Library
  + * @defgroup APR_MD5 MD5 Routines
  + * @ingroup APR
  + * @{
    */
   
   #define MD5_DIGESTSIZE 16
  @@ -117,7 +123,6 @@
   /**
    * MD5 Initialize.  Begins an MD5 operation, writing a new context.
    * @param context The MD5 context to initialize.
  - * @deffunc apr_status_t apr_md5_init(apr_md5_ctx_t *context)
    */
   APR_DECLARE(apr_status_t) apr_md5_init(apr_md5_ctx_t *context);
   
  @@ -126,7 +131,6 @@
    * for translating the content before calculating the digest.
    * @param context The MD5 content to set the translation for.
    * @param xlate The translation handle to use for this MD5 context 
  - * @deffunc apr_status_t apr_md5_set_xlate(apr_md5_ctx_t *context, apr_xlate_t *xlate)
    */
   #if APR_HAS_XLATE
   APR_DECLARE(apr_status_t) apr_md5_set_xlate(apr_md5_ctx_t *context,
  @@ -141,7 +145,6 @@
    * @param context The MD5 content to update.
    * @param input next message block to update
    * @param inputLen The length of the next message block
  - * @deffunc apr_status_t apr_md5_update(apr_md5_ctx_t *context, apr_size_t char *input, unsigned int inputLen)
    */
   APR_DECLARE(apr_status_t) apr_md5_update(apr_md5_ctx_t *context,
                                            const unsigned char *input,
  @@ -152,7 +155,6 @@
    * message digest and zeroing the context
    * @param digest The final MD5 digest
    * @param context The MD5 content we are finalizing.
  - * @deffunc apr_status_t apr_md5_final(unsigned char digest[MD5_DIGESTSIZE], apr_md5_ctx_t *context)
    */
   APR_DECLARE(apr_status_t) apr_md5_final(unsigned char digest[MD5_DIGESTSIZE],
                                           apr_md5_ctx_t *context);
  @@ -162,7 +164,6 @@
    * @param digest The final MD5 digest
    * @param input The message block to use
    * @param inputLen The length of the message block
  - * @deffunc apr_status_t apr_md5(unsigned char digest[MD5_DIGESTSIZE], const unsigned char *input, apr_size_t size);
    */
   APR_DECLARE(apr_status_t) apr_md5(unsigned char digest[MD5_DIGESTSIZE],
                                     const unsigned char *input,
  @@ -174,11 +175,11 @@
    * @param salt The salt to use for the encoding
    * @param result The string to store the encoded password in
    * @param nbytes The length of the string
  - * @deffunc apr_status_t apr_md5_encode(const char *password, const char *salt, char *result, size_t nbytes)
    */
   APR_DECLARE(apr_status_t) apr_md5_encode(const char *password, const char *salt,
                                            char *result, size_t nbytes);
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.110     +50 -63    apr/include/apr_network_io.h
  
  Index: apr_network_io.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_network_io.h,v
  retrieving revision 1.109
  retrieving revision 1.110
  diff -u -r1.109 -r1.110
  --- apr_network_io.h	2001/08/08 19:11:25	1.109
  +++ apr_network_io.h	2001/08/12 05:50:46	1.110
  @@ -54,9 +54,14 @@
   
   #ifndef APR_NETWORK_IO_H
   #define APR_NETWORK_IO_H
  -
  +/**
  + * @file apr_network_io.h
  + * @brief APR Network library
  + */
   /**
  - * @package APR Network library
  + * @defgroup APR_Net Network Routines
  + * @ingroup APR
  + * @{
    */
   
   #include "apr.h"
  @@ -85,7 +90,10 @@
   #define APR_ANYADDR "0.0.0.0"
   #endif
   
  -/* Socket option definitions */
  +/**
  + * @defgroup Sock_opt Socket option definitions
  + * @{
  + */
   #define APR_SO_LINGER        1
   #define APR_SO_KEEPALIVE     2
   #define APR_SO_DEBUG         4
  @@ -97,13 +105,13 @@
   #define APR_SO_DISCONNECTED  256
   #define APR_TCP_NODELAY      512
   #define APR_TCP_NOPUSH       1024
  -#define APR_RESET_NODELAY    2048 /* This flag is ONLY set internally
  +#define APR_RESET_NODELAY    2048 /**< This flag is ONLY set internally
                                      * when we set APR_TCP_NOPUSH with
                                      * APR_TCP_NODELAY set to tell us that
                                      * APR_TCP_NODELAY should be turned on
                                      * again when NOPUSH is turned off
                                      */
  -#define APR_INCOMPLETE_READ 4096  /* Set on non-blocking sockets
  +#define APR_INCOMPLETE_READ 4096  /**< Set on non-blocking sockets
   				   * (APR_SO_TIMEOUT != 0) on which the
   				   * previous read() did not fill a buffer
   				   * completely.  the next apr_recv() will
  @@ -121,23 +129,30 @@
   #define APR_POLLERR   0x010
   #define APR_POLLHUP   0x020
   #define APR_POLLNVAL  0x040
  +/** @} */
   
   typedef enum {APR_SHUTDOWN_READ, APR_SHUTDOWN_WRITE, 
   	      APR_SHUTDOWN_READWRITE} apr_shutdown_how_e;
   
  -/* We need to make sure we always have an in_addr type, so APR will just
  +#if (!APR_HAVE_IN_ADDR)
  +/**
  + * We need to make sure we always have an in_addr type, so APR will just
    * define it ourselves, if the platform doesn't provide it.
    */
  -#if (!APR_HAVE_IN_ADDR)
   struct in_addr {
  -    apr_uint32_t  s_addr;
  +    apr_uint32_t  s_addr; /**< storage to hold the IP# */
   }
   #endif
   
  -/* Not all platforms have these defined, so we'll define them here
  +/**
  + * @def APR_INET
  + * Not all platforms have these defined, so we'll define them here
    * The default values come from FreeBSD 4.1.1
    */
   #define APR_INET     AF_INET
  +/** @def APR_UNSPEC
  + * Let the system decide which address family to use
  + */
   #ifdef AF_UNSPEC
   #define APR_UNSPEC   AF_UNSPEC
   #else
  @@ -147,7 +162,9 @@
   #define APR_INET6    AF_INET6
   #endif
   
  -/* Enum to tell us if we're interested in remote or local socket */
  +/**
  + * Enum to tell us if we're interested in remote or local socket
  + */
   typedef enum {
       APR_LOCAL,
       APR_REMOTE
  @@ -160,25 +177,31 @@
   #if APR_HAVE_INET_ADDR
   #define apr_inet_addr    inet_addr
   #elif APR_HAVE_INET_NETWORK        /* only DGUX, as far as I know */
  -/* not generally safe... inet_network() and inet_addr() perform
  +/**
  + * @warning
  + * not generally safe... inet_network() and inet_addr() perform
    * different functions */
   #define apr_inet_addr    inet_network
   #endif
   
   typedef struct apr_socket_t     apr_socket_t;
   typedef struct apr_pollfd_t     apr_pollfd_t;
  +/**
  + * A structure to encapsulate headers and trailers for apr_sendfile
  + */
   typedef struct apr_hdtr_t       apr_hdtr_t;
   typedef struct in_addr          apr_in_addr_t;
   
  -/* use apr_uint16_t just in case some system has a short that isn't 16 bits... */
  +/** @remark use apr_uint16_t just in case some system has a short that isn't 16 bits... */
   typedef apr_uint16_t            apr_port_t;
   
   /* It's defined here as I think it should all be platform safe...
    */
  -typedef struct apr_sockaddr_t apr_sockaddr_t;
   /**
    * APRs socket address type, used to ensure protocol independence
    */
  +typedef struct apr_sockaddr_t apr_sockaddr_t;
  +
   struct apr_sockaddr_t {
       /** The pool to use... */
       apr_pool_t *pool;
  @@ -253,7 +276,6 @@
    * @param family The address family of the socket (e.g., APR_INET).
    * @param type The type of the socket (e.g., SOCK_STREAM).
    * @param cont The pool to use
  - * @deffunc apr_status_t apr_socket_create(apr_socket_t **new_sock, int family, int type, apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock, 
                                               int family, int type,
  @@ -268,8 +290,7 @@
    *            APR_SHUTDOWN_WRITE        no longer allow write requests
    *            APR_SHUTDOWN_READWRITE    no longer allow read or write requests 
    * </PRE>
  - * @deffunc apr_status_t apr_shutdown(apr_socket_t *thesocket, apr_shutdown_how_e how)
  - * @tip This does not actually close the socket descriptor, it just
  + * @remark This does not actually close the socket descriptor, it just
    *      controls which calls are still valid on the socket.
    */
   APR_DECLARE(apr_status_t) apr_shutdown(apr_socket_t *thesocket,
  @@ -278,7 +299,6 @@
   /**
    * Close a tcp socket.
    * @param thesocket The socket to close 
  - * @deffunc apr_status_t apr_socket_close(apr_socket_t *thesocket)
    */
   APR_DECLARE(apr_status_t) apr_socket_close(apr_socket_t *thesocket);
   
  @@ -286,9 +306,8 @@
    * Bind the socket to its associated port
    * @param sock The socket to bind 
    * @param sa The socket address to bind to
  - * @tip This may be where we will find out if there is any other process
  + * @remark This may be where we will find out if there is any other process
    *      using the selected port.
  - * @deffunc apr_status_t apr_bind(apr_socket_t *sock, apr_sockaddr_t *sa)
    */
   APR_DECLARE(apr_status_t) apr_bind(apr_socket_t *sock, apr_sockaddr_t *sa);
   
  @@ -298,7 +317,6 @@
    * @param backlog The number of outstanding connections allowed in the sockets
    *                listen queue.  If this value is less than zero, the listen
    *                queue size is set to zero.  
  - * @deffunc apr_status_t apr_listen(apr_socket_t *sock, apr_int32_t backlog)
    */
   APR_DECLARE(apr_status_t) apr_listen(apr_socket_t *sock, apr_int32_t backlog);
   
  @@ -309,7 +327,6 @@
    *                 be used for all future communication.
    * @param sock The socket we are listening on.
    * @param connection_pool The pool for the new socket.
  - * @deffunc apr_status_t apr_accept(apr_socket_t **new_sock, apr_socket_t *sock, apr_pool_t *connection_pool)
    */
   APR_DECLARE(apr_status_t) apr_accept(apr_socket_t **new_sock, 
                                        apr_socket_t *sock,
  @@ -322,7 +339,6 @@
    * @param sa The address of the machine we wish to connect to.  If NULL,
    *           APR assumes that the sockaddr_in in the apr_socket is 
    *           completely filled out.
  - * @deffunc apr_status_t apr_connect(apr_socket_t *sock, apr_sockaddr_t *sa)
    */
   APR_DECLARE(apr_status_t) apr_connect(apr_socket_t *sock, apr_sockaddr_t *sa);
   
  @@ -335,7 +351,6 @@
    * @param port The port number.
    * @param flags Special processing flags.
    * @param p The pool for the apr_sockaddr_t and associated storage.
  - * @deffunc apr_status_t apr_sockaddr_info_get(apr_sockaddr_t **sa, const char *hostname, apr_int32_t family, apr_port_t port, apr_int32_t flags, apr_pool_t *p)
    */
   APR_DECLARE(apr_status_t) apr_sockaddr_info_get(apr_sockaddr_t **sa,
                                             const char *hostname,
  @@ -349,7 +364,6 @@
    * @param hostname The hostname.
    * @param sa The apr_sockaddr_t.
    * @param flags Special processing flags.
  - * @deffunc apr_status_t apr_getnameinfo(char **hostname, apr_sockaddr_t *sa, apr_int32_t flags)
    */
   APR_DECLARE(apr_status_t) apr_getnameinfo(char **hostname,
                                             apr_sockaddr_t *sa,
  @@ -378,10 +392,10 @@
    *             specified.
    * @param str The input string to be parsed.
    * @param p The pool from which *addr and *scope_id are allocated.
  - * @tip If scope id shouldn't be allowed, check for scope_id != NULL in addition 
  - *      to checking the return code.  If addr/hostname should be required, check 
  - *      for addr == NULL in addition to checking the return code.
  - * @deffunc apr_status_t apr_parse_addr_port(char **addr, char **scope_id, apr_port_t *port, const char *str, apr_pool_t *p)
  + * @remark If scope id shouldn't be allowed, check for scope_id != NULL in 
  + *         addition to checking the return code.  If addr/hostname should be 
  + *         required, check for addr == NULL in addition to checking the 
  + *         return code.
    */
   APR_DECLARE(apr_status_t) apr_parse_addr_port(char **addr,
                                                 char **scope_id,
  @@ -395,7 +409,6 @@
    * @param len The maximum length of the hostname that can be stored in the
    *            buffer provided. 
    * @param cont The pool to use.
  - * @deffunc apr_status_t apr_gethostname(char *buf, int len, apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_gethostname(char *buf, int len, apr_pool_t *cont);
   
  @@ -404,7 +417,6 @@
    * @param data The user data associated with the socket.
    * @param key The key to associate with the user data.
    * @param sock The currently open socket.
  - * @deffunc apr_status_t apr_socket_data_get(void **data, const char *key, apr_socket_t *sock)
    */
   APR_DECLARE(apr_status_t) apr_socket_data_get(void **data, const char *key,
                                                apr_socket_t *sock);
  @@ -415,7 +427,6 @@
    * @param data The user data to associate with the socket.
    * @param key The key to associate with the data.
    * @param cleanup The cleanup to call when the socket is destroyed.
  - * @deffunc apr_status_t apr_socket_data_set(apr_socket_t *sock, void *data, const char *key, apr_status_t (*cleanup)(void*))
    */
   APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data,
                                                const char *key,
  @@ -427,8 +438,7 @@
    * @param buf The buffer which contains the data to be sent. 
    * @param len On entry, the number of bytes to send; on exit, the number
    *            of bytes sent.
  - * @deffunc apr_status_t apr_send(apr_socket_t *sock, const char *buf, apr_size_t *len)
  - * @tip
  + * @remark
    * <PRE>
    * This functions acts like a blocking write by default.  To change 
    * this behavior, use apr_setsocketopt with the APR_SO_TIMEOUT option.
  @@ -447,8 +457,7 @@
    * @param vec The array of iovec structs containing the data to send 
    * @param nvec The number of iovec structs in the array
    * @param len Receives the number of bytes actually written
  - * @deffunc apr_status_t apr_sendv(apr_socket_t *sock, const struct iovec *vec, apr_int32_t nvec, apr_size_t *len)
  - * @tip
  + * @remark
    * <PRE>
    * This functions acts like a blocking write by default.  To change 
    * this behavior, use apr_setsocketopt with the APR_SO_TIMEOUT option.
  @@ -497,10 +506,9 @@
    *            (output) - Number of bytes actually sent, 
    *                       including headers, file, and trailers
    * @param flags APR flags that are mapped to OS specific flags
  - * @deffunc apr_status_t apr_sendfile(apr_socket_t *sock, apr_file_t *file, apr_hdtr_t *hdtr, apr_off_t *offset, apr_size_t *len, apr_int32_t flags)
  - * @tip This functions acts like a blocking write by default.  To change 
  - *      this behavior, use apr_setsocketopt with the APR_SO_TIMEOUT option.
  - *      The number of bytes actually sent is stored in argument 5.
  + * @remark This functions acts like a blocking write by default.  To change 
  + *         this behavior, use apr_setsocketopt with the APR_SO_TIMEOUT option.
  + *         The number of bytes actually sent is stored in argument 5.
    */
   APR_DECLARE(apr_status_t) apr_sendfile(apr_socket_t *sock, apr_file_t *file,
                                          apr_hdtr_t *hdtr, apr_off_t *offset,
  @@ -514,8 +522,7 @@
    * @param buf The buffer to store the data in. 
    * @param len On entry, the number of bytes to receive; on exit, the number
    *            of bytes received.
  - * @deffunc apr_status_t apr_recv(apr_socket_t *sock, char *buf, apr_size_t *len)
  - * @tip
  + * @remark
    * <PRE>
    * This functions acts like a blocking read by default.  To change 
    * this behavior, use apr_setsocketopt with the APR_SO_TIMEOUT option.
  @@ -549,7 +556,6 @@
    *            APR_SO_RCVBUF     --  Set the ReceiveBufferSize
    * </PRE>
    * @param on Value for the option.
  - * @deffunc apr_status_t apr_setsocketopt(apr_socket_t *sock, apr_int32_t opt, apr_int32_t on)
    */
   APR_DECLARE(apr_status_t) apr_setsocketopt(apr_socket_t *sock,
                                              apr_int32_t opt, apr_int32_t on);
  @@ -575,7 +581,6 @@
    *                                  (Currently only used on Windows)
    * </PRE>
    * @param on Socket option returned on the call.
  - * @deffunc apr_status_t apr_getsocketopt(apr_socket_t *sock, apr_int32_t opt, apr_int32_t *on)
    */
   APR_DECLARE(apr_status_t) apr_getsocketopt(apr_socket_t *sock, 
                                              apr_int32_t opt, apr_int32_t *on);
  @@ -585,7 +590,6 @@
    * @param sa The returned apr_sockaddr_t.
    * @param which Which interface do we want the apr_sockaddr_t for?
    * @param sock The socket to use
  - * @deffunc apr_status_t apr_socket_addr_get(apr_sockaddr_t **sa, apr_interface_e which, apr_socket_t *sock)
    */
   APR_DECLARE(apr_status_t) apr_socket_addr_get(apr_sockaddr_t **sa,
                                              apr_interface_e which,
  @@ -595,7 +599,6 @@
    * Set the port in an APR socket address.
    * @param sockaddr The socket address to set.
    * @param port The port to be stored in the socket address.
  - * @deffunc apr_status_t apr_sockaddr_port_set(apr_sockaddr_t *sockaddr, apr_port_t port)
    */
   APR_DECLARE(apr_status_t) apr_sockaddr_port_set(apr_sockaddr_t *sockaddr,
                                          apr_port_t port);
  @@ -604,7 +607,6 @@
    * Return the port in an APR socket address.
    * @param port The port from the socket address.
    * @param sockaddr The socket address to reference.
  - * @deffunc apr_status_t apr_sockaddr_port_get(apr_port_t *port, apr_sockaddr_t *sockaddr)
    */
   APR_DECLARE(apr_status_t) apr_sockaddr_port_get(apr_port_t *port,
                                          apr_sockaddr_t *sockaddr);
  @@ -614,7 +616,6 @@
    * @param sockaddr The socket address to use 
    * @param addr The IP address to attach to the socket.
    *             Use APR_ANYADDR to use any IP addr on the machine.
  - * @deffunc apr_status_t apr_sockaddr_ip_set(apr_sockaddr_t *sockaddr, const char *addr)
    */
   APR_DECLARE(apr_status_t) apr_sockaddr_ip_set(apr_sockaddr_t *sockaddr,
                                            const char *addr);
  @@ -624,7 +625,6 @@
    * an APR socket address.
    * @param addr The IP address.
    * @param sockaddr The socket address to reference.
  - * @deffunc apr_status_t apr_sockaddr_ip_get(char **addr, apr_sockaddr_t *sockaddr)
    */
   APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr, 
                                            apr_sockaddr_t *sockaddr);
  @@ -634,7 +634,6 @@
    * @param new_poll The poll structure to be used. 
    * @param num The number of socket descriptors to be polled.
    * @param cont The pool to operate on.
  - * @deffunc apr_status_t apr_poll_setup(apr_pollfd_t **new_poll, apr_int32_t num, apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_poll_setup(apr_pollfd_t **new_poll, 
                                            apr_int32_t num,
  @@ -648,14 +647,13 @@
    *                a maximum, not a minimum.  If a socket is signalled, we 
    *                will wake up before this time.  A negative number means 
    *                wait until a socket is signalled.
  - * @tip
  + * @remark
    * <PRE>
    * The number of sockets signalled is returned in the second argument. 
    *
    *        This is a blocking call, and it will not return until either a 
    *        socket has been signalled, or the timeout has expired. 
    * </PRE>
  - * @deffunc apr_status_t apr_poll(apr_pollfd_t *aprset, apr_int32_t *nsds, apr_interval_time_t timeout)
    */
   APR_DECLARE(apr_status_t) apr_poll(apr_pollfd_t *aprset, apr_int32_t *nsds, 
                                      apr_interval_time_t timeout);
  @@ -670,7 +668,6 @@
    *            APR_POLLPRI      signal if prioirty data is availble to be read
    *            APR_POLLOUT      signal if write will not block
    * </PRE>
  - * @deffunc apr_status_t apr_poll_socket_add(apr_pollfd_t *aprset, apr_socket_t *sock, apr_int16_t event)
    */
   APR_DECLARE(apr_status_t) apr_poll_socket_add(apr_pollfd_t *aprset, 
                                                 apr_socket_t *sock,
  @@ -686,7 +683,6 @@
    *            APR_POLLPRI      signal if prioirty data is availble to be read
    *            APR_POLLOUT      signal if write will not block
    * </PRE>
  - * @deffunc apr_status_t apr_poll_socket_mask(apr_pollfd_t *aprset, apr_socket_t *sock, apr_int16_t events)
    */
   APR_DECLARE(apr_status_t) apr_poll_socket_mask(apr_pollfd_t *aprset,
                                                  apr_socket_t *sock,
  @@ -695,7 +691,6 @@
    * Remove a socket from the poll structure.
    * @param aprset The poll structure we will be using. 
    * @param sock The socket to remove from the current poll structure. 
  - * @deffunc apr_status_t apr_poll_socket_remove(apr_pollfd_t *aprset, apr_socket_t *sock)
    */
   APR_DECLARE(apr_status_t) apr_poll_socket_remove(apr_pollfd_t *aprset, 
                                                    apr_socket_t *sock);
  @@ -709,7 +704,6 @@
    *            APR_POLLPRI      signal if prioirty data is availble to be read
    *            APR_POLLOUT      signal if write will not block
    * </PRE>
  - * @deffunc apr_status_t apr_poll_socket_clear(apr_pollfd_t *aprset, apr_int16_t events)
    */
   APR_DECLARE(apr_status_t) apr_poll_socket_clear(apr_pollfd_t *aprset, 
                                                    apr_int16_t events);
  @@ -728,7 +722,6 @@
    * </PRE>
    * @param sock The socket we wish to get information about. 
    * @param aprset The poll structure we will be using. 
  - * @deffunc apr_status_t apr_poll_revents_get(apr_int16_t *event, apr_socket_t *sock, apr_pollfd_t *aprset)
    */
   APR_DECLARE(apr_status_t) apr_poll_revents_get(apr_int16_t *event, 
                                             apr_socket_t *sock,
  @@ -739,7 +732,6 @@
    * @param pollfd The currently open pollfd.
    * @param key The key to use for retreiving data associated with a poll struct.
    * @param data The user data associated with the pollfd.
  - * @deffunc apr_status_t apr_poll_data_get(apr_pollfd_t *pollfd, const char *key, void *data)
    */
   APR_DECLARE(apr_status_t) apr_poll_data_get(apr_pollfd_t *pollfd, 
                                              const char *key, void *data);
  @@ -750,7 +742,6 @@
    * @param data The key to associate with the data.
    * @param key The user data to associate with the pollfd.
    * @param cleanup The cleanup function
  - * @deffunc apr_status_t apr_poll_data_set(apr_pollfd_t *pollfd, void *data, const char *key, apr_status_t (*cleanup)(void *))
    */
   APR_DECLARE(apr_status_t) apr_poll_data_set(apr_pollfd_t *pollfd, void *data,
                                              const char *key,
  @@ -762,7 +753,6 @@
    * Convert a File type to a socket so that it can be used in a poll operation.
    * @param newsock the newly created socket which represents a file.
    * @param file the file to mask as a socket.
  - * @deffunc apr_status_t apr_socket_from_file(apr_socket_t **newsock, apr_file_t *file)
    * @warning This is not available on all platforms.  Platforms that have the
    *      ability to poll files for data to be read/written/exceptions will
    *      have the APR_FILES_AS_SOCKETS macro defined as true.
  @@ -776,7 +766,6 @@
    * Given an apr_sockaddr_t and a service name, set the port for the service
    * @param sockaddr The apr_sockaddr_t that will have it's port set
    * @param servname The name of the service you wish to use
  - * @deffunc apr_status_t apr_getservbyname(apr_sockaddr_t *sockaddr, const char *servname)
    */
   APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, 
                                               const char *servname);
  @@ -816,20 +805,18 @@
   /**
    * Set a socket to be inherited by child processes.
    * @param socket The socket to enable inheritance.
  - * @deffunc void apr_socket_set_inherit(apr_socket_t *socket)
    */
   APR_DECLARE(void) apr_socket_set_inherit(apr_socket_t *skt);
   
   /**
    * Unset a socket from being inherited by child processes.
    * @param socket The socket to disable inheritance.
  - * @deffunc void apr_socket_unset_inherit(apr_socket_t *socket)
    */
   APR_DECLARE(void) apr_socket_unset_inherit(apr_socket_t *skt);
   
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif  /* ! APR_NETWORK_IO_H */
   
  
  
  
  1.7       +13 -6     apr/include/apr_uuid.h
  
  Index: apr_uuid.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_uuid.h,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- apr_uuid.h	2001/02/16 04:15:47	1.6
  +++ apr_uuid.h	2001/08/12 05:50:46	1.7
  @@ -52,6 +52,10 @@
    * <http://www.apache.org/>.
    */
   
  +/**
  + * @file apr_uuid.h
  + * @brief routines that maninpulate UUID's
  + */
   #ifndef APR_UUID_H
   #define APR_UUID_H
   
  @@ -62,13 +66,18 @@
   extern "C" {
   #endif /* __cplusplus */
   
  +/**
  + * @defgroup APR_UUID UUID Handling
  + * @ingroup APR
  + * @{
  + */
  +
   /**
  - * @package APR UUID Handling
  + * we represent a UUID as a block of 16 bytes.
    */
   
  -/* we represent a UUID as a block of 16 bytes. */
   typedef struct {
  -    unsigned char data[16];
  +    unsigned char data[16]; /**< the actual UUID */
   } apr_uuid_t;
   
   /* UUIDs are formatted as: 00112233-4455-6677-8899-AABBCCDDEEFF */
  @@ -78,7 +87,6 @@
   /**
    * Generate and return a (new) UUID
    * @param uuid The resulting UUID
  - * @deffunc void apr_uuid_get(apr_uuid_t *uuid)
    */ 
   APR_DECLARE(void) apr_uuid_get(apr_uuid_t *uuid);
   
  @@ -88,7 +96,6 @@
    *               be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold
    *               the formatted UUID and a null terminator
    * @param uuid The UUID to format
  - * @deffunc void apr_uuid_format(char *buffer, const apr_uuid_t *uuid)
    */ 
   APR_DECLARE(void) apr_uuid_format(char *buffer, const apr_uuid_t *uuid);
   
  @@ -96,10 +103,10 @@
    * Parse a standard-format string into a UUID
    * @param uuid The resulting UUID
    * @param uuid_str The formatted UUID
  - * @deffunc apr_status_t apr_uuid_parse(apr_uuid_t *uuid, const char *uuid_str)
    */ 
   APR_DECLARE(apr_status_t) apr_uuid_parse(apr_uuid_t *uuid, const char *uuid_str);
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  

Mime
View raw message