diff options
| author | Ivan Zhakov <ivan@apache.org> | 2022-11-19 16:12:13 +0000 |
|---|---|---|
| committer | Ivan Zhakov <ivan@apache.org> | 2022-11-19 16:12:13 +0000 |
| commit | ddf6aa4327df4eee8b481a222c2635ba000471c3 (patch) | |
| tree | 0061d19699468e5d7a642b0e3a3ef9d685f88d12 | |
| parent | 8f3d73a1f9e996148291f1adb9889d5cc882a1c1 (diff) | |
| download | apr-ddf6aa4327df4eee8b481a222c2635ba000471c3.tar.gz | |
Remove trailing whitespaces.
git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@1905407 13f79535-47bb-0310-9956-ffa450edef68
80 files changed, 816 insertions, 816 deletions
diff --git a/include/apr_allocator.h b/include/apr_allocator.h index 7f65f2631..7c86db16d 100644 --- a/include/apr_allocator.h +++ b/include/apr_allocator.h @@ -33,7 +33,7 @@ extern "C" { /** * @defgroup apr_allocator Internal Memory Allocation - * @ingroup APR + * @ingroup APR * @{ */ @@ -47,7 +47,7 @@ typedef struct apr_memnode_t apr_memnode_t; * caller of apr_allocator_alloc(), the remaining fields are read-only. * The next field has to be used with caution and sensibly set when the * memnode is passed back to apr_allocator_free(). See apr_allocator_free() - * for details. + * for details. * The ref and first_avail fields will be properly restored by * apr_allocator_free(). */ @@ -103,7 +103,7 @@ APR_DECLARE(apr_memnode_t *) apr_allocator_alloc(apr_allocator_t *allocator, APR_DECLARE(void) apr_allocator_free(apr_allocator_t *allocator, apr_memnode_t *memnode) __attribute__((nonnull(1,2))); - + /** * Get the page/boundary size. * @return The page size diff --git a/include/apr_atomic.h b/include/apr_atomic.h index 7ac9aafc6..d350c0399 100644 --- a/include/apr_atomic.h +++ b/include/apr_atomic.h @@ -31,7 +31,7 @@ extern "C" { /** * @defgroup apr_atomic Atomic Operations - * @ingroup APR + * @ingroup APR * @{ */ diff --git a/include/apr_base64.h b/include/apr_base64.h index 406ca368e..0310d19b8 100644 --- a/include/apr_base64.h +++ b/include/apr_base64.h @@ -38,13 +38,13 @@ extern "C" { */ /* Simple BASE64 encode/decode functions. - * + * * As we might encode binary strings, hence we require the length of * the incoming plain source. And return the length of what we decoded. * * The decoding function takes any non valid char (i.e. whitespace, \0 * or anything non A-Z,0-9 etc) as terminal. - * + * * The handling of terminating \0 characters differs from function to * function. * @@ -56,7 +56,7 @@ extern "C" { * @param len the length of an unencoded string. * @return the length of the string after it is encoded, including the * trailing \0 - */ + */ APR_DECLARE(int) apr_base64_encode_len(int len) __attribute__((pure)); /** @@ -67,8 +67,8 @@ APR_DECLARE(int) apr_base64_encode_len(int len) __attribute__((pure)); * @param plain_src The original string in plain text * @param len_plain_src The length of the plain text string * @return the length of the encoded string, including the trailing \0 - */ -APR_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src, + */ +APR_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src, int len_plain_src) __attribute__((nonnull(1,2))); @@ -81,7 +81,7 @@ APR_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src, * @param plain_src The original string in plain text * @param len_plain_src The length of the plain text string * @return the length of the encoded string, including the trailing \0 - */ + */ APR_DECLARE(int) apr_base64_encode_binary(char * coded_dst, const unsigned char *plain_src, int len_plain_src) @@ -101,7 +101,7 @@ APR_DECLARE(char *) apr_pbase64_encode(apr_pool_t *p, const char *string) * string given the encoded string. * @param coded_src The encoded string * @return the maximum required buffer length for the plain text string - */ + */ APR_DECLARE(int) apr_base64_decode_len(const char * coded_src) __attribute__((nonnull(1))) __attribute__((pure)); @@ -110,9 +110,9 @@ APR_DECLARE(int) apr_base64_decode_len(const char * coded_src) * converted to EBCDIC. * @param plain_dst The destination string for the plain text. A \0 is * appended. - * @param coded_src The encoded string + * @param coded_src The encoded string * @return the length of the plain text string (excluding the trailing \0) - */ + */ APR_DECLARE(int) apr_base64_decode(char * plain_dst, const char *coded_src) __attribute__((nonnull(1,2))); @@ -122,10 +122,10 @@ APR_DECLARE(int) apr_base64_decode(char * plain_dst, const char *coded_src) * output to EBCDIC is left out. * @param plain_dst The destination string for the plain text. The string is * not \0-terminated. - * @param coded_src The encoded string + * @param coded_src The encoded string * @return the length of the plain text string - */ -APR_DECLARE(int) apr_base64_decode_binary(unsigned char * plain_dst, + */ +APR_DECLARE(int) apr_base64_decode_binary(unsigned char * plain_dst, const char *coded_src) __attribute__((nonnull(1,2))); diff --git a/include/apr_buckets.h b/include/apr_buckets.h index 065058316..2e522c765 100644 --- a/include/apr_buckets.h +++ b/include/apr_buckets.h @@ -47,7 +47,7 @@ extern "C" { /** * @defgroup APR_Util_Bucket_Brigades Bucket Brigades * @ingroup APR - * @{ + * @{ */ /** default bucket buffer size - 8KB minus room for memory allocator headers */ @@ -138,7 +138,7 @@ struct apr_bucket_type_t { * The name of the bucket type */ const char *name; - /** + /** * The number of functions this bucket understands. Can not be less than * five. */ @@ -173,14 +173,14 @@ struct apr_bucket_type_t { * for all bucket types. * @param b The bucket to read from * @param str A place to store the data read. Allocation should only be - * done if absolutely necessary. + * done if absolutely necessary. * @param len The amount of data read. * @param block Should this read function block if there is more data that * cannot be read immediately. */ - apr_status_t (*read)(apr_bucket *b, const char **str, apr_size_t *len, + apr_status_t (*read)(apr_bucket *b, const char **str, apr_size_t *len, apr_read_type_e block); - + /** * Make it possible to set aside the data for at least as long as the * given pool. Buckets containing data that could potentially die before @@ -241,16 +241,16 @@ struct apr_bucket { * pointer. The vast majority of bucket types allow a fixed block of * data to be referenced by multiple buckets, each bucket pointing to * a different segment of the data. That segment starts at base+start - * and ends at base+start+length. + * and ends at base+start+length. * If the length == (apr_size_t)(-1), then start == -1. */ apr_off_t start; /** type-dependent data hangs off this pointer */ - void *data; + void *data; /** * Pointer to function used to free the bucket. This function should * always be defined and it should be consistent with the memory - * function used to allocate the bucket. For example, if malloc() is + * function used to allocate the bucket. For example, if malloc() is * used to allocate the bucket, this pointer should point to free(). * @param e Pointer to the bucket being freed */ @@ -262,7 +262,7 @@ struct apr_bucket { /** A list of buckets */ struct apr_bucket_brigade { /** The pool to associate the brigade with. The data is not allocated out - * of the pool, but a cleanup is registered with this pool. If the + * of the pool, but a cleanup is registered with this pool. If the * brigade is destroyed by some mechanism other than pool destruction, * the destroying function is responsible for killing the cleanup. */ @@ -671,7 +671,7 @@ APR_DECLARE(apr_bucket_brigade *) apr_brigade_create(apr_pool_t *p, /** * Destroy an entire bucket brigade. This includes destroying all of the - * buckets within the bucket brigade's bucket list. + * buckets within the bucket brigade's bucket list. * @param b The bucket brigade to destroy */ APR_DECLARE(apr_status_t) apr_brigade_destroy(apr_bucket_brigade *b) @@ -713,10 +713,10 @@ APR_DECLARE(apr_bucket_brigade *) apr_brigade_split_ex(apr_bucket_brigade *b, /** * Create a new bucket brigade and move the buckets from the tail end - * of an existing brigade into the new brigade. Buckets from + * of an existing brigade into the new brigade. Buckets from * @a e to the last bucket (inclusively) of brigade @a b * are moved from @a b to the returned brigade. - * @param b The brigade to split + * @param b The brigade to split * @param e The first bucket to move * @return The new brigade * @warning Note that this function always allocates a new brigade @@ -775,7 +775,7 @@ APR_DECLARE(apr_status_t) apr_brigade_flatten(apr_bucket_brigade *bb, * @param len On return, the length of the char array. * @param pool The pool to allocate the string from. */ -APR_DECLARE(apr_status_t) apr_brigade_pflatten(apr_bucket_brigade *bb, +APR_DECLARE(apr_status_t) apr_brigade_pflatten(apr_bucket_brigade *bb, char **c, apr_size_t *len, apr_pool_t *pool) @@ -828,7 +828,7 @@ APR_DECLARE(apr_status_t) apr_brigade_split_boundary(apr_bucket_brigade *bbOut, __attribute__((nonnull(1,2))); /** - * Create an iovec of the elements in a bucket_brigade... return number + * Create an iovec of the elements in a bucket_brigade... return number * of elements used. This is useful for writing to a file or to the * network efficiently. * @param b The bucket brigade to create the iovec from @@ -836,12 +836,12 @@ APR_DECLARE(apr_status_t) apr_brigade_split_boundary(apr_bucket_brigade *bbOut, * @param nvec The number of elements in the iovec. On return, it is the * number of iovec elements actually filled out. */ -APR_DECLARE(apr_status_t) apr_brigade_to_iovec(apr_bucket_brigade *b, +APR_DECLARE(apr_status_t) apr_brigade_to_iovec(apr_bucket_brigade *b, struct iovec *vec, int *nvec) __attribute__((nonnull(1,2,3))); /** - * This function writes a list of strings into a bucket brigade. + * This function writes a list of strings into a bucket brigade. * @param b The bucket brigade to add to * @param flush The flush function to use if the brigade is full * @param ctx The structure to pass to the flush function @@ -862,7 +862,7 @@ APR_DECLARE(apr_status_t) apr_brigade_vputstrs(apr_bucket_brigade *b, * inside a heap bucket, heap buckets are a fixed size to promote their * reuse. * - * If an attempt is made to write a string to a brigade that already + * If an attempt is made to write a string to a brigade that already * ends with a heap bucket, this function will attempt to pack the * string into the remaining space in the previous heap bucket, before * allocating a new heap bucket. @@ -942,7 +942,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_brigade_putstrs(apr_bucket_brigade *b, ; /** - * Evaluate a printf and put the resulting string at the end + * Evaluate a printf and put the resulting string at the end * of the bucket brigade. * @param b The brigade to write to * @param flush The flush function to use if the brigade is full @@ -951,7 +951,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_brigade_putstrs(apr_bucket_brigade *b, * @param ... The arguments to fill out the format * @return APR_SUCCESS or error code */ -APR_DECLARE_NONSTD(apr_status_t) apr_brigade_printf(apr_bucket_brigade *b, +APR_DECLARE_NONSTD(apr_status_t) apr_brigade_printf(apr_bucket_brigade *b, apr_brigade_flush flush, void *ctx, const char *fmt, ...) @@ -959,7 +959,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_brigade_printf(apr_bucket_brigade *b, __attribute__((nonnull(1))); /** - * Evaluate a printf and put the resulting string at the end + * Evaluate a printf and put the resulting string at the end * of the bucket brigade. * @param b The brigade to write to * @param flush The flush function to use if the brigade is full @@ -968,7 +968,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_brigade_printf(apr_bucket_brigade *b, * @param va The arguments to fill out the format * @return APR_SUCCESS or error code */ -APR_DECLARE(apr_status_t) apr_brigade_vprintf(apr_bucket_brigade *b, +APR_DECLARE(apr_status_t) apr_brigade_vprintf(apr_bucket_brigade *b, apr_brigade_flush flush, void *ctx, const char *fmt, va_list va) @@ -1168,9 +1168,9 @@ APR_DECLARE_NONSTD(void) apr_bucket_free(void *block) /** * Split one bucket in two at the point provided. - * + * * Once split, the original bucket becomes the first of the two new buckets. - * + * * (It is assumed that the bucket is a member of a brigade when this * function is called). * @param e The bucket to split @@ -1195,7 +1195,7 @@ APR_DECLARE_NONSTD(void) apr_bucket_free(void *block) * @param data The bucket to setaside * @param pool The pool defining the desired lifetime of the bucket data * @return APR_SUCCESS - */ + */ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_setaside_noop(apr_bucket *data, apr_pool_t *pool); @@ -1205,7 +1205,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_setaside_noop(apr_bucket *data, * @param data The bucket to setaside * @param pool The pool defining the desired lifetime of the bucket data * @return APR_ENOTIMPL - */ + */ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_setaside_notimpl(apr_bucket *data, apr_pool_t *pool); @@ -1215,7 +1215,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_setaside_notimpl(apr_bucket *data, * @param data The bucket to split * @param point The location to split the bucket * @return APR_ENOTIMPL - */ + */ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_split_notimpl(apr_bucket *data, apr_size_t point); @@ -1237,7 +1237,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_copy_notimpl(apr_bucket *e, * simple buckets where data points to a string and pipe buckets where data * points directly to the apr_file_t. * @param data The bucket data to destroy - */ + */ APR_DECLARE_NONSTD(void) apr_bucket_destroy_noop(void *data); /** @@ -1352,7 +1352,7 @@ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_simple_copy(apr_bucket *a, * @return The new bucket, or NULL if allocation failed */ APR_DECLARE(apr_bucket *) apr_bucket_shared_make(apr_bucket *b, void *data, - apr_off_t start, + apr_off_t start, apr_size_t length); /** @@ -1413,8 +1413,8 @@ APR_DECLARE_NONSTD(apr_status_t) apr_bucket_shared_copy(apr_bucket *a, APR_DECLARE(apr_bucket *) apr_bucket_eos_create(apr_bucket_alloc_t *list); /** - * Make the bucket passed in an EOS bucket. This indicates that there is no - * more data coming from down the filter stack. All filters should flush at + * Make the bucket passed in an EOS bucket. This indicates that there is no + * more data coming from down the filter stack. All filters should flush at * this point. * @param b The bucket to make into an EOS bucket * @return The new bucket, or NULL if allocation failed @@ -1433,8 +1433,8 @@ APR_DECLARE(apr_bucket *) apr_bucket_flush_create(apr_bucket_alloc_t *list) __attribute__((nonnull(1))); /** - * Make the bucket passed in a FLUSH bucket. This indicates that filters - * should flush their data. There is no guarantee that they will flush it, + * Make the bucket passed in a FLUSH bucket. This indicates that filters + * should flush their data. There is no guarantee that they will flush it, * but this is the best we can do. * @param b The bucket to make into a FLUSH bucket * @return The new bucket, or NULL if allocation failed @@ -1449,7 +1449,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_flush_make(apr_bucket *b) * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_immortal_create(const char *buf, +APR_DECLARE(apr_bucket *) apr_bucket_immortal_create(const char *buf, apr_size_t nbyte, apr_bucket_alloc_t *list) __attribute__((nonnull(1,3))); @@ -1461,8 +1461,8 @@ APR_DECLARE(apr_bucket *) apr_bucket_immortal_create(const char *buf, * @param nbyte The size of the data to insert. * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_immortal_make(apr_bucket *b, - const char *buf, +APR_DECLARE(apr_bucket *) apr_bucket_immortal_make(apr_bucket *b, + const char *buf, apr_size_t nbyte) __attribute__((nonnull(1,2))); @@ -1473,7 +1473,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_immortal_make(apr_bucket *b, * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_transient_create(const char *buf, +APR_DECLARE(apr_bucket *) apr_bucket_transient_create(const char *buf, apr_size_t nbyte, apr_bucket_alloc_t *list) __attribute__((nonnull(1,3))); @@ -1485,7 +1485,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_transient_create(const char *buf, * @param nbyte The size of the data to insert. * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_transient_make(apr_bucket *b, +APR_DECLARE(apr_bucket *) apr_bucket_transient_make(apr_bucket *b, const char *buf, apr_size_t nbyte) __attribute__((nonnull(1,2))); @@ -1504,7 +1504,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_transient_make(apr_bucket *b, * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_heap_create(const char *buf, +APR_DECLARE(apr_bucket *) apr_bucket_heap_create(const char *buf, apr_size_t nbyte, void (*free_func)(void *data), apr_bucket_alloc_t *list) @@ -1532,7 +1532,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_heap_make(apr_bucket *b, const char *buf, * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_pool_create(const char *buf, +APR_DECLARE(apr_bucket *) apr_bucket_pool_create(const char *buf, apr_size_t length, apr_pool_t *pool, apr_bucket_alloc_t *list) @@ -1547,7 +1547,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_pool_create(const char *buf, * @return The new bucket, or NULL if allocation failed */ APR_DECLARE(apr_bucket *) apr_bucket_pool_make(apr_bucket *b, const char *buf, - apr_size_t length, + apr_size_t length, apr_pool_t *pool) __attribute__((nonnull(1,2,4))); @@ -1561,7 +1561,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_pool_make(apr_bucket *b, const char *buf, * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_mmap_create(apr_mmap_t *mm, +APR_DECLARE(apr_bucket *) apr_bucket_mmap_create(apr_mmap_t *mm, apr_off_t start, apr_size_t length, apr_bucket_alloc_t *list) @@ -1577,7 +1577,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_mmap_create(apr_mmap_t *mm, * @return The new bucket, or NULL if allocation failed */ APR_DECLARE(apr_bucket *) apr_bucket_mmap_make(apr_bucket *b, apr_mmap_t *mm, - apr_off_t start, + apr_off_t start, apr_size_t length) __attribute__((nonnull(1,2))); #endif @@ -1597,7 +1597,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_socket_create(apr_socket_t *thissock, * @param thissock The socket to put in the bucket * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_socket_make(apr_bucket *b, +APR_DECLARE(apr_bucket *) apr_bucket_socket_make(apr_bucket *b, apr_socket_t *thissock) __attribute__((nonnull(1,2))); @@ -1617,7 +1617,7 @@ APR_DECLARE(apr_bucket *) apr_bucket_pipe_create(apr_file_t *thispipe, * @param thispipe The pipe to put in the bucket * @return The new bucket, or NULL if allocation failed */ -APR_DECLARE(apr_bucket *) apr_bucket_pipe_make(apr_bucket *b, +APR_DECLARE(apr_bucket *) apr_bucket_pipe_make(apr_bucket *b, apr_file_t *thispipe) __attribute__((nonnull(1,2))); @@ -1632,14 +1632,14 @@ APR_DECLARE(apr_bucket *) apr_bucket_pipe_make(apr_bucket *b, * @return The new bucket, or NULL if allocation failed * @remark If the file is truncated such that the segment of the file * referenced by the bucket no longer exists, an attempt to read - * from the bucket will fail with APR_EOF. + * from the bucket will fail with APR_EOF. * @remark apr_brigade_insert_file() should generally be used to * insert files into brigades, since that function can correctly * handle large file issues. */ APR_DECLARE(apr_bucket *) apr_bucket_file_create(apr_file_t *fd, apr_off_t offset, - apr_size_t len, + apr_size_t len, apr_pool_t *p, apr_bucket_alloc_t *list) __attribute__((nonnull(1,4,5))); diff --git a/include/apr_crypto.h b/include/apr_crypto.h index 7b03175f8..874cd3695 100644 --- a/include/apr_crypto.h +++ b/include/apr_crypto.h @@ -162,7 +162,7 @@ typedef struct apr_crypto_block_key_digest_t { * Types of ciphers supported by the apr_ */ typedef enum -{ +{ APR_CRYPTO_CIPHER_AUTO, /** Choose the recommended cipher / autodetect the cipher */ APR_CRYPTO_CIPHER_AES_256_CTR, /** AES 256 - CTR mode */ APR_CRYPTO_CIPHER_CHACHA20, /** ChaCha20 */ diff --git a/include/apr_date.h b/include/apr_date.h index 52a6d79da..bf322e159 100644 --- a/include/apr_date.h +++ b/include/apr_date.h @@ -74,7 +74,7 @@ APR_DECLARE(apr_time_t) apr_date_parse_http(const char *date); /** * Parses a string resembling an RFC 822 date. This is meant to be - * leinent in its parsing of dates. Hence, this will parse a wider + * leinent in its parsing of dates. Hence, this will parse a wider * range of dates than apr_date_parse_http. * * The prominent mailer (or poster, if mailer is unknown) that has @@ -86,10 +86,10 @@ APR_DECLARE(apr_time_t) apr_date_parse_http(const char *date); * Sun, 6 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123 * Sun, 06 Nov 94 08:49:37 GMT ; RFC 822 * Sun, 6 Nov 94 08:49:37 GMT ; RFC 822 - * Sun, 06 Nov 94 08:49 GMT ; Unknown [drtr\@ast.cam.ac.uk] + * Sun, 06 Nov 94 08:49 GMT ; Unknown [drtr\@ast.cam.ac.uk] * Sun, 6 Nov 94 08:49 GMT ; Unknown [drtr\@ast.cam.ac.uk] * Sun, 06 Nov 94 8:49:37 GMT ; Unknown [Elm 70.85] - * Sun, 6 Nov 94 8:49:37 GMT ; Unknown [Elm 70.85] + * Sun, 6 Nov 94 8:49:37 GMT ; Unknown [Elm 70.85] * </PRE> * * @param date The date in one of the formats above diff --git a/include/apr_dbd.h b/include/apr_dbd.h index 6b9032778..85202942a 100644 --- a/include/apr_dbd.h +++ b/include/apr_dbd.h @@ -444,7 +444,7 @@ APR_DECLARE(int) apr_dbd_pselect(const apr_dbd_driver_t *driver, apr_pool_t *poo * @param ... - varargs list * @return 0 for success or error code */ -APR_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver, +APR_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, int *nrows, apr_dbd_prepared_t *statement, ...); diff --git a/include/apr_dbm.h b/include/apr_dbm.h index 77e5be541..f9aea3b6b 100644 --- a/include/apr_dbm.h +++ b/include/apr_dbm.h @@ -32,7 +32,7 @@ extern "C" { * @file apr_dbm.h * @brief APR-UTIL DBM library */ -/** +/** * @defgroup APR_Util_DBM DBM routines * @ingroup APR * @{ @@ -111,8 +111,8 @@ APR_DECLARE(apr_status_t) apr_dbm_get_driver(const apr_dbm_driver_t **driver, * the correct case (lower case for all bundled providers) */ -APR_DECLARE(apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm, const char* type, - const char *name, +APR_DECLARE(apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm, const char* type, + const char *name, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t *cntxt); @@ -154,7 +154,7 @@ APR_DECLARE(apr_status_t) apr_dbm_open2(apr_dbm_t **pdb, * @remark The dbm name may not be a true file name, as many dbm packages * append suffixes for separate data and index files. */ -APR_DECLARE(apr_status_t) apr_dbm_open(apr_dbm_t **dbm, const char *name, +APR_DECLARE(apr_status_t) apr_dbm_open(apr_dbm_t **dbm, const char *name, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t *cntxt); @@ -166,7 +166,7 @@ APR_DECLARE(void) apr_dbm_close(apr_dbm_t *dbm); /** * Fetch a dbm record value by key - * @param dbm The database + * @param dbm The database * @param key The key datum to find this record * @param pvalue The value datum retrieved for this record */ @@ -174,16 +174,16 @@ APR_DECLARE(apr_status_t) apr_dbm_fetch(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t *pvalue); /** * Store a dbm record value by key - * @param dbm The database + * @param dbm The database * @param key The key datum to store this record by * @param value The value datum to store in this record */ -APR_DECLARE(apr_status_t) apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, +APR_DECLARE(apr_status_t) apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t value); /** * Delete a dbm record value by key - * @param dbm The database + * @param dbm The database * @param key The key datum of the record to delete * @remark It is not an error to delete a non-existent record. */ @@ -191,28 +191,28 @@ APR_DECLARE(apr_status_t) apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key); /** * Search for a key within the dbm - * @param dbm The database + * @param dbm The database * @param key The datum describing a key to test */ APR_DECLARE(int) apr_dbm_exists(apr_dbm_t *dbm, apr_datum_t key); /** * Retrieve the first record key from a dbm - * @param dbm The database + * @param dbm The database * @param pkey The key datum of the first record */ APR_DECLARE(apr_status_t) apr_dbm_firstkey(apr_dbm_t *dbm, apr_datum_t *pkey); /** * Retrieve the next record key from a dbm - * @param dbm The database + * @param dbm The database * @param pkey The key datum of the next record */ APR_DECLARE(apr_status_t) apr_dbm_nextkey(apr_dbm_t *dbm, apr_datum_t *pkey); /** * Proactively toss any memory associated with the apr_datum_t. - * @param dbm The database + * @param dbm The database * @param data The datum to free. */ APR_DECLARE(void) apr_dbm_freedatum(apr_dbm_t *dbm, apr_datum_t data); diff --git a/include/apr_dso.h b/include/apr_dso.h index ac701cfdf..a18033f01 100644 --- a/include/apr_dso.h +++ b/include/apr_dso.h @@ -32,7 +32,7 @@ extern "C" { /** * @defgroup apr_dso Dynamic Object Handling - * @ingroup APR + * @ingroup APR * @{ */ @@ -56,7 +56,7 @@ typedef void * apr_dso_handle_sym_t; * @bug We aught to provide an alternative to RTLD_GLOBAL, which * is the only supported method of loading DSOs today. */ -APR_DECLARE(apr_status_t) apr_dso_load(apr_dso_handle_t **res_handle, +APR_DECLARE(apr_status_t) apr_dso_load(apr_dso_handle_t **res_handle, const char *path, apr_pool_t *ctx); /** @@ -71,7 +71,7 @@ APR_DECLARE(apr_status_t) apr_dso_unload(apr_dso_handle_t *handle); * @param handle handle to load the symbol from. * @param symname Name of the symbol to load. */ -APR_DECLARE(apr_status_t) apr_dso_sym(apr_dso_handle_sym_t *ressym, +APR_DECLARE(apr_status_t) apr_dso_sym(apr_dso_handle_sym_t *ressym, apr_dso_handle_t *handle, const char *symname); diff --git a/include/apr_env.h b/include/apr_env.h index 85ab67041..a1e0da99b 100644 --- a/include/apr_env.h +++ b/include/apr_env.h @@ -29,7 +29,7 @@ extern "C" { /** * @defgroup apr_env Functions for manipulating the environment - * @ingroup APR + * @ingroup APR * @{ */ diff --git a/include/apr_errno.h b/include/apr_errno.h index 3a00457bc..2cdd1045d 100644 --- a/include/apr_errno.h +++ b/include/apr_errno.h @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup apr_errno Error Codes - * @ingroup APR + * @ingroup APR * @{ */ @@ -49,7 +49,7 @@ typedef int apr_status_t; * @param buf A buffer to hold the error string. * @param bufsize Size of the buffer to hold the string. */ -APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, +APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, apr_size_t bufsize); #if defined(DOXYGEN) @@ -69,7 +69,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * Fold an apr_status_t code back to the native platform defined error. * @param e The apr_status_t folded platform os error code. * @warning macro implementation; the statcode argument may be evaluated - * multiple times. If the statcode was not created by apr_get_os_error + * multiple times. If the statcode was not created by apr_get_os_error * or APR_FROM_OS_ERROR, the results are undefined. */ #define APR_TO_OS_ERROR(e) (e == 0 ? APR_SUCCESS : e - APR_OS_START_SYSERR) @@ -105,7 +105,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * @warning This is a macro implementation; the statcode argument may be evaluated * multiple times. If the statcode was not created by apr_get_os_error * or APR_FROM_OS_ERROR, the results are undefined. This macro sets - * errno, or calls a WSASetLastError() style function, unfolding + * errno, or calls a WSASetLastError() style function, unfolding * socketcode with APR_TO_OS_ERROR. */ @@ -149,7 +149,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * * In general applications should try and create unique error codes. To try * and assist in finding suitable ranges of numbers to use, the following - * ranges are known to be used by the listed applications. If your + * ranges are known to be used by the listed applications. If your * application defines error codes please advise the range of numbers it * uses to dev@apr.apache.org for inclusion in this list. * @@ -174,12 +174,12 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_OS_START_CANONERR (APR_OS_START_USERERR \ + (APR_OS_ERRSPACE_SIZE * 10)) /** - * APR_OS_START_EAIERR folds EAI_ error codes from getaddrinfo() into + * APR_OS_START_EAIERR folds EAI_ error codes from getaddrinfo() into * apr_status_t values. */ #define APR_OS_START_EAIERR (APR_OS_START_CANONERR + APR_OS_ERRSPACE_SIZE) /** - * APR_OS_START_SYSERR folds platform-specific system error values into + * APR_OS_START_SYSERR folds platform-specific system error values into * apr_status_t values. */ #define APR_OS_START_SYSERR (APR_OS_START_EAIERR + APR_OS_ERRSPACE_SIZE) @@ -190,7 +190,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * The following attempts to show the relation of the various constants * used for mapping APR Status codes. * - * 0 + * 0 * * 20,000 APR_OS_START_ERROR * @@ -224,13 +224,13 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, /** no error. */ #define APR_SUCCESS 0 -/** +/** * @defgroup APR_Error APR Error Values * <PRE> * <b>APR ERROR VALUES</b> - * APR_ENOSTAT APR was unable to perform a stat on the file + * APR_ENOSTAT APR was unable to perform a stat on the file * APR_ENOPOOL APR was not provided a pool with which to allocate memory - * APR_EBADDATE APR was given an invalid date + * APR_EBADDATE APR was given an invalid date * APR_EINVALSOCK APR was given an invalid socket * APR_ENOPROC APR was not given a process structure * APR_ENOTIME APR was not given a time structure @@ -241,7 +241,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * APR_ENOTHREAD APR was not given a thread structure * APR_ENOTHDKEY APR was not given a thread key structure * APR_ENOSHMAVAIL There is no more shared memory available - * APR_EDSOOPEN APR was unable to open the dso object. For more + * APR_EDSOOPEN APR was unable to open the dso object. For more * information call apr_dso_error(). * APR_EGENERAL General failure (specific information not available) * APR_EBADIP The specified IP address is invalid @@ -262,17 +262,17 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * APR_INCOMPLETE The operation was incomplete although some processing * was performed and the results are partially valid * APR_BADCH Getopt found an option not in the option string - * APR_BADARG Getopt found an option that is missing an argument + * APR_BADARG Getopt found an option that is missing an argument * and an argument was specified in the option string * APR_EOF APR has encountered the end of the file * APR_NOTFOUND APR was unable to find the socket in the poll structure * APR_ANONYMOUS APR is using anonymous shared memory * APR_FILEBASED APR is using a file name as the key to the shared memory * APR_KEYBASED APR is using a shared key as the key to the shared memory - * APR_EINIT Ininitalizer value. If no option has been found, but + * APR_EINIT Ininitalizer value. If no option has been found, but * the status variable requires a value, this should be used - * APR_ENOTIMPL The APR function has not been implemented on this - * platform, either because nobody has gotten to it yet, + * APR_ENOTIMPL The APR function has not been implemented on this + * platform, either because nobody has gotten to it yet, * or the function is impossible on this platform. * APR_EMISMATCH Two passwords do not match. * APR_EABSOLUTE The given path was absolute. @@ -340,7 +340,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_ENOTENOUGHENTROPY (APR_OS_START_ERROR + 28) /** @} */ -/** +/** * @defgroup APR_STATUS_IS Status Value Tests * @warning For any particular error condition, more than one of these tests * may match. This is because platform-specific error codes may not @@ -351,16 +351,16 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, * adjust the order of the tests accordingly. * @{ */ -/** - * APR was unable to perform a stat on the file +/** + * APR was unable to perform a stat on the file * @warning always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_ENOSTAT(s) ((s) == APR_ENOSTAT) -/** - * APR was not provided a pool with which to allocate memory +/** + * APR was not provided a pool with which to allocate memory * @warning always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_ENOPOOL(s) ((s) == APR_ENOPOOL) /** APR was given an invalid date */ @@ -392,8 +392,8 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, /** The specified netmask is invalid */ #define APR_STATUS_IS_EBADMASK(s) ((s) == APR_EBADMASK) /* empty slot: +18 */ -/** - * APR was unable to open the dso object. +/** + * APR was unable to open the dso object. * For more information call apr_dso_error(). */ #if defined(WIN32) @@ -436,7 +436,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, /** @} */ -/** +/** * @addtogroup APR_Error * @{ */ @@ -477,7 +477,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, /** @see APR_STATUS_IS_KEYBASED */ #define APR_KEYBASED (APR_OS_START_STATUS + 21) /** @see APR_STATUS_IS_EINIT */ -#define APR_EINIT (APR_OS_START_STATUS + 22) +#define APR_EINIT (APR_OS_START_STATUS + 22) /** @see APR_STATUS_IS_ENOTIMPL */ #define APR_ENOTIMPL (APR_OS_START_STATUS + 23) /** @see APR_STATUS_IS_EMISMATCH */ @@ -486,156 +486,156 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_EBUSY (APR_OS_START_STATUS + 25) /** @} */ -/** +/** * @addtogroup APR_STATUS_IS * @{ */ -/** - * Program is currently executing in the child +/** + * Program is currently executing in the child * @warning * always use this test, as platform-specific variances may meet this * more than one error code */ #define APR_STATUS_IS_INCHILD(s) ((s) == APR_INCHILD) -/** - * Program is currently executing in the parent +/** + * Program is currently executing in the parent * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_INPARENT(s) ((s) == APR_INPARENT) -/** - * The thread is detached +/** + * The thread is detached * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_DETACH(s) ((s) == APR_DETACH) -/** - * The thread is not detached +/** + * The thread is not detached * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_NOTDETACH(s) ((s) == APR_NOTDETACH) -/** +/** * The child has finished executing * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_CHILD_DONE(s) ((s) == APR_CHILD_DONE) -/** +/** * The child has not finished executing * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_CHILD_NOTDONE(s) ((s) == APR_CHILD_NOTDONE) -/** +/** * The operation did not finish before the timeout * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_TIMEUP(s) ((s) == APR_TIMEUP) -/** +/** * The operation was incomplete although some processing was performed * and the results are partially valid. * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_INCOMPLETE(s) ((s) == APR_INCOMPLETE) /* empty slot: +9 */ /* empty slot: +10 */ /* empty slot: +11 */ -/** +/** * Getopt found an option not in the option string * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_BADCH(s) ((s) == APR_BADCH) -/** - * Getopt found an option not in the option string and an argument was +/** + * Getopt found an option not in the option string and an argument was * specified in the option string * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_BADARG(s) ((s) == APR_BADARG) -/** +/** * APR has encountered the end of the file * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_EOF(s) ((s) == APR_EOF) -/** +/** * APR was unable to find the socket in the poll structure * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_NOTFOUND(s) ((s) == APR_NOTFOUND) /* empty slot: +16 */ /* empty slot: +17 */ /* empty slot: +18 */ -/** +/** * APR is using anonymous shared memory * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_ANONYMOUS(s) ((s) == APR_ANONYMOUS) -/** +/** * APR is using a file name as the key to the shared memory * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_FILEBASED(s) ((s) == APR_FILEBASED) -/** +/** * APR is using a shared key as the key to the shared memory * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_KEYBASED(s) ((s) == APR_KEYBASED) -/** - * Ininitalizer value. If no option has been found, but +/** + * Ininitalizer value. If no option has been found, but * the status variable requires a value, this should be used * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_EINIT(s) ((s) == APR_EINIT) -/** - * The APR function has not been implemented on this - * platform, either because nobody has gotten to it yet, +/** + * The APR function has not been implemented on this + * platform, either because nobody has gotten to it yet, * or the function is impossible on this platform. * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_ENOTIMPL(s) ((s) == APR_ENOTIMPL) -/** +/** * Two passwords do not match. * @warning * always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_EMISMATCH(s) ((s) == APR_EMISMATCH) -/** +/** * The given lock was busy * @warning always use this test, as platform-specific variances may meet this - * more than one error code + * more than one error code */ #define APR_STATUS_IS_EBUSY(s) ((s) == APR_EBUSY) /** @} */ -/** +/** * @addtogroup APR_Error APR Error Values * @{ */ @@ -724,8 +724,8 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_ESPIPE (APR_OS_START_CANONERR + 12) #endif -/** - * @see APR_STATUS_IS_EAGAIN +/** + * @see APR_STATUS_IS_EAGAIN * @warning use APR_STATUS_IS_EAGAIN instead of just testing this value */ #ifdef EAGAIN @@ -764,7 +764,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_EINPROGRESS (APR_OS_START_CANONERR + 17) #endif -/** +/** * @see APR_STATUS_IS_ECONNABORTED * @warning use APR_STATUS_IS_ECONNABORTED instead of just testing this value */ @@ -782,7 +782,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define APR_ECONNRESET (APR_OS_START_CANONERR + 19) #endif -/** @see APR_STATUS_IS_ETIMEDOUT +/** @see APR_STATUS_IS_ETIMEDOUT * @deprecated */ #ifdef ETIMEDOUT #define APR_ETIMEDOUT ETIMEDOUT @@ -884,7 +884,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define apr_get_netos_error() (APR_FROM_OS_ERROR(errno)) #define apr_set_netos_error(e) (errno = APR_TO_OS_ERROR(e)) -/* These can't sit in a private header, so in spite of the extra size, +/* These can't sit in a private header, so in spite of the extra size, * they need to be made available here. */ #define SOCBASEERR 10000 @@ -981,10 +981,10 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, || (s) == APR_OS_START_SYSERR + SOCECONNRESET) /* XXX deprecated */ #define APR_STATUS_IS_ETIMEDOUT(s) ((s) == APR_ETIMEDOUT \ - || (s) == APR_OS_START_SYSERR + SOCETIMEDOUT) + || (s) == APR_OS_START_SYSERR + SOCETIMEDOUT) #undef APR_STATUS_IS_TIMEUP #define APR_STATUS_IS_TIMEUP(s) ((s) == APR_TIMEUP \ - || (s) == APR_OS_START_SYSERR + SOCETIMEDOUT) + || (s) == APR_OS_START_SYSERR + SOCETIMEDOUT) #define APR_STATUS_IS_EHOSTUNREACH(s) ((s) == APR_EHOSTUNREACH \ || (s) == APR_OS_START_SYSERR + SOCEHOSTUNREACH) #define APR_STATUS_IS_ENETUNREACH(s) ((s) == APR_ENETUNREACH \ @@ -1236,7 +1236,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, #define apr_get_netos_error() (errno) #define apr_set_netos_error(e) (errno = (e)) -/** +/** * @addtogroup APR_STATUS_IS * @{ */ @@ -1300,15 +1300,15 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf, /** operation now in progress */ #define APR_STATUS_IS_EINPROGRESS(s) ((s) == APR_EINPROGRESS) -/** - * Software caused connection abort +/** + * Software caused connection abort * @remark - * EPROTO on certain older kernels really means ECONNABORTED, so we need to + * EPROTO on certain older kernels really means ECONNABORTED, so we need to * ignore it for them. See discussion in new-httpd archives nh.9701 & nh.9603 * - * There is potentially a bug in Solaris 2.x x<6, and other boxes that + * There is potentially a bug in Solaris 2.x x<6, and other boxes that * implement tcp sockets in userland (i.e. on top of STREAMS). On these - * systems, EPROTO can actually result in a fatal loop. See PR#981 for + * systems, EPROTO can actually result in a fatal loop. See PR#981 for * example. It's hard to handle both uses of EPROTO. */ #ifdef EPROTO diff --git a/include/apr_escape.h b/include/apr_escape.h index 7dafa4e18..7660c7c79 100644 --- a/include/apr_escape.h +++ b/include/apr_escape.h @@ -72,7 +72,7 @@ extern "C" { /** * Perform shell escaping on the provided string. - * + * * Shell escaping causes characters to be prefixed with a '\' character. * @param escaped Optional buffer to write the encoded string, can be * NULL diff --git a/include/apr_file_info.h b/include/apr_file_info.h index cfddc68da..a50ccb367 100644 --- a/include/apr_file_info.h +++ b/include/apr_file_info.h @@ -39,7 +39,7 @@ extern "C" { /** * @defgroup apr_file_info File Information - * @ingroup APR + * @ingroup APR * @{ */ @@ -48,11 +48,11 @@ extern "C" { * so the APR_NOFILE value must be distinct from APR_UNKFILE. */ -/** apr_filetype_e values for the filetype member of the +/** apr_filetype_e values for the filetype member of the * apr_file_info_t structure * @warning Not all of the filetypes below can be determined. - * For example, a given platform might not correctly report - * a socket descriptor as APR_SOCK if that type isn't + * For example, a given platform might not correctly report + * a socket descriptor as APR_SOCK if that type isn't * well-identified on that platform. In such cases where * a filetype exists but cannot be described by the recognized * flags below, the filetype will be APR_UNKFILE. If the @@ -69,10 +69,10 @@ typedef enum { APR_LNK, /**< a symbolic link */ APR_SOCK, /**< a [unix domain] socket */ APR_UNKFILE = 127 /**< a file of some other unknown type */ -} apr_filetype_e; +} apr_filetype_e; /** - * @defgroup apr_file_permissions File Permissions flags + * @defgroup apr_file_permissions File Permissions flags * @{ */ @@ -95,7 +95,7 @@ typedef enum { /* additional permission flags for apr_file_copy and apr_file_append */ #define APR_FPROT_FILE_SOURCE_PERMS 0x1000 /**< Copy source file's permissions */ - + /* backcompat */ #define APR_USETID APR_FPROT_USETID /**< @deprecated @see APR_FPROT_USETID */ #define APR_UREAD APR_FPROT_UREAD /**< @deprecated @see APR_FPROT_UREAD */ @@ -111,7 +111,7 @@ typedef enum { #define APR_WEXECUTE APR_FPROT_WEXECUTE /**< @deprecated @see APR_FPROT_WEXECUTE */ #define APR_OS_DEFAULT APR_FPROT_OS_DEFAULT /**< @deprecated @see APR_FPROT_OS_DEFAULT */ #define APR_FILE_SOURCE_PERMS APR_FPROT_FILE_SOURCE_PERMS /**< @deprecated @see APR_FPROT_FILE_SOURCE_PERMS */ - + /** @} */ @@ -174,12 +174,12 @@ typedef struct apr_finfo_t apr_finfo_t; struct apr_finfo_t { /** Allocates memory and closes lingering handles in the specified pool */ apr_pool_t *pool; - /** The bitmask describing valid fields of this apr_finfo_t structure + /** The bitmask describing valid fields of this apr_finfo_t structure * including all available 'wanted' fields and potentially more */ apr_int32_t valid; /** The access permissions of the file. Mimics Unix access rights. */ apr_fileperms_t protection; - /** The type of file. One of APR_REG, APR_DIR, APR_CHR, APR_BLK, APR_PIPE, + /** The type of file. One of APR_REG, APR_DIR, APR_CHR, APR_BLK, APR_PIPE, * APR_LNK or APR_SOCK. If the type is undetermined, the value is APR_NOFILE. * If the type cannot be determined, the value is APR_UNKFILE. */ @@ -213,19 +213,19 @@ struct apr_finfo_t { }; /** - * get the specified file's stats. The file is specified by filename, + * get the specified file's stats. The file is specified by filename, * instead of using a pre-opened file. * @param finfo Where to store the information about the file, which is * never touched if the call fails. * @param fname The name of the file to stat. * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ - values - * @param pool the pool to use to allocate the new file. + values + * @param pool the pool to use to allocate the new file. * * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may * not be filled in, and you need to check the @c finfo->valid bitmask * to verify that what you're looking for is there. - */ + */ APR_DECLARE(apr_status_t) apr_stat(apr_finfo_t *finfo, const char *fname, apr_int32_t wanted, apr_pool_t *pool); @@ -240,22 +240,22 @@ APR_DECLARE(apr_status_t) apr_stat(apr_finfo_t *finfo, const char *fname, * @param new_dir The opened directory descriptor. * @param dirname The full path to the directory (use / on all systems) * @param pool The pool to use. - */ -APR_DECLARE(apr_status_t) apr_dir_open(apr_dir_t **new_dir, - const char *dirname, + */ +APR_DECLARE(apr_status_t) apr_dir_open(apr_dir_t **new_dir, + const char *dirname, apr_pool_t *pool); /** - * close the specified directory. + * close the specified directory. * @param thedir the directory descriptor to close. - */ + */ APR_DECLARE(apr_status_t) apr_dir_close(apr_dir_t *thedir); /** - * Read the next entry from the specified directory. + * Read the next entry from the specified directory. * @param finfo the file info structure and filled in by apr_dir_read * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ - values + values * @param thedir the directory descriptor returned from apr_dir_open * @remark No ordering is guaranteed for the entries read. * @@ -263,14 +263,14 @@ APR_DECLARE(apr_status_t) apr_dir_close(apr_dir_t *thedir); * not be filled in, and you need to check the @c finfo->valid bitmask * to verify that what you're looking for is there. When no more * entries are available, APR_ENOENT is returned. - */ + */ APR_DECLARE(apr_status_t) apr_dir_read(apr_finfo_t *finfo, apr_int32_t wanted, apr_dir_t *thedir); /** * Rewind the directory to the first entry. * @param thedir the directory descriptor to rewind. - */ + */ APR_DECLARE(apr_status_t) apr_dir_rewind(apr_dir_t *thedir); /** @} */ @@ -279,7 +279,7 @@ APR_DECLARE(apr_status_t) apr_dir_rewind(apr_dir_t *thedir); * @{ */ -/** Cause apr_filepath_merge to fail if addpath is above rootpath +/** Cause apr_filepath_merge to fail if addpath is above rootpath * @bug in APR 0.9 and 1.x, this flag's behavior is undefined * if the rootpath is NULL or empty. In APR 2.0 this should be * changed to imply NOTABSOLUTE if the rootpath is NULL or empty. @@ -305,7 +305,7 @@ APR_DECLARE(apr_status_t) apr_dir_rewind(apr_dir_t *thedir); #define APR_FILEPATH_NATIVE 0x10 /** Resolve the true case of existing directories and file elements - * of addpath, (resolving any aliases on Win32) and append a proper + * of addpath, (resolving any aliases on Win32) and append a proper * trailing slash if a directory */ #define APR_FILEPATH_TRUENAME 0x20 @@ -321,20 +321,20 @@ APR_DECLARE(apr_status_t) apr_dir_rewind(apr_dir_t *thedir); * </PRE> * @param p the pool to allocate the new path string from * @remark on return, filepath points to the first non-root character in the - * given filepath. In the simplest example, given a filepath of "/foo", - * returns the rootpath of "/" and filepath points at "foo". This is far + * given filepath. In the simplest example, given a filepath of "/foo", + * returns the rootpath of "/" and filepath points at "foo". This is far * more complex on other platforms, which will canonicalize the root form * to a consistant format, given the APR_FILEPATH_TRUENAME flag, and also - * test for the validity of that root (e.g., that a drive d:/ or network - * share //machine/foovol/). + * test for the validity of that root (e.g., that a drive d:/ or network + * share //machine/foovol/). * The function returns APR_ERELATIVE if filepath isn't rooted (an * error), APR_EINCOMPLETE if the root path is ambiguous (but potentially * legitimate, e.g. "/" on Windows is incomplete because it doesn't specify * the drive letter), or APR_EBADPATH if the root is simply invalid. * APR_SUCCESS is returned if filepath is an absolute path. */ -APR_DECLARE(apr_status_t) apr_filepath_root(const char **rootpath, - const char **filepath, +APR_DECLARE(apr_status_t) apr_filepath_root(const char **rootpath, + const char **filepath, apr_int32_t flags, apr_pool_t *p); @@ -345,15 +345,15 @@ APR_DECLARE(apr_status_t) apr_filepath_root(const char **rootpath, * @param addpath the path to add to the root path * @param flags the desired APR_FILEPATH_ rules to apply when merging * @param p the pool to allocate the new path string from - * @remark if the flag APR_FILEPATH_TRUENAME is given, and the addpath - * contains wildcard characters ('*', '?') on platforms that don't support - * such characters within filenames, the paths will be merged, but the + * @remark if the flag APR_FILEPATH_TRUENAME is given, and the addpath + * contains wildcard characters ('*', '?') on platforms that don't support + * such characters within filenames, the paths will be merged, but the * result code will be APR_EPATHWILD, and all further segments will not * reflect the true filenames including the wildcard and following segments. - */ -APR_DECLARE(apr_status_t) apr_filepath_merge(char **newpath, + */ +APR_DECLARE(apr_status_t) apr_filepath_merge(char **newpath, const char *rootpath, - const char *addpath, + const char *addpath, apr_int32_t flags, apr_pool_t *p); diff --git a/include/apr_file_io.h b/include/apr_file_io.h index b1c088db4..bac8599a2 100644 --- a/include/apr_file_io.h +++ b/include/apr_file_io.h @@ -39,7 +39,7 @@ extern "C" { /** * @defgroup apr_file_io File I/O Handling Functions - * @ingroup APR + * @ingroup APR * @{ */ @@ -58,7 +58,7 @@ extern "C" { #define APR_FOPEN_TRUNCATE 0x00010 /**< Open the file and truncate to 0 length */ #define APR_FOPEN_BINARY 0x00020 /**< Open the file in binary mode - (This flag is ignored on UNIX + (This flag is ignored on UNIX because it has no meaning)*/ #define APR_FOPEN_EXCL 0x00040 /**< Open should fail if #APR_FOPEN_CREATE and file exists. */ @@ -80,7 +80,7 @@ extern "C" { file should support apr_socket_sendfile operation */ #define APR_FOPEN_LARGEFILE 0x04000 /**< Platform dependent flag to enable - * large file support, see WARNING below + * large file support, see WARNING below */ #define APR_FOPEN_SPARSE 0x08000 /**< Platform dependent flag to enable @@ -88,31 +88,31 @@ extern "C" { */ #define APR_FOPEN_ROTATING 0x10000 /**< Do file file rotation checking */ - + #define APR_FOPEN_MANUAL_ROTATE 0x20000 /**< Enable Manual rotation */ #define APR_FOPEN_NONBLOCK 0x40000 /**< Platform dependent flag to enable * non blocking file io */ - + /* backcompat */ #define APR_READ APR_FOPEN_READ /**< @deprecated @see APR_FOPEN_READ */ -#define APR_WRITE APR_FOPEN_WRITE /**< @deprecated @see APR_FOPEN_WRITE */ -#define APR_CREATE APR_FOPEN_CREATE /**< @deprecated @see APR_FOPEN_CREATE */ -#define APR_APPEND APR_FOPEN_APPEND /**< @deprecated @see APR_FOPEN_APPEND */ -#define APR_TRUNCATE APR_FOPEN_TRUNCATE /**< @deprecated @see APR_FOPEN_TRUNCATE */ -#define APR_BINARY APR_FOPEN_BINARY /**< @deprecated @see APR_FOPEN_BINARY */ -#define APR_EXCL APR_FOPEN_EXCL /**< @deprecated @see APR_FOPEN_EXCL */ -#define APR_BUFFERED APR_FOPEN_BUFFERED /**< @deprecated @see APR_FOPEN_BUFFERED */ -#define APR_DELONCLOSE APR_FOPEN_DELONCLOSE /**< @deprecated @see APR_FOPEN_DELONCLOSE */ -#define APR_XTHREAD APR_FOPEN_XTHREAD /**< @deprecated @see APR_FOPEN_XTHREAD */ -#define APR_SHARELOCK APR_FOPEN_SHARELOCK /**< @deprecated @see APR_FOPEN_SHARELOCK */ -#define APR_FILE_NOCLEANUP APR_FOPEN_NOCLEANUP /**< @deprecated @see APR_FOPEN_NOCLEANUP */ -#define APR_SENDFILE_ENABLED APR_FOPEN_SENDFILE_ENABLED /**< @deprecated @see APR_FOPEN_SENDFILE_ENABLED */ -#define APR_LARGEFILE APR_FOPEN_LARGEFILE /**< @deprecated @see APR_FOPEN_LARGEFILE */ - -/** @def APR_FOPEN_LARGEFILE +#define APR_WRITE APR_FOPEN_WRITE /**< @deprecated @see APR_FOPEN_WRITE */ +#define APR_CREATE APR_FOPEN_CREATE /**< @deprecated @see APR_FOPEN_CREATE */ +#define APR_APPEND APR_FOPEN_APPEND /**< @deprecated @see APR_FOPEN_APPEND */ +#define APR_TRUNCATE APR_FOPEN_TRUNCATE /**< @deprecated @see APR_FOPEN_TRUNCATE */ +#define APR_BINARY APR_FOPEN_BINARY /**< @deprecated @see APR_FOPEN_BINARY */ +#define APR_EXCL APR_FOPEN_EXCL /**< @deprecated @see APR_FOPEN_EXCL */ +#define APR_BUFFERED APR_FOPEN_BUFFERED /**< @deprecated @see APR_FOPEN_BUFFERED */ +#define APR_DELONCLOSE APR_FOPEN_DELONCLOSE /**< @deprecated @see APR_FOPEN_DELONCLOSE */ +#define APR_XTHREAD APR_FOPEN_XTHREAD /**< @deprecated @see APR_FOPEN_XTHREAD */ +#define APR_SHARELOCK APR_FOPEN_SHARELOCK /**< @deprecated @see APR_FOPEN_SHARELOCK */ +#define APR_FILE_NOCLEANUP APR_FOPEN_NOCLEANUP /**< @deprecated @see APR_FOPEN_NOCLEANUP */ +#define APR_SENDFILE_ENABLED APR_FOPEN_SENDFILE_ENABLED /**< @deprecated @see APR_FOPEN_SENDFILE_ENABLED */ +#define APR_LARGEFILE APR_FOPEN_LARGEFILE /**< @deprecated @see APR_FOPEN_LARGEFILE */ + +/** @def APR_FOPEN_LARGEFILE * @warning APR_FOPEN_LARGEFILE flag only has effect on some * platforms where sizeof(apr_off_t) == 4. Where implemented, it * allows opening and writing to a file which exceeds the size which @@ -172,7 +172,7 @@ extern "C" { * @{ */ #if defined(DOXYGEN) -#define APR_MAX_IOVEC_SIZE 1024 /**< System dependent maximum +#define APR_MAX_IOVEC_SIZE 1024 /**< System dependent maximum size of an iovec array */ #elif defined(IOV_MAX) #define APR_MAX_IOVEC_SIZE IOV_MAX @@ -235,13 +235,13 @@ typedef struct apr_file_t apr_file_t; * @li #APR_FOPEN_SHARELOCK Platform dependent support for higher * level locked read/write access to support * writes across process/machines - * @li #APR_FOPEN_NOCLEANUP Do not register a cleanup with the pool + * @li #APR_FOPEN_NOCLEANUP Do not register a cleanup with the pool * passed in on the @a pool argument (see below) * @li #APR_FOPEN_SENDFILE_ENABLED Open with appropriate platform semantics * for sendfile operations. Advisory only, * apr_socket_sendfile does not check this flag * @li #APR_FOPEN_LARGEFILE Platform dependent flag to enable large file - * support, see WARNING below + * support, see WARNING below * @li #APR_FOPEN_SPARSE Platform dependent flag to enable sparse file * support, see WARNING below * @li #APR_FOPEN_ROTATING Do file file rotation checking @@ -284,7 +284,7 @@ APR_DECLARE(apr_status_t) apr_file_remove(const char *path, apr_pool_t *pool); * overwritten. Moving files or directories across devices may not be * possible. */ -APR_DECLARE(apr_status_t) apr_file_rename(const char *from_path, +APR_DECLARE(apr_status_t) apr_file_rename(const char *from_path, const char *to_path, apr_pool_t *pool); @@ -294,7 +294,7 @@ APR_DECLARE(apr_status_t) apr_file_rename(const char *from_path, * @param to_path The full path to the new file (using / on all systems) * @remark Both files must reside on the same device. */ -APR_DECLARE(apr_status_t) apr_file_link(const char *from_path, +APR_DECLARE(apr_status_t) apr_file_link(const char *from_path, const char *to_path); /** @@ -309,7 +309,7 @@ APR_DECLARE(apr_status_t) apr_file_link(const char *from_path, * @remark The new file does not need to exist, it will be created if required. * @warning If the new file already exists, its contents will be overwritten. */ -APR_DECLARE(apr_status_t) apr_file_copy(const char *from_path, +APR_DECLARE(apr_status_t) apr_file_copy(const char *from_path, const char *to_path, apr_fileperms_t perms, apr_pool_t *pool); @@ -329,7 +329,7 @@ APR_DECLARE(apr_status_t) apr_file_copy(const char *from_path, * source file permissions) are assigned only when the target file does not yet * exist. */ -APR_DECLARE(apr_status_t) apr_file_append(const char *from_path, +APR_DECLARE(apr_status_t) apr_file_append(const char *from_path, const char *to_path, apr_fileperms_t perms, apr_pool_t *pool); @@ -345,11 +345,11 @@ APR_DECLARE(apr_status_t) apr_file_eof(apr_file_t *fptr); * Open standard error as an apr file pointer. * @param thefile The apr file to use as stderr. * @param pool The pool to allocate the file out of. - * + * * @remark The only reason that the apr_file_open_std* functions exist * is that you may not always have a stderr/out/in on Windows. This * is generally a problem with newer versions of Windows and services. - * + * * @remark The other problem is that the C library functions generally work * differently on Windows and Unix. So, by using apr_file_open_std* * functions, you can get a handle to an APR struct that works with @@ -363,7 +363,7 @@ APR_DECLARE(apr_status_t) apr_file_open_stderr(apr_file_t **thefile, * open standard output as an apr file pointer. * @param thefile The apr file to use as stdout. * @param pool The pool to allocate the file out of. - * + * * @remark See remarks for apr_file_open_stderr(). */ APR_DECLARE(apr_status_t) apr_file_open_stdout(apr_file_t **thefile, @@ -373,7 +373,7 @@ APR_DECLARE(apr_status_t) apr_file_open_stdout(apr_file_t **thefile, * open standard input as an apr file pointer. * @param thefile The apr file to use as stdin. * @param pool The pool to allocate the file out of. - * + * * @remark See remarks for apr_file_open_stderr(). */ APR_DECLARE(apr_status_t) apr_file_open_stdin(apr_file_t **thefile, @@ -382,18 +382,18 @@ APR_DECLARE(apr_status_t) apr_file_open_stdin(apr_file_t **thefile, /** * open standard error as an apr file pointer, with flags. * @param thefile The apr file to use as stderr. - * @param flags The flags to open the file with. Only the + * @param flags The flags to open the file with. Only the * @li #APR_FOPEN_EXCL * @li #APR_FOPEN_BUFFERED * @li #APR_FOPEN_XTHREAD - * @li #APR_FOPEN_SHARELOCK + * @li #APR_FOPEN_SHARELOCK * @li #APR_FOPEN_SENDFILE_ENABLED * @li #APR_FOPEN_LARGEFILE * * flags should be used. The #APR_FOPEN_WRITE flag will * be set unconditionally. * @param pool The pool to allocate the file out of. - * + * * @remark See remarks for apr_file_open_stderr(). */ APR_DECLARE(apr_status_t) apr_file_open_flags_stderr(apr_file_t **thefile, @@ -403,18 +403,18 @@ APR_DECLARE(apr_status_t) apr_file_open_flags_stderr(apr_file_t **thefile, /** * open standard output as an apr file pointer, with flags. * @param thefile The apr file to use as stdout. - * @param flags The flags to open the file with. Only the + * @param flags The flags to open the file with. Only the * @li #APR_FOPEN_EXCL * @li #APR_FOPEN_BUFFERED * @li #APR_FOPEN_XTHREAD - * @li #APR_FOPEN_SHARELOCK + * @li #APR_FOPEN_SHARELOCK * @li #APR_FOPEN_SENDFILE_ENABLED * @li #APR_FOPEN_LARGEFILE * * flags should be used. The #APR_FOPEN_WRITE flag will * be set unconditionally. * @param pool The pool to allocate the file out of. - * + * * @remark See remarks for apr_file_open_stderr(). */ APR_DECLARE(apr_status_t) apr_file_open_flags_stdout(apr_file_t **thefile, @@ -424,18 +424,18 @@ APR_DECLARE(apr_status_t) apr_file_open_flags_stdout(apr_file_t **thefile, /** * open standard input as an apr file pointer, with flags. * @param thefile The apr file to use as stdin. - * @param flags The flags to open the file with. Only the + * @param flags The flags to open the file with. Only the * @li #APR_FOPEN_EXCL * @li #APR_FOPEN_BUFFERED * @li #APR_FOPEN_XTHREAD - * @li #APR_FOPEN_SHARELOCK + * @li #APR_FOPEN_SHARELOCK * @li #APR_FOPEN_SENDFILE_ENABLED * @li #APR_FOPEN_LARGEFILE * * flags should be used. The #APR_FOPEN_WRITE flag will * be set unconditionally. * @param pool The pool to allocate the file out of. - * + * * @remark See remarks for apr_file_open_stderr(). */ APR_DECLARE(apr_status_t) apr_file_open_flags_stdin(apr_file_t **thefile, @@ -466,7 +466,7 @@ APR_DECLARE(apr_status_t) apr_file_read(apr_file_t *thefile, void *buf, * Write data to the specified file. * @param thefile The file descriptor to write to. * @param buf The buffer which contains the data. - * @param nbytes On entry, the number of bytes to write; on exit, the number + * @param nbytes On entry, the number of bytes to write; on exit, the number * of bytes written. * * @remark apr_file_write() will write up to the specified number of @@ -484,8 +484,8 @@ APR_DECLARE(apr_status_t) apr_file_write(apr_file_t *thefile, const void *buf, * Write data from iovec array to the specified file. * @param thefile The file descriptor to write to. * @param vec The array from which to get the data to write to the file. - * @param nvec The number of elements in the struct iovec array. This must - * be smaller than #APR_MAX_IOVEC_SIZE. If it isn't, the function + * @param nvec The number of elements in the struct iovec array. This must + * 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. * @@ -530,7 +530,7 @@ APR_DECLARE(apr_status_t) apr_file_read_full(apr_file_t *thefile, void *buf, * @param buf The buffer which contains the data. * @param nbytes The number of bytes to write. * @param bytes_written If non-NULL, set to the number of bytes written. - * + * * @remark apr_file_write_full() 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 @@ -543,9 +543,9 @@ APR_DECLARE(apr_status_t) apr_file_read_full(apr_file_t *thefile, void *buf, * * @remark #APR_EINTR is never returned. */ -APR_DECLARE(apr_status_t) apr_file_write_full(apr_file_t *thefile, +APR_DECLARE(apr_status_t) apr_file_write_full(apr_file_t *thefile, const void *buf, - apr_size_t nbytes, + apr_size_t nbytes, apr_size_t *bytes_written); @@ -554,8 +554,8 @@ APR_DECLARE(apr_status_t) apr_file_write_full(apr_file_t *thefile, * data is written before returning. * @param thefile The file descriptor to write to. * @param vec The array from which to get the data to write to the file. - * @param nvec The number of elements in the struct iovec array. This must - * be smaller than #APR_MAX_IOVEC_SIZE. If it isn't, the function + * @param nvec The number of elements in the struct iovec array. This must + * 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. * @@ -589,18 +589,18 @@ APR_DECLARE(apr_status_t) apr_file_ungetc(char ch, apr_file_t *thefile); /** * Read a line from the specified file - * @param str The buffer to store the string in. + * @param str The buffer to store the string in. * @param len The length of the string * @param thefile The file descriptor to read from * @remark The buffer will be NUL-terminated if any characters are stored. * The newline at the end of the line will not be stripped. */ -APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, +APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t *thefile); /** * Write the string into the specified file. - * @param str The string to write. + * @param str The string to write. * @param thefile The file descriptor to write to */ APR_DECLARE(apr_status_t) apr_file_puts(const char *str, apr_file_t *thefile); @@ -635,11 +635,11 @@ APR_DECLARE(apr_status_t) apr_file_datasync(apr_file_t *thefile); /** * Duplicate the specified file descriptor. - * @param new_file The structure to duplicate into. + * @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. * @remark *new_file 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, apr_pool_t *p); @@ -672,7 +672,7 @@ APR_DECLARE(apr_status_t) apr_file_setaside(apr_file_t **new_file, apr_pool_t *p); /** - * Give the specified apr file handle a new buffer + * Give the specified apr file handle a new buffer * @param thefile The file handle that is to be modified * @param buffer The buffer * @param bufsize The size of the buffer @@ -687,8 +687,8 @@ APR_DECLARE(apr_status_t) apr_file_buffer_set(apr_file_t *thefile, apr_size_t bufsize); /** - * Get the size of any buffer for the specified apr file handle - * @param thefile The file handle + * Get the size of any buffer for the specified apr file handle + * @param thefile The file handle */ APR_DECLARE(apr_size_t) apr_file_buffer_size_get(apr_file_t *thefile); @@ -697,13 +697,13 @@ APR_DECLARE(apr_size_t) apr_file_buffer_size_get(apr_file_t *thefile); * @param thefile The file descriptor * @param where How to move the pointer, one of: * @li #APR_SET -- set the offset to offset - * @li #APR_CUR -- add the offset to the current position - * @li #APR_END -- add the offset to the current file size + * @li #APR_CUR -- add the offset to the current position + * @li #APR_END -- add the offset to the current file size * @param offset The offset to move the pointer to. * @remark The third argument is modified to be the offset the pointer was actually moved to. */ -APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile, +APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile, apr_seek_where_t where, apr_off_t *offset); @@ -720,7 +720,7 @@ APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile, * does not expect it, a non-blocking stream will fluxor the client app. * @deprecated @see apr_file_pipe_create_pools() */ -APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, +APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, apr_file_t **out, apr_pool_t *pool); @@ -740,13 +740,13 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, * @remark Some platforms cannot toggle between blocking and nonblocking, * and when passing a pipe as a standard handle to an application which * does not expect it, a non-blocking stream will fluxor the client app. - * Use this function rather than apr_file_pipe_create() to create pipes + * Use this function rather than apr_file_pipe_create() to create pipes * where one or both ends require non-blocking semantics. * @deprecated @see apr_file_pipe_create_pools() */ -APR_DECLARE(apr_status_t) apr_file_pipe_create_ex(apr_file_t **in, - apr_file_t **out, - apr_int32_t blocking, +APR_DECLARE(apr_status_t) apr_file_pipe_create_ex(apr_file_t **in, + apr_file_t **out, + apr_int32_t blocking, apr_pool_t *pool); /** @@ -782,25 +782,25 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create_pools(apr_file_t **in, * @param perm The permissions for the newly created pipe. * @param pool The pool to operate on. */ -APR_DECLARE(apr_status_t) apr_file_namedpipe_create(const char *filename, - apr_fileperms_t perm, +APR_DECLARE(apr_status_t) apr_file_namedpipe_create(const char *filename, + apr_fileperms_t perm, apr_pool_t *pool); /** * 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. + * @param timeout The current timeout value in microseconds. */ -APR_DECLARE(apr_status_t) apr_file_pipe_timeout_get(apr_file_t *thepipe, +APR_DECLARE(apr_status_t) apr_file_pipe_timeout_get(apr_file_t *thepipe, apr_interval_time_t *timeout); /** * Set the timeout value for a pipe or manipulate the blocking state. * @param thepipe The pipe we are setting a timeout on. - * @param timeout The timeout value in microseconds. Values < 0 mean wait + * @param timeout The timeout value in microseconds. Values < 0 mean wait * forever, 0 means do not wait at all. */ -APR_DECLARE(apr_status_t) apr_file_pipe_timeout_set(apr_file_t *thepipe, +APR_DECLARE(apr_status_t) apr_file_pipe_timeout_set(apr_file_t *thepipe, apr_interval_time_t timeout); /** file (un)locking functions. */ @@ -826,28 +826,28 @@ APR_DECLARE(apr_status_t) apr_file_unlock(apr_file_t *thefile); /** * return the file name of the current file. - * @param new_path The path of the file. + * @param new_path The path of the file. * @param thefile The currently open file. - */ -APR_DECLARE(apr_status_t) apr_file_name_get(const char **new_path, + */ +APR_DECLARE(apr_status_t) apr_file_name_get(const char **new_path, apr_file_t *thefile); - + /** * Return the data associated with the current file. - * @param data The user data associated with the file. + * @param data The user data associated with the file. * @param key The key to use for retrieving data associated with this file. * @param file The currently open file. - */ -APR_DECLARE(apr_status_t) apr_file_data_get(void **data, const char *key, + */ +APR_DECLARE(apr_status_t) apr_file_data_get(void **data, const char *key, apr_file_t *file); /** * Set the data associated with the current file. * @param file The currently open file. - * @param data The user data to associate with the file. + * @param data The user data to associate with the file. * @param key The key to use for associating data with the file. * @param cleanup The cleanup routine to use when the file is destroyed. - */ + */ APR_DECLARE(apr_status_t) apr_file_data_set(apr_file_t *file, void *data, const char *key, apr_status_t (*cleanup)(void *)); @@ -858,8 +858,8 @@ APR_DECLARE(apr_status_t) apr_file_data_set(apr_file_t *file, void *data, * @param format The format string * @param ... The values to substitute in the format string * @return The number of bytes written - */ -APR_DECLARE_NONSTD(int) apr_file_printf(apr_file_t *fptr, + */ +APR_DECLARE_NONSTD(int) apr_file_printf(apr_file_t *fptr, const char *format, ...) __attribute__((format(printf,2,3))); @@ -916,8 +916,8 @@ APR_DECLARE(apr_status_t) apr_file_mtime_set(const char *fname, * @param path the path for the directory to be created. (use / on all systems) * @param perm Permissions for the new directory. * @param pool the pool to use. - */ -APR_DECLARE(apr_status_t) apr_dir_make(const char *path, apr_fileperms_t perm, + */ +APR_DECLARE(apr_status_t) apr_dir_make(const char *path, apr_fileperms_t perm, apr_pool_t *pool); /** Creates a new directory on the file system, but behaves like @@ -937,19 +937,19 @@ APR_DECLARE(apr_status_t) apr_dir_make_recursive(const char *path, * @param pool the pool to use. * @remark Removing a directory which is in-use (e.g., the current working * directory, or during apr_dir_read, or with an open file) is not portable. - */ + */ APR_DECLARE(apr_status_t) apr_dir_remove(const char *path, apr_pool_t *pool); /** * get the specified file's stats. * @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 wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_* values * @param thefile The file to get information about. - */ -APR_DECLARE(apr_status_t) apr_file_info_get(apr_finfo_t *finfo, + */ +APR_DECLARE(apr_status_t) apr_file_info_get(apr_finfo_t *finfo, apr_int32_t wanted, apr_file_t *thefile); - + /** * Truncate the file's length to the specified offset @@ -987,16 +987,16 @@ APR_DECLARE_INHERIT_UNSET(file); * @param fp The apr file to use as a temporary file. * @param templ The template to use when creating a temp file. * @param flags The flags to open the file with. If this is zero, - * the file is opened with + * the file is opened with * #APR_FOPEN_CREATE | #APR_FOPEN_READ | #APR_FOPEN_WRITE | * #APR_FOPEN_EXCL | #APR_FOPEN_DELONCLOSE * @param p The pool to allocate the file out of. - * @remark - * This function generates a unique temporary file name from template. - * The last six characters of template must be XXXXXX and these are replaced + * @remark + * This function generates a unique temporary file name from template. + * The last six characters of template must be XXXXXX and these are replaced * with a string that makes the filename unique. Since it will be modified, * template must not be a string constant, but should be declared as a character - * array. + * array. * */ APR_DECLARE(apr_status_t) apr_file_mktemp(apr_file_t **fp, char *templ, @@ -1007,12 +1007,12 @@ APR_DECLARE(apr_status_t) apr_file_mktemp(apr_file_t **fp, char *templ, * Find an existing directory suitable as a temporary storage location. * @param temp_dir The temp directory. * @param p The pool to use for any necessary allocations. - * @remark + * @remark * This function uses an algorithm to search for a directory that an * an application can use for temporary storage. * */ -APR_DECLARE(apr_status_t) apr_temp_dir_get(const char **temp_dir, +APR_DECLARE(apr_status_t) apr_temp_dir_get(const char **temp_dir, apr_pool_t *p); diff --git a/include/apr_fnmatch.h b/include/apr_fnmatch.h index f8c26cf3e..5316b31b5 100644 --- a/include/apr_fnmatch.h +++ b/include/apr_fnmatch.h @@ -51,12 +51,12 @@ extern "C" { /** * @defgroup apr_fnmatch Filename Matching Functions - * @ingroup APR + * @ingroup APR * @{ */ #define APR_FNM_NOMATCH 1 /**< Match failed. */ - + #define APR_FNM_NOESCAPE 0x01 /**< Disable backslash escaping. */ #define APR_FNM_PATHNAME 0x02 /**< Slash must be matched by slash. */ #define APR_FNM_PERIOD 0x04 /**< Leading period must be matched by period. */ @@ -72,20 +72,20 @@ extern "C" { * PATTERN: Backslash followed by any character, including another * backslash.<br/> * MATCHES: That character exactly. - * + * * <p> * PATTERN: ?<br/> * MATCHES: Any single character. * </p> - * + * * <p> * PATTERN: *<br/> * MATCHES: Any sequence of zero or more characters. (Note that multiple * *s in a row are equivalent to one.) - * + * * PATTERN: Any character other than \?*[ or a \ at the end of the pattern<br/> * MATCHES: That character exactly. (Case sensitive.) - * + * * PATTERN: [ followed by a class description followed by ]<br/> * MATCHES: A single character described by the class description. * (Never matches, if the class description reaches until the @@ -102,7 +102,7 @@ extern "C" { * the first character larger than the second are legal but * never match. Edge cases: [] never matches, and [^] and [!] * always match without consuming a character. - * + * * Note that these patterns attempt to match the entire string, not * just find a substring matching the pattern. * @@ -117,7 +117,7 @@ extern "C" { * </pre> */ -APR_DECLARE(apr_status_t) apr_fnmatch(const char *pattern, +APR_DECLARE(apr_status_t) apr_fnmatch(const char *pattern, const char *strings, int flags); /** @@ -140,7 +140,7 @@ APR_DECLARE(int) apr_fnmatch_test(const char *pattern); * @remark The returned array may be empty even if APR_SUCCESS was * returned. */ -APR_DECLARE(apr_status_t) apr_match_glob(const char *dir_pattern, +APR_DECLARE(apr_status_t) apr_match_glob(const char *dir_pattern, apr_array_header_t **result, apr_pool_t *p); diff --git a/include/apr_general.h b/include/apr_general.h index 4f2a6e8c4..4ffd8eb1f 100644 --- a/include/apr_general.h +++ b/include/apr_general.h @@ -39,7 +39,7 @@ extern "C" { /** * @defgroup apr_general Miscellaneous library routines - * @ingroup APR + * @ingroup APR * This is collection of oddballs that didn't fit anywhere else, * and might move to more appropriate headers with the release * of APR 1.0. @@ -114,10 +114,10 @@ typedef enum { APR_WAIT_READ, APR_WAIT_WRITE } apr_wait_type_t; #ifndef DOXYGEN -/* A couple of prototypes for functions in case some platform doesn't +/* A couple of prototypes for functions in case some platform doesn't * have it */ -#if (!APR_HAVE_STRCASECMP) && (APR_HAVE_STRICMP) +#if (!APR_HAVE_STRCASECMP) && (APR_HAVE_STRICMP) #define strcasecmp(s1, s2) stricmp(s1, s2) #elif (!APR_HAVE_STRCASECMP) int strcasecmp(const char *a, const char *b); @@ -181,7 +181,7 @@ struct type { \ */ /** - * Setup any APR internal data structures. This MUST be the first function + * Setup any APR internal data structures. This MUST be the first function * called for any APR library. It is safe to call apr_initialize several * times as long as apr_terminate() is called the same number of times. * @remark See apr_app_initialize() if this is an application, rather than @@ -201,15 +201,15 @@ APR_DECLARE(apr_status_t) apr_initialize(void); * Otherwise, this call is identical to apr_initialize(), and must be closed * with a call to apr_terminate() at the end of program execution. */ -APR_DECLARE(apr_status_t) apr_app_initialize(int *argc, - char const * const * *argv, +APR_DECLARE(apr_status_t) apr_app_initialize(int *argc, + char const * const * *argv, char const * const * *env); /** - * Tear down any APR internal data structures which aren't torn down + * Tear down any APR internal data structures which aren't torn down * automatically. apr_terminate must be called once for every call to * apr_initialize() or apr_app_initialize(). - * @remark An APR program must call this function at termination once it + * @remark An APR program must call this function at termination once it * has stopped using APR services. The APR developers suggest using * @c atexit(apr_terminate) to ensure this is called. When using APR * from a language other than C that has problems with the calling @@ -219,12 +219,12 @@ APR_DECLARE(apr_status_t) apr_app_initialize(int *argc, APR_DECLARE_NONSTD(void) apr_terminate(void); /** - * Tear down any APR internal data structures which aren't torn down + * Tear down any APR internal data structures which aren't torn down * automatically, same as apr_terminate() * @remark An APR program must call either the apr_terminate() or apr_terminate2 - * function once it it has finished using APR services. The APR + * function once it it has finished using APR services. The APR * developers suggest using @c atexit(apr_terminate) to ensure this is done. - * apr_terminate2 exists to allow non-c language apps to tear down apr, + * apr_terminate2 exists to allow non-c language apps to tear down apr, * while apr_terminate() is recommended from c language applications. */ APR_DECLARE(void) apr_terminate2(void); @@ -244,7 +244,7 @@ APR_DECLARE(void) apr_terminate2(void); * @param buf Buffer to fill with random bytes * @param length Length of buffer in bytes */ -APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, +APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, apr_size_t length); #endif diff --git a/include/apr_getopt.h b/include/apr_getopt.h index 75ad5663a..034800687 100644 --- a/include/apr_getopt.h +++ b/include/apr_getopt.h @@ -30,11 +30,11 @@ extern "C" { /** * @defgroup apr_getopt Command Argument Parsing - * @ingroup APR + * @ingroup APR * @{ */ -/** +/** * An @c apr_getopt_t error callback function. * * @a arg is this @c apr_getopt_t's @c errarg member. @@ -46,7 +46,7 @@ typedef struct apr_getopt_t apr_getopt_t; /** * Structure to store command line argument information. - */ + */ struct apr_getopt_t { /** context for processing */ apr_pool_t *cont; @@ -106,8 +106,8 @@ APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, /** * Parse the options initialized by apr_getopt_init(). * @param os The apr_opt_t structure returned by apr_getopt_init() - * @param opts A string of characters that are acceptable options to the - * program. Characters followed by ":" are required to have an + * @param opts A string of characters that are acceptable options to the + * program. Characters followed by ":" are required to have an * option associated * @param option_ch The next option character parsed * @param option_arg The argument following the option character: @@ -119,7 +119,7 @@ APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, * APR_SUCCESS -- The next option was found. * </PRE> */ -APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, +APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, char *option_ch, const char **option_arg); /** diff --git a/include/apr_global_mutex.h b/include/apr_global_mutex.h index d57ca453d..066b71b0f 100644 --- a/include/apr_global_mutex.h +++ b/include/apr_global_mutex.h @@ -37,7 +37,7 @@ extern "C" { /** * @defgroup APR_GlobalMutex Global Locking Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -83,7 +83,7 @@ APR_DECLARE(apr_status_t) apr_global_mutex_create(apr_global_mutex_t **mutex, * @param mutex The newly re-opened mutex structure. * @param fname A file name to use if the mutex mechanism requires one. This * argument should always be provided. The mutex code itself will - * determine if it should be used. This filename should be the + * determine if it should be used. This filename should be the * same one that was passed to apr_global_mutex_create(). * @param pool The pool to operate on. * @remark This function must be called to maintain portability, even diff --git a/include/apr_hash.h b/include/apr_hash.h index cd5bf02da..9c7a6e454 100644 --- a/include/apr_hash.h +++ b/include/apr_hash.h @@ -30,7 +30,7 @@ extern "C" { /** * @defgroup apr_hash Hash Tables - * @ingroup APR + * @ingroup APR * @{ */ @@ -59,7 +59,7 @@ typedef struct apr_hash_index_t apr_hash_index_t; /** * Callback functions for calculating hash values. * @param key The key. - * @param klen The length of the key, or APR_HASH_KEY_STRING to use the string + * @param klen The length of the key, or APR_HASH_KEY_STRING to use the string * length. If APR_HASH_KEY_STRING then returns the actual key length. */ typedef unsigned int (*apr_hashfunc_t)(const char *key, apr_ssize_t *klen); @@ -83,7 +83,7 @@ APR_DECLARE(apr_hash_t *) apr_hash_make(apr_pool_t *pool); * @param hash_func A custom hash function. * @return The hash table just created */ -APR_DECLARE(apr_hash_t *) apr_hash_make_custom(apr_pool_t *pool, +APR_DECLARE(apr_hash_t *) apr_hash_make_custom(apr_pool_t *pool, apr_hashfunc_t hash_func); /** @@ -164,7 +164,7 @@ APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht); /** * Continue iterating over the entries in a hash table. * @param hi The iteration state - * @return a pointer to the updated iteration state. NULL if there are no more + * @return a pointer to the updated iteration state. NULL if there are no more * entries. */ APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi); @@ -178,7 +178,7 @@ APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi); * @remark The return pointers should point to a variable that will be set to the * corresponding data, or they may be NULL if the data isn't interesting. */ -APR_DECLARE(void) apr_hash_this(apr_hash_index_t *hi, const void **key, +APR_DECLARE(void) apr_hash_this(apr_hash_index_t *hi, const void **key, apr_ssize_t *klen, void **val); /** @@ -225,7 +225,7 @@ APR_DECLARE(void) apr_hash_clear(apr_hash_t *ht); * @return A new hash table containing all of the data from the two passed in */ APR_DECLARE(apr_hash_t *) apr_hash_overlay(apr_pool_t *p, - const apr_hash_t *overlay, + const apr_hash_t *overlay, const apr_hash_t *base); /** @@ -261,14 +261,14 @@ APR_DECLARE(apr_hash_t *) apr_hash_merge(apr_pool_t *p, * @param klen The key length from this iteration of the hash table * @param value The value from this iteration of the hash table * @remark Iteration continues while this callback function returns non-zero. - * To export the callback function for apr_hash_do() it must be declared + * To export the callback function for apr_hash_do() it must be declared * in the _NONSTD convention. */ typedef int (apr_hash_do_callback_fn_t)(void *rec, const void *key, apr_ssize_t klen, const void *value); -/** +/** * Iterate over a hash table running the provided function once for every * element in the hash table. The @p comp function will be invoked for * every element in the hash table. diff --git a/include/apr_hooks.h b/include/apr_hooks.h index 206f0d8dd..a664ecc28 100644 --- a/include/apr_hooks.h +++ b/include/apr_hooks.h @@ -110,11 +110,11 @@ extern "C" { /** @} */ -/** macro to return the prototype of the hook function */ +/** macro to return the prototype of the hook function */ #define APR_IMPLEMENT_HOOK_GET_PROTO(ns,link,name) \ link##_DECLARE(apr_array_header_t *) ns##_hook_get_##name(void) -/** macro to declare the hook correctly */ +/** macro to declare the hook correctly */ #define APR_DECLARE_EXTERNAL_HOOK(ns,link,ret,name,args) \ typedef ret ns##_HOOK_##name##_t args; \ link##_DECLARE(void) ns##_hook_##name(ns##_HOOK_##name##_t *pf, \ @@ -131,7 +131,7 @@ typedef struct ns##_LINK_##name##_t \ int nOrder; \ } ns##_LINK_##name##_t; -/** macro to declare the hook structure */ +/** macro to declare the hook structure */ #define APR_HOOK_STRUCT(members) \ static struct { members } _hooks; @@ -308,18 +308,18 @@ link##_DECLARE(ret) ns##_run_##name args_decl \ /** * The global pool used to allocate any memory needed by the hooks. - */ + */ APR_DECLARE_DATA extern apr_pool_t *apr_hook_global_pool; /** * A global variable to determine if debugging information about the * hooks functions should be printed. - */ + */ APR_DECLARE_DATA extern int apr_hook_debug_enabled; /** * The name of the module that is currently registering a function. - */ + */ APR_DECLARE_DATA extern const char *apr_hook_debug_current; /** @@ -327,7 +327,7 @@ APR_DECLARE_DATA extern const char *apr_hook_debug_current; * @param szHookName The name of the Hook the function is registered for * @param aHooks The array which stores all of the functions for this hook */ -APR_DECLARE(void) apr_hook_sort_register(const char *szHookName, +APR_DECLARE(void) apr_hook_sort_register(const char *szHookName, apr_array_header_t **aHooks); /** * Sort all of the registered functions for a given hook. diff --git a/include/apr_inherit.h b/include/apr_inherit.h index b9fe56fe4..5239d7c5f 100644 --- a/include/apr_inherit.h +++ b/include/apr_inherit.h @@ -18,16 +18,16 @@ #define APR_INHERIT_H /** - * @file apr_inherit.h + * @file apr_inherit.h * @brief APR File Handle Inheritance Helpers - * @remark This internal header includes internal declaration helpers + * @remark This internal header includes internal declaration helpers * for other headers to declare apr_foo_inherit_[un]set functions. */ /** - * Prototype for type-specific declarations of apr_foo_inherit_set - * functions. - * @remark Doxygen unwraps this macro (via doxygen.conf) to provide + * Prototype for type-specific declarations of apr_foo_inherit_set + * functions. + * @remark Doxygen unwraps this macro (via doxygen.conf) to provide * actual help for each specific occurrence of apr_foo_inherit_set. * @remark the linkage is specified for APR. It would be possible to expand * the macros to support other linkages. @@ -37,9 +37,9 @@ apr_##type##_t *the##type) /** - * Prototype for type-specific declarations of apr_foo_inherit_unset - * functions. - * @remark Doxygen unwraps this macro (via doxygen.conf) to provide + * Prototype for type-specific declarations of apr_foo_inherit_unset + * functions. + * @remark Doxygen unwraps this macro (via doxygen.conf) to provide * actual help for each specific occurrence of apr_foo_inherit_unset. * @remark the linkage is specified for APR. It would be possible to expand * the macros to support other linkages. diff --git a/include/apr_lib.h b/include/apr_lib.h index c86217f91..9f4cb2b33 100644 --- a/include/apr_lib.h +++ b/include/apr_lib.h @@ -41,7 +41,7 @@ extern "C" { /** * @defgroup apr_lib General Purpose Library Routines - * @ingroup APR + * @ingroup APR * This is collection of oddballs that didn't fit anywhere else, * and might move to more appropriate headers with the release * of APR 1.0. @@ -186,7 +186,7 @@ APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b), * reason; its value will never be modified by the apr_password_get() * function. */ -APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, +APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, apr_size_t *bufsize); /** @} */ diff --git a/include/apr_md4.h b/include/apr_md4.h index e1336d668..aa7fb1061 100644 --- a/include/apr_md4.h +++ b/include/apr_md4.h @@ -85,10 +85,10 @@ APR_DECLARE(apr_status_t) apr_md4_init(apr_md4_ctx_t *context); #if APR_HAS_XLATE /** - * MDr4 translation setup. Provides the APR translation handle to be used + * MDr4 translation setup. Provides the APR translation handle to be used * for translating the content before calculating the digest. * @param context The MD4 content to set the translation for. - * @param xlate The translation handle to use for this MD4 context + * @param xlate The translation handle to use for this MD4 context */ APR_DECLARE(apr_status_t) apr_md4_set_xlate(apr_md4_ctx_t *context, apr_xlate_t *xlate); @@ -97,7 +97,7 @@ APR_DECLARE(apr_status_t) apr_md4_set_xlate(apr_md4_ctx_t *context, #endif /** - * MD4 block update operation. Continue an MD4 message-digest operation, + * MD4 block update operation. Continue an MD4 message-digest operation, * processing another message block, and updating the context. * @param context The MD4 content to update. * @param input next message block to update @@ -108,7 +108,7 @@ APR_DECLARE(apr_status_t) apr_md4_update(apr_md4_ctx_t *context, apr_size_t inputLen); /** - * MD4 finalization. Ends an MD4 message-digest operation, writing the + * MD4 finalization. Ends an MD4 message-digest operation, writing the * message digest and zeroing the context * @param digest The final MD4 digest * @param context The MD4 content we are finalizing. diff --git a/include/apr_md5.h b/include/apr_md5.h index 1e5ba359e..a931d0fb7 100644 --- a/include/apr_md5.h +++ b/include/apr_md5.h @@ -78,7 +78,7 @@ struct apr_md5_ctx_t { apr_uint32_t count[2]; /** input buffer */ unsigned char buffer[64]; - /** translation handle + /** translation handle * ignored if xlate is unsupported */ apr_xlate_t *xlate; @@ -91,16 +91,16 @@ struct apr_md5_ctx_t { APR_DECLARE(apr_status_t) apr_md5_init(apr_md5_ctx_t *context); /** - * MD5 translation setup. Provides the APR translation handle to be used + * MD5 translation setup. Provides the APR translation handle to be used * 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 + * @param xlate The translation handle to use for this MD5 context */ APR_DECLARE(apr_status_t) apr_md5_set_xlate(apr_md5_ctx_t *context, apr_xlate_t *xlate); /** - * MD5 block update operation. Continue an MD5 message-digest operation, + * MD5 block update operation. Continue an MD5 message-digest operation, * processing another message block, and updating the context. * @param context The MD5 content to update. * @param input next message block to update @@ -111,7 +111,7 @@ APR_DECLARE(apr_status_t) apr_md5_update(apr_md5_ctx_t *context, apr_size_t inputLen); /** - * MD5 finalization. Ends an MD5 message-digest operation, writing the + * MD5 finalization. Ends an MD5 message-digest operation, writing the * message digest and zeroing the context * @param digest The final MD5 digest * @param context The MD5 content we are finalizing. @@ -164,7 +164,7 @@ APR_DECLARE(apr_status_t) apr_bcrypt_encode(const char *pw, * @param passwd The password to validate * @param hash The password to validate against */ -APR_DECLARE(apr_status_t) apr_password_validate(const char *passwd, +APR_DECLARE(apr_status_t) apr_password_validate(const char *passwd, const char *hash); diff --git a/include/apr_memcache.h b/include/apr_memcache.h index 2a3bcaab8..7e376e602 100644 --- a/include/apr_memcache.h +++ b/include/apr_memcache.h @@ -151,7 +151,7 @@ APR_DECLARE(apr_uint32_t) apr_memcache_hash_default(void *baton, * @return server that controls specified hash * @see apr_memcache_hash */ -APR_DECLARE(apr_memcache_server_t *) apr_memcache_find_server_hash(apr_memcache_t *mc, +APR_DECLARE(apr_memcache_server_t *) apr_memcache_find_server_hash(apr_memcache_t *mc, const apr_uint32_t hash); /** @@ -159,7 +159,7 @@ APR_DECLARE(apr_memcache_server_t *) apr_memcache_find_server_hash(apr_memcache_ */ APR_DECLARE(apr_memcache_server_t *) apr_memcache_find_server_hash_default(void *baton, - apr_memcache_t *mc, + apr_memcache_t *mc, const apr_uint32_t hash); /** @@ -243,9 +243,9 @@ APR_DECLARE(apr_status_t) apr_memcache_create(apr_pool_t *p, * @param baton location of the allocated value * @param len length of data at baton * @param flags any flags set by the client for this key - * @return + * @return */ -APR_DECLARE(apr_status_t) apr_memcache_getp(apr_memcache_t *mc, +APR_DECLARE(apr_status_t) apr_memcache_getp(apr_memcache_t *mc, apr_pool_t *p, const char* key, char **baton, @@ -304,7 +304,7 @@ APR_DECLARE(apr_status_t) apr_memcache_set(apr_memcache_t *mc, * @param data_size length of data at baton * @param timeout time for the data to live on the server * @param flags any flags set by the client for this key - * @return APR_SUCCESS if the key was added, APR_EEXIST if the key + * @return APR_SUCCESS if the key was added, APR_EEXIST if the key * already exists on the server. */ APR_DECLARE(apr_status_t) apr_memcache_add(apr_memcache_t *mc, @@ -322,7 +322,7 @@ APR_DECLARE(apr_status_t) apr_memcache_add(apr_memcache_t *mc, * @param data_size length of data at baton * @param timeout time for the data to live on the server * @param flags any flags set by the client for this key - * @return APR_SUCCESS if the key was added, APR_EEXIST if the key + * @return APR_SUCCESS if the key was added, APR_EEXIST if the key * did not exist on the server. */ APR_DECLARE(apr_status_t) apr_memcache_replace(apr_memcache_t *mc, @@ -348,7 +348,7 @@ APR_DECLARE(apr_status_t) apr_memcache_delete(apr_memcache_t *mc, * @param n number to increment by * @param nv new value after incrementing */ -APR_DECLARE(apr_status_t) apr_memcache_incr(apr_memcache_t *mc, +APR_DECLARE(apr_status_t) apr_memcache_incr(apr_memcache_t *mc, const char *key, apr_int32_t n, apr_uint32_t *nv); @@ -360,7 +360,7 @@ APR_DECLARE(apr_status_t) apr_memcache_incr(apr_memcache_t *mc, * @param n number to decrement by * @param new_value new value after decrementing */ -APR_DECLARE(apr_status_t) apr_memcache_decr(apr_memcache_t *mc, +APR_DECLARE(apr_status_t) apr_memcache_decr(apr_memcache_t *mc, const char *key, apr_int32_t n, apr_uint32_t *new_value); @@ -421,7 +421,7 @@ typedef struct /** Number of bytes this server is allowed to use for storage. */ apr_uint32_t limit_maxbytes; /** Number of threads the server is running (if built with threading) */ - apr_uint32_t threads; + apr_uint32_t threads; } apr_memcache_stats_t; /** @@ -430,7 +430,7 @@ typedef struct * @param p Pool to allocate answer from * @param stats location of the new statistics structure */ -APR_DECLARE(apr_status_t) apr_memcache_stats(apr_memcache_server_t *ms, +APR_DECLARE(apr_status_t) apr_memcache_stats(apr_memcache_server_t *ms, apr_pool_t *p, apr_memcache_stats_t **stats); diff --git a/include/apr_mmap.h b/include/apr_mmap.h index 2bdf81a2a..1f6667afe 100644 --- a/include/apr_mmap.h +++ b/include/apr_mmap.h @@ -38,7 +38,7 @@ extern "C" { /** * @defgroup apr_mmap MMAP (Memory Map) Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -84,7 +84,7 @@ struct apr_mmap_t { #if APR_HAS_MMAP || defined(DOXYGEN) -/** @def APR_MMAP_THRESHOLD +/** @def APR_MMAP_THRESHOLD * Files have to be at least this big before they're mmap()d. This is to deal * with systems where the expense of doing an mmap() and an munmap() outweighs * the benefit for small files. It shouldn't be set lower than 1. @@ -114,7 +114,7 @@ struct apr_mmap_t { /* Function definitions */ -/** +/** * Create a new mmap'ed file out of an existing APR file. * @param newmmap The newly created mmap'ed file. * @param file The file to turn into an mmap. @@ -127,17 +127,17 @@ struct apr_mmap_t { * </PRE> * @param cntxt The pool to use when creating the mmap. */ -APR_DECLARE(apr_status_t) apr_mmap_create(apr_mmap_t **newmmap, +APR_DECLARE(apr_status_t) apr_mmap_create(apr_mmap_t **newmmap, apr_file_t *file, apr_off_t offset, apr_size_t size, apr_int32_t flag, apr_pool_t *cntxt); /** * Duplicate the specified MMAP. - * @param new_mmap The structure to duplicate into. + * @param new_mmap The structure to duplicate into. * @param old_mmap The mmap to duplicate. * @param p The pool to use for new_mmap. - */ + */ APR_DECLARE(apr_status_t) apr_mmap_dup(apr_mmap_t **new_mmap, apr_mmap_t *old_mmap, apr_pool_t *p); @@ -148,13 +148,13 @@ APR_DECLARE(apr_status_t) apr_mmap_dup(apr_mmap_t **new_mmap, */ APR_DECLARE(apr_status_t) apr_mmap_delete(apr_mmap_t *mm); -/** +/** * Move the pointer into the mmap'ed file to the specified offset. * @param addr The pointer to the offset specified. * @param mm The mmap'ed file. * @param offset The offset to move to. */ -APR_DECLARE(apr_status_t) apr_mmap_offset(void **addr, apr_mmap_t *mm, +APR_DECLARE(apr_status_t) apr_mmap_offset(void **addr, apr_mmap_t *mm, apr_off_t offset); #endif /* APR_HAS_MMAP */ diff --git a/include/apr_network_io.h b/include/apr_network_io.h index b3536d802..e6dd3d124 100644 --- a/include/apr_network_io.h +++ b/include/apr_network_io.h @@ -25,7 +25,7 @@ #include "apr_pools.h" #include "apr_file_io.h" #include "apr_errno.h" -#include "apr_inherit.h" +#include "apr_inherit.h" #include "apr_perms_set.h" #if APR_HAVE_NETINET_IN_H @@ -41,7 +41,7 @@ extern "C" { /** * @defgroup apr_network_io Network Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -85,7 +85,7 @@ extern "C" { #define APR_INCOMPLETE_READ 4096 /**< Set on non-blocking sockets * (timeout != 0) on which the * previous read() did not fill a buffer - * completely. the next apr_socket_recv() + * completely. the next apr_socket_recv() * will first call select()/poll() rather than * going straight into read(). (Can also * be set by an application to force a @@ -99,7 +99,7 @@ extern "C" { #define APR_IPV6_V6ONLY 16384 /**< Don't accept IPv4 connections on an * IPv6 listening socket. */ -#define APR_TCP_DEFER_ACCEPT 32768 /**< Delay accepting of new connections +#define APR_TCP_DEFER_ACCEPT 32768 /**< Delay accepting of new connections * until data is available. * @see apr_socket_accept_filter */ @@ -257,7 +257,7 @@ struct apr_sockaddr_t { /** This points to the IP address structure within the appropriate * sockaddr structure. */ void *ipaddr_ptr; - /** If multiple addresses were found by apr_sockaddr_info_get(), this + /** If multiple addresses were found by apr_sockaddr_info_get(), this * points to a representation of the next address. */ apr_sockaddr_t *next; /** Union of either IPv4 or IPv6 sockaddr. */ @@ -309,19 +309,19 @@ struct apr_hdtr_t { * socket. The caller must ensure that it is not used by other threads * at the same time. */ -APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock, +APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock, int family, int type, int protocol, apr_pool_t *cont); /** * Shutdown either reading, writing, or both sides of a socket. - * @param thesocket The socket to close + * @param thesocket The socket to close * @param how How to shutdown the socket. One of: * <PRE> * APR_SHUTDOWN_READ no longer allow read requests * APR_SHUTDOWN_WRITE no longer allow write requests - * APR_SHUTDOWN_READWRITE no longer allow read or write requests + * APR_SHUTDOWN_READWRITE no longer allow read or write requests * </PRE> * @see apr_shutdown_how_e * @remark This does not actually close the socket descriptor, it just @@ -332,28 +332,28 @@ APR_DECLARE(apr_status_t) apr_socket_shutdown(apr_socket_t *thesocket, /** * Close a socket. - * @param thesocket The socket to close + * @param thesocket The socket to close */ APR_DECLARE(apr_status_t) apr_socket_close(apr_socket_t *thesocket); /** * Bind the socket to its associated port - * @param sock The socket to bind + * @param sock The socket to bind * @param sa The socket address to bind to * @remark This may be where we will find out if there is any other process * using the selected port. */ -APR_DECLARE(apr_status_t) apr_socket_bind(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_bind(apr_socket_t *sock, apr_sockaddr_t *sa); /** * Listen to a bound socket for connections. - * @param sock The socket to listen on + * @param sock The socket to listen on * @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. + * queue size is set to zero. */ -APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock, apr_int32_t backlog); /** @@ -367,14 +367,14 @@ APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock, * socket. The caller must ensure that it is not used by other threads * at the same time. */ -APR_DECLARE(apr_status_t) apr_socket_accept(apr_socket_t **new_sock, +APR_DECLARE(apr_status_t) apr_socket_accept(apr_socket_t **new_sock, apr_socket_t *sock, apr_pool_t *connection_pool); /** - * Issue a connection request to a socket either on the same machine + * Issue a connection request to a socket either on the same machine * or a different one. - * @param sock The socket we wish to use for our side of the connection + * @param sock The socket we wish to use for our side of the connection * @param sa The address of the machine we wish to connect to. */ APR_DECLARE(apr_status_t) apr_socket_connect(apr_socket_t *sock, @@ -401,7 +401,7 @@ APR_DECLARE(apr_status_t) apr_socket_atreadeof(apr_socket_t *sock, * @param hostname The hostname or numeric address string to resolve/parse, or * NULL to build an address that corresponds to 0.0.0.0 or :: * or in case of APR_UNIX family it is absolute socket filename. - * @param family The address family to use, or APR_UNSPEC if the system should + * @param family The address family to use, or APR_UNSPEC if the system should * decide. * @param port The port number. * @param flags Special processing flags: @@ -461,8 +461,8 @@ APR_DECLARE(apr_status_t) apr_sockaddr_zone_set(apr_sockaddr_t *sa, APR_DECLARE(apr_status_t) apr_sockaddr_zone_get(const apr_sockaddr_t *sa, const char **name, apr_uint32_t *id, - apr_pool_t *p); - + apr_pool_t *p); + /** * Look up the host name from an apr_sockaddr_t. * @param hostname The hostname. @@ -490,19 +490,19 @@ APR_DECLARE(apr_status_t) apr_getnameinfo(char **hostname, * [abc] (not valid IPv6 numeric address string) * abc:65536 (invalid port number) * - * @param addr The new buffer containing just the hostname. On output, *addr + * @param addr The new buffer containing just the hostname. On output, *addr * will be NULL if no hostname/IP address was specfied. - * @param scope_id The new buffer containing just the scope id. On output, + * @param scope_id The new buffer containing just the scope id. On output, * *scope_id will be NULL if no scope id was specified. - * @param port The port number. On output, *port will be 0 if no port was + * @param port The port number. On output, *port will be 0 if no port was * specified. * ### FIXME: 0 is a legal port (per RFC 1700). this should * ### return something besides zero if the port is missing. * @param str The input string to be parsed. * @param p The pool from which *addr and *scope_id are allocated. - * @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 + * @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, @@ -544,12 +544,12 @@ APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data, /** * Send data over a network. * @param sock The socket to send the data over. - * @param buf The buffer which contains the data to be sent. + * @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. * @remark * <PRE> - * This functions acts like a blocking write by default. To change + * This functions acts like a blocking write by default. To change * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK * socket option. * @@ -558,18 +558,18 @@ APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data, * APR_EINTR is never returned. * </PRE> */ -APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf, +APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf, apr_size_t *len); /** * Send multiple buffers over a network. * @param sock The socket to send the data over. - * @param vec The array of iovec structs containing the data to send + * @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 * @remark * <PRE> - * This functions acts like a blocking write by default. To change + * This functions acts like a blocking write by default. To change * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK * socket option. * The number of bytes actually sent is stored in argument 4. @@ -579,7 +579,7 @@ APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf, * APR_EINTR is never returned. * </PRE> */ -APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock, const struct iovec *vec, apr_int32_t nvec, apr_size_t *len); @@ -590,9 +590,9 @@ APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock, * @param buf The data to send * @param len The length of the data to send */ -APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock, apr_sockaddr_t *where, - apr_int32_t flags, const char *buf, + apr_int32_t flags, const char *buf, apr_size_t *len); /** @@ -608,25 +608,25 @@ APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock, * @param len The length of the available buffer */ -APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from, +APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from, apr_socket_t *sock, - apr_int32_t flags, char *buf, + apr_int32_t flags, char *buf, apr_size_t *len); - + #if APR_HAS_SENDFILE || defined(DOXYGEN) /** - * Send a file from an open file descriptor to a socket, along with + * Send a file from an open file descriptor to a socket, along with * optional headers and trailers * @param sock The socket to which we're writing * @param file The open file from which to read * @param hdtr A structure containing the headers and trailers to send * @param offset Offset into the file where we should begin writing - * @param len (input) - Number of bytes to send from the file - * (output) - Number of bytes actually sent, + * @param len (input) - Number of bytes to send from the file + * (output) - Number of bytes actually sent, * including headers, file, and trailers * @param flags APR flags that are mapped to OS specific flags - * @remark This functions acts like a blocking write by default. To change + * @remark This functions acts like a blocking write by default. To change * this behavior, use apr_socket_timeout_set() or the * APR_SO_NONBLOCK socket option. * The number of bytes actually sent is stored in the len parameter. @@ -634,7 +634,7 @@ APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from, * value will never be modified by the apr_socket_sendfile() function. * It is possible for both bytes to be sent and an error to be returned. */ -APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, apr_file_t *file, apr_hdtr_t *hdtr, apr_off_t *offset, @@ -646,12 +646,12 @@ APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, /** * Read data from a network. * @param sock The socket to read the data from. - * @param buf The buffer to store the data in. + * @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. * @remark * <PRE> - * This functions acts like a blocking read by default. To change + * This functions acts like a blocking read by default. To change * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK * socket option. * The number of bytes actually received is stored in argument 3. @@ -662,7 +662,7 @@ APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, * APR_EINTR is never returned. * </PRE> */ -APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, char *buf, apr_size_t *len); /** @@ -672,7 +672,7 @@ APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, * @remark Will time out if socket has a time out set for it * @remark direction can be either APR_WAIT_READ or APR_WAIT_WRITE */ -APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock, apr_wait_type_t direction); /** @@ -680,7 +680,7 @@ APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock, * @param sock The socket to set up. * @param opt The option we would like to configure. One of: * <PRE> - * APR_SO_DEBUG -- turn on debugging information + * APR_SO_DEBUG -- turn on debugging information * APR_SO_KEEPALIVE -- keep connections active * APR_SO_LINGER -- lingers on close if data is present * APR_SO_NONBLOCK -- Turns blocking on/off for socket @@ -720,7 +720,7 @@ APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock, * @param sock The socket to query * @param opt The option we would like to query. One of: * <PRE> - * APR_SO_DEBUG -- turn on debugging information + * APR_SO_DEBUG -- turn on debugging information * APR_SO_KEEPALIVE -- keep connections active * APR_SO_LINGER -- lingers on close if data is present * APR_SO_NONBLOCK -- Turns blocking on/off for socket @@ -734,7 +734,7 @@ APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock, * </PRE> * @param on Socket option returned on the call. */ -APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock, apr_int32_t opt, apr_int32_t *on); /** @@ -742,7 +742,7 @@ APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock, * @param sock The socket to query * @param t Socket timeout returned from the query. */ -APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock, apr_interval_time_t *t); /** @@ -751,7 +751,7 @@ APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock, * @param atmark Is set to true if socket is at the OOB/urgent mark, * otherwise is set to false. */ -APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock, +APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock, int *atmark); /** @@ -765,15 +765,15 @@ APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock, APR_DECLARE(apr_status_t) apr_socket_addr_get(apr_sockaddr_t **sa, apr_interface_e which, apr_socket_t *sock); - + /** * Return the IP address (in numeric address string format) in - * an APR socket address. APR will allocate storage for the IP address + * an APR socket address. APR will allocate storage for the IP address * string from the pool of the apr_sockaddr_t. * @param addr The IP address. * @param sockaddr The socket address to reference. */ -APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr, +APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr, apr_sockaddr_t *sockaddr); /** @@ -814,13 +814,13 @@ APR_DECLARE(int) apr_sockaddr_is_wildcard(const apr_sockaddr_t *addr); */ APR_DECLARE(apr_status_t) apr_socket_type_get(apr_socket_t *sock, int *type); - + /** * Given an apr_sockaddr_t and a service name, set the port for the service * @param sockaddr The apr_sockaddr_t that will have its port set * @param servname The name of the service you wish to use */ -APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, +APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, const char *servname); /** * Build an ip-subnet representation from an IP address and optional netmask or @@ -830,9 +830,9 @@ APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, * @param mask_or_numbits The input netmask or number-of-bits string, or NULL * @param p The pool to allocate from */ -APR_DECLARE(apr_status_t) apr_ipsubnet_create(apr_ipsubnet_t **ipsub, - const char *ipstr, - const char *mask_or_numbits, +APR_DECLARE(apr_status_t) apr_ipsubnet_create(apr_ipsubnet_t **ipsub, + const char *ipstr, + const char *mask_or_numbits, apr_pool_t *p); /** @@ -850,7 +850,7 @@ APR_DECLARE(int) apr_ipsubnet_test(apr_ipsubnet_t *ipsub, apr_sockaddr_t *sa); * @param sock The socket to put the accept filter on. * @param name The accept filter * @param args Any extra args to the accept filter. Passing NULL here removes - * the accept filter. + * the accept filter. */ apr_status_t apr_socket_accept_filter(apr_socket_t *sock, const char *name, const char *args); @@ -893,9 +893,9 @@ APR_PERMS_SET_IMPLEMENT(socket); * Join a Multicast Group * @param sock The socket to join a multicast group * @param join The address of the multicast group to join - * @param iface Address of the interface to use. If NULL is passed, the + * @param iface Address of the interface to use. If NULL is passed, the * default multicast interface will be used. (OS Dependent) - * @param source Source Address to accept transmissions from (non-NULL + * @param source Source Address to accept transmissions from (non-NULL * implies Source-Specific Multicast) */ APR_DECLARE(apr_status_t) apr_mcast_join(apr_socket_t *sock, @@ -908,9 +908,9 @@ APR_DECLARE(apr_status_t) apr_mcast_join(apr_socket_t *sock, * apr_mcast_join. * @param sock The socket to leave a multicast group * @param addr The address of the multicast group to leave - * @param iface Address of the interface to use. If NULL is passed, the + * @param iface Address of the interface to use. If NULL is passed, the * default multicast interface will be used. (OS Dependent) - * @param source Source Address to accept transmissions from (non-NULL + * @param source Source Address to accept transmissions from (non-NULL * implies Source-Specific Multicast) */ APR_DECLARE(apr_status_t) apr_mcast_leave(apr_socket_t *sock, @@ -922,7 +922,7 @@ APR_DECLARE(apr_status_t) apr_mcast_leave(apr_socket_t *sock, * Set the Multicast Time to Live (ttl) for a multicast transmission. * @param sock The socket to set the multicast ttl * @param ttl Time to live to Assign. 0-255, default=1 - * @remark If the TTL is 0, packets will only be seen by sockets on + * @remark If the TTL is 0, packets will only be seen by sockets on * the local machine, and only when multicast loopback is enabled. */ APR_DECLARE(apr_status_t) apr_mcast_hops(apr_socket_t *sock, diff --git a/include/apr_optional.h b/include/apr_optional.h index e628fa0d3..6d3cef06b 100644 --- a/include/apr_optional.h +++ b/include/apr_optional.h @@ -18,7 +18,7 @@ #define APR_OPTIONAL_H #include "apu.h" -/** +/** * @file apr_optional.h * @brief APR-UTIL registration of functions exported by modules */ @@ -26,7 +26,7 @@ extern "C" { #endif -/** +/** * @defgroup APR_Util_Opt Optional Functions * @ingroup APR * @@ -52,13 +52,13 @@ typedef ret (APR_OPTIONAL_FN_TYPE(name)) args /** * XXX: This doesn't belong here, then! - * Private function! DO NOT USE! + * Private function! DO NOT USE! * @internal */ typedef void (apr_opt_fn_t)(void); /** @internal */ -APR_DECLARE_NONSTD(void) apr_dynamic_fn_register(const char *szName, +APR_DECLARE_NONSTD(void) apr_dynamic_fn_register(const char *szName, apr_opt_fn_t *pfn); /** @@ -73,7 +73,7 @@ APR_DECLARE_NONSTD(void) apr_dynamic_fn_register(const char *szName, } while (0) /** @internal - * Private function! DO NOT USE! + * Private function! DO NOT USE! */ APR_DECLARE(apr_opt_fn_t *) apr_dynamic_fn_retrieve(const char *szName); diff --git a/include/apr_optional_hooks.h b/include/apr_optional_hooks.h index ac100a248..a8a53b8c0 100644 --- a/include/apr_optional_hooks.h +++ b/include/apr_optional_hooks.h @@ -27,7 +27,7 @@ #ifdef __cplusplus extern "C" { #endif -/** +/** * @defgroup APR_Util_OPT_HOOK Optional Hook Functions * @ingroup APR_Util_Hook * @{ diff --git a/include/apr_perms_set.h b/include/apr_perms_set.h index 92a1362b8..293b49dd3 100644 --- a/include/apr_perms_set.h +++ b/include/apr_perms_set.h @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup apr_perms_set Object permission set functions - * @ingroup APR + * @ingroup APR * @{ */ diff --git a/include/apr_poll.h b/include/apr_poll.h index 3cfbfc810..9ad1c30e4 100644 --- a/include/apr_poll.h +++ b/include/apr_poll.h @@ -23,9 +23,9 @@ #include "apr.h" #include "apr_pools.h" #include "apr_errno.h" -#include "apr_inherit.h" -#include "apr_file_io.h" -#include "apr_network_io.h" +#include "apr_inherit.h" +#include "apr_file_io.h" +#include "apr_network_io.h" #if APR_HAVE_NETINET_IN_H #include <netinet/in.h> @@ -37,7 +37,7 @@ extern "C" { /** * @defgroup apr_poll Poll Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -89,7 +89,7 @@ typedef enum { } apr_pollset_method_e; /** Used in apr_pollfd_t to determine what the apr_descriptor is */ -typedef enum { +typedef enum { APR_NO_DESC, /**< nothing here */ APR_POLL_SOCKET, /**< descriptor refers to a socket */ APR_POLL_FILE, /**< descriptor refers to a file */ @@ -125,7 +125,7 @@ typedef struct apr_pollset_t apr_pollset_t; /** * Set up a pollset object - * @param pollset The pointer in which to return the newly created object + * @param pollset The pointer in which to return the newly created object * @param size The maximum number of descriptors that this pollset can hold * @param p The pool from which to allocate the pollset * @param flags Optional flags to modify the operation of the pollset. @@ -159,7 +159,7 @@ APR_DECLARE(apr_status_t) apr_pollset_create(apr_pollset_t **pollset, /** * Set up a pollset object - * @param pollset The pointer in which to return the newly created object + * @param pollset The pointer in which to return the newly created object * @param size The maximum number of descriptors that this pollset can hold * @param p The pool from which to allocate the pollset * @param flags Optional flags to modify the operation of the pollset. @@ -217,14 +217,14 @@ APR_DECLARE(apr_status_t) apr_pollset_destroy(apr_pollset_t *pollset); * with APR_EINTR. Option (1) is recommended, but option (2) is * allowed for implementations where option (1) is impossible * or impractical. - * @remark If the pollset has been created with APR_POLLSET_NOCOPY, the + * @remark If the pollset has been created with APR_POLLSET_NOCOPY, the * apr_pollfd_t structure referenced by descriptor will not be copied * and must have a lifetime at least as long as the pollset. * @remark Do not add the same socket or file descriptor to the same pollset - * multiple times, even if the requested events differ for the + * multiple times, even if the requested events differ for the * different calls to apr_pollset_add(). If the events of interest - * for a descriptor change, you must first remove the descriptor - * from the pollset with apr_pollset_remove(), then add it again + * for a descriptor change, you must first remove the descriptor + * from the pollset with apr_pollset_remove(), then add it again * specifying all requested events. */ APR_DECLARE(apr_status_t) apr_pollset_add(apr_pollset_t *pollset, @@ -284,7 +284,7 @@ APR_DECLARE(apr_status_t) apr_pollset_wakeup(apr_pollset_t *pollset); /** * Poll the descriptors in the poll structure - * @param aprset The poll structure we will be using. + * @param aprset The poll structure we will be using. * @param numsock The number of descriptors we are polling * @param nsds The number of descriptors signalled (output parameter) * @param timeout The amount of time in microseconds to wait. This is a @@ -292,14 +292,14 @@ APR_DECLARE(apr_status_t) apr_pollset_wakeup(apr_pollset_t *pollset); * function will return before this time. If timeout is * negative, the function will block until a descriptor is * signalled or until apr_pollset_wakeup() has been called. - * @remark The number of descriptors signalled is returned in the third argument. - * This is a blocking call, and it will not return until either a - * descriptor has been signalled or the timeout has expired. + * @remark The number of descriptors signalled is returned in the third argument. + * This is a blocking call, and it will not return until either a + * descriptor has been signalled or the timeout has expired. * @remark The rtnevents field in the apr_pollfd_t array will only be filled- * in if the return value is APR_SUCCESS. */ APR_DECLARE(apr_status_t) apr_poll(apr_pollfd_t *aprset, apr_int32_t numsock, - apr_int32_t *nsds, + apr_int32_t *nsds, apr_interval_time_t timeout); /** @@ -319,7 +319,7 @@ typedef struct apr_pollcb_t apr_pollcb_t; /** * Set up a pollcb object - * @param pollcb The pointer in which to return the newly created object + * @param pollcb The pointer in which to return the newly created object * @param size The maximum number of descriptors that a single _poll can return. * @param p The pool from which to allocate the pollcb * @param flags Optional flags to modify the operation of the pollcb. @@ -338,7 +338,7 @@ APR_DECLARE(apr_status_t) apr_pollcb_create(apr_pollcb_t **pollcb, /** * Set up a pollcb object - * @param pollcb The pointer in which to return the newly created object + * @param pollcb The pointer in which to return the newly created object * @param size The maximum number of descriptors that a single _poll can return. * @param p The pool from which to allocate the pollcb * @param flags Optional flags to modify the operation of the pollcb. @@ -366,14 +366,14 @@ APR_DECLARE(apr_status_t) apr_pollcb_create_ex(apr_pollcb_t **pollcb, * @remark If you set client_data in the descriptor, that value will be * returned in the client_data field whenever this descriptor is * signalled in apr_pollcb_poll(). - * @remark Unlike the apr_pollset API, the descriptor is not copied, and users + * @remark Unlike the apr_pollset API, the descriptor is not copied, and users * must retain the memory used by descriptor, as the same pointer will * be returned to them from apr_pollcb_poll. * @remark Do not add the same socket or file descriptor to the same pollcb - * multiple times, even if the requested events differ for the + * multiple times, even if the requested events differ for the * different calls to apr_pollcb_add(). If the events of interest - * for a descriptor change, you must first remove the descriptor - * from the pollcb with apr_pollcb_remove(), then add it again + * for a descriptor change, you must first remove the descriptor + * from the pollcb with apr_pollcb_remove(), then add it again * specifying all requested events. */ APR_DECLARE(apr_status_t) apr_pollcb_add(apr_pollcb_t *pollcb, @@ -391,9 +391,9 @@ APR_DECLARE(apr_status_t) apr_pollcb_remove(apr_pollcb_t *pollcb, apr_pollfd_t *descriptor); /** - * Function prototype for pollcb handlers + * Function prototype for pollcb handlers * @param baton Opaque baton passed into apr_pollcb_poll() - * @param descriptor Contains the notification for an active descriptor. + * @param descriptor Contains the notification for an active descriptor. * The @a rtnevents member describes which events were triggered * for this descriptor. * @remark If the pollcb handler does not return APR_SUCCESS, the apr_pollcb_poll() diff --git a/include/apr_pools.h b/include/apr_pools.h index ad92aa852..fa09872ed 100644 --- a/include/apr_pools.h +++ b/include/apr_pools.h @@ -52,7 +52,7 @@ extern "C" { /** * @defgroup apr_pools Memory Pool Functions - * @ingroup APR + * @ingroup APR * @{ */ @@ -73,7 +73,7 @@ typedef struct apr_pool_t apr_pool_t; * becomes: * APR_DECLARE(apr_pool_t *) apr_file_pool_get(const apr_file_t *thefile); * </pre> - * @remark Doxygen unwraps this macro (via doxygen.conf) to provide + * @remark Doxygen unwraps this macro (via doxygen.conf) to provide * actual help for each specific occurrence of apr_foo_pool_get. * @remark the linkage is specified for APR. It would be possible to expand * the macros to support other linkages. @@ -82,7 +82,7 @@ typedef struct apr_pool_t apr_pool_t; APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \ (const apr_##type##_t *the##type) -/** +/** * Implementation helper macro to provide apr_foo_pool_get()s. * * In the implementation, the APR_POOL_IMPLEMENT_ACCESSOR() is used to @@ -629,7 +629,7 @@ APR_DECLARE(void) apr_pool_pre_cleanup_register( /** * Remove a previously registered cleanup function. - * + * * The cleanup most recently registered with @a p having the same values of * @a data and @a cleanup will be removed. * @@ -645,7 +645,7 @@ APR_DECLARE(void) apr_pool_cleanup_kill(apr_pool_t *p, const void *data, /** * Replace the child cleanup function of a previously registered cleanup. - * + * * The cleanup most recently registered with @a p having the same values of * @a data and @a plain_cleanup will have the registered child cleanup * function replaced with @a child_cleanup. @@ -678,7 +678,7 @@ APR_DECLARE(apr_status_t) apr_pool_cleanup_run(apr_pool_t *p, void *data, /** * An empty cleanup function. - * + * * Passed to apr_pool_cleanup_register() when no cleanup is required. * * @param data The data to cleanup, will not be used by this function. diff --git a/include/apr_portable.h b/include/apr_portable.h index 800a50dbc..2b8a422aa 100644 --- a/include/apr_portable.h +++ b/include/apr_portable.h @@ -15,7 +15,7 @@ */ /* This header file is where you should put ANY platform specific information. - * This should be the only header file that programs need to include that + * This should be the only header file that programs need to include that * actually has platform dependent code which refers to the . */ #ifndef APR_PORTABLE_H @@ -56,7 +56,7 @@ extern "C" { /** * @defgroup apr_portabile Portability Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -68,7 +68,7 @@ typedef SOCKET apr_os_sock_t; typedef HANDLE apr_os_proc_mutex_t; typedef HANDLE apr_os_thread_t; typedef HANDLE apr_os_proc_t; -typedef DWORD apr_os_threadkey_t; +typedef DWORD apr_os_threadkey_t; typedef FILETIME apr_os_imp_time_t; typedef SYSTEMTIME apr_os_exp_time_t; typedef HANDLE apr_os_dso_handle_t; @@ -81,7 +81,7 @@ typedef int apr_os_sock_t; typedef HMTX apr_os_proc_mutex_t; typedef TID apr_os_thread_t; typedef PID apr_os_proc_t; -typedef PULONG apr_os_threadkey_t; +typedef PULONG apr_os_threadkey_t; typedef struct timeval apr_os_imp_time_t; typedef struct tm apr_os_exp_time_t; typedef HMODULE apr_os_dso_handle_t; @@ -115,7 +115,7 @@ typedef int apr_os_sock_t; typedef NXMutex_t * apr_os_proc_mutex_t; typedef NXThreadId_t apr_os_thread_t; typedef long apr_os_proc_t; -typedef NXKey_t apr_os_threadkey_t; +typedef NXKey_t apr_os_threadkey_t; typedef struct timeval apr_os_imp_time_t; typedef struct tm apr_os_exp_time_t; typedef void * apr_os_dso_handle_t; @@ -148,7 +148,7 @@ typedef int apr_os_sock_t; /**< native dir */ typedef struct apr_os_proc_mutex_t apr_os_proc_mutex_t; /**< native process * mutex */ -#if APR_HAS_THREADS && APR_HAVE_PTHREAD_H +#if APR_HAS_THREADS && APR_HAVE_PTHREAD_H typedef pthread_t apr_os_thread_t; /**< native thread */ typedef pthread_key_t apr_os_threadkey_t; /**< native thread address * space */ @@ -209,7 +209,7 @@ typedef struct apr_os_sock_info_t apr_os_sock_info_t; }; typedef struct apr_os_global_mutex_t apr_os_global_mutex_t; -APR_DECLARE(apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmutex, +APR_DECLARE(apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmutex, apr_global_mutex_t *pmutex); #endif @@ -218,7 +218,7 @@ APR_DECLARE(apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmute * convert the file from apr type to os specific type. * @param thefile The os specific file we are converting to * @param file The apr file to convert. - * @remark On Unix, it is only possible to get a file descriptor from + * @remark On Unix, it is only possible to get a file descriptor from * an apr file type. */ APR_DECLARE(apr_status_t) apr_os_file_get(apr_os_file_t *thefile, @@ -228,8 +228,8 @@ APR_DECLARE(apr_status_t) apr_os_file_get(apr_os_file_t *thefile, * convert the dir from apr type to os specific type. * @param thedir The os specific dir we are converting to * @param dir The apr dir to convert. - */ -APR_DECLARE(apr_status_t) apr_os_dir_get(apr_os_dir_t **thedir, + */ +APR_DECLARE(apr_status_t) apr_os_dir_get(apr_os_dir_t **thedir, apr_dir_t *dir); /** @@ -245,7 +245,7 @@ APR_DECLARE(apr_status_t) apr_os_sock_get(apr_os_sock_t *thesock, * @param ospmutex The os specific proc mutex we are converting to. * @param pmutex The apr proc mutex to convert. */ -APR_DECLARE(apr_status_t) apr_os_proc_mutex_get(apr_os_proc_mutex_t *ospmutex, +APR_DECLARE(apr_status_t) apr_os_proc_mutex_get(apr_os_proc_mutex_t *ospmutex, apr_proc_mutex_t *pmutex); /** @@ -257,7 +257,7 @@ APR_DECLARE(apr_status_t) apr_os_proc_mutex_get(apr_os_proc_mutex_t *ospmutex, * @remark Allows for disambiguation for platforms with multiple mechanisms * available. */ -APR_DECLARE(apr_status_t) apr_os_proc_mutex_get_ex(apr_os_proc_mutex_t *ospmutex, +APR_DECLARE(apr_status_t) apr_os_proc_mutex_get_ex(apr_os_proc_mutex_t *ospmutex, apr_proc_mutex_t *pmutex, apr_lockmech_e *mech); @@ -274,28 +274,28 @@ APR_DECLARE(apr_status_t) apr_os_exp_time_get(apr_os_exp_time_t **ostime, * @param ostime the native time format * @param aprtime the time to convert */ -APR_DECLARE(apr_status_t) apr_os_imp_time_get(apr_os_imp_time_t **ostime, +APR_DECLARE(apr_status_t) apr_os_imp_time_get(apr_os_imp_time_t **ostime, apr_time_t *aprtime); /** * convert the shm from apr type to os specific type. * @param osshm The os specific shm representation * @param shm The apr shm to convert. - */ + */ APR_DECLARE(apr_status_t) apr_os_shm_get(apr_os_shm_t *osshm, apr_shm_t *shm); #if APR_HAS_THREADS || defined(DOXYGEN) -/** +/** * @defgroup apr_os_thread Thread portability Routines - * @{ + * @{ */ /** * convert the thread to os specific type from apr type. * @param thethd The apr thread to convert * @param thd The os specific thread we are converting to */ -APR_DECLARE(apr_status_t) apr_os_thread_get(apr_os_thread_t **thethd, +APR_DECLARE(apr_status_t) apr_os_thread_get(apr_os_thread_t **thethd, apr_thread_t *thd); /** @@ -335,8 +335,8 @@ APR_DECLARE(apr_os_thread_t) apr_os_thread_current(void); * @param tid1 1st Thread ID to compare * @param tid2 2nd Thread ID to compare * @return non-zero if the two threads are equal, zero otherwise - */ -APR_DECLARE(int) apr_os_thread_equal(apr_os_thread_t tid1, + */ +APR_DECLARE(int) apr_os_thread_equal(apr_os_thread_t tid1, apr_os_thread_t tid2); /** @} */ @@ -353,7 +353,7 @@ APR_DECLARE(int) apr_os_thread_equal(apr_os_thread_t tid1, */ APR_DECLARE(apr_status_t) apr_os_file_put(apr_file_t **file, apr_os_file_t *thefile, - apr_int32_t flags, apr_pool_t *cont); + apr_int32_t flags, apr_pool_t *cont); /** * convert the file from os specific type to apr type. @@ -390,12 +390,12 @@ APR_DECLARE(apr_status_t) apr_os_pipe_put_ex(apr_file_t **file, */ APR_DECLARE(apr_status_t) apr_os_dir_put(apr_dir_t **dir, apr_os_dir_t *thedir, - apr_pool_t *cont); + apr_pool_t *cont); /** * Convert a socket from the os specific type to the APR type. If * sock points to NULL, a socket will be created from the pool - * provided. If **sock does not point to NULL, the structure pointed + * provided. If **sock does not point to NULL, the structure pointed * to by sock will be reused and updated with the given socket. * @param sock The pool to use. * @param thesock The socket to convert to. @@ -403,8 +403,8 @@ APR_DECLARE(apr_status_t) apr_os_dir_put(apr_dir_t **dir, * @remark If it is a true socket, it is best to call apr_os_sock_make() * and provide APR with more information about the socket. */ -APR_DECLARE(apr_status_t) apr_os_sock_put(apr_socket_t **sock, - apr_os_sock_t *thesock, +APR_DECLARE(apr_status_t) apr_os_sock_put(apr_socket_t **sock, + apr_os_sock_t *thesock, apr_pool_t *cont); /** @@ -429,7 +429,7 @@ APR_DECLARE(apr_status_t) apr_os_sock_make(apr_socket_t **apr_sock, */ APR_DECLARE(apr_status_t) apr_os_proc_mutex_put(apr_proc_mutex_t **pmutex, apr_os_proc_mutex_t *ospmutex, - apr_pool_t *cont); + apr_pool_t *cont); /** * Convert the proc mutex from os specific type to apr type, using the @@ -447,7 +447,7 @@ APR_DECLARE(apr_status_t) apr_os_proc_mutex_put_ex(apr_proc_mutex_t **pmutex, apr_os_proc_mutex_t *ospmutex, apr_lockmech_e mech, int register_cleanup, - apr_pool_t *cont); + apr_pool_t *cont); /** * Put the imploded time in the APR format. @@ -457,7 +457,7 @@ APR_DECLARE(apr_status_t) apr_os_proc_mutex_put_ex(apr_proc_mutex_t **pmutex, */ APR_DECLARE(apr_status_t) apr_os_imp_time_put(apr_time_t *aprtime, apr_os_imp_time_t **ostime, - apr_pool_t *cont); + apr_pool_t *cont); /** * Put the exploded time in the APR format. @@ -467,7 +467,7 @@ APR_DECLARE(apr_status_t) apr_os_imp_time_put(apr_time_t *aprtime, */ APR_DECLARE(apr_status_t) apr_os_exp_time_put(apr_time_exp_t *aprtime, apr_os_exp_time_t **ostime, - apr_pool_t *cont); + apr_pool_t *cont); /** * convert the shared memory from os specific type to apr type. @@ -480,11 +480,11 @@ APR_DECLARE(apr_status_t) apr_os_exp_time_put(apr_time_exp_t *aprtime, */ APR_DECLARE(apr_status_t) apr_os_shm_put(apr_shm_t **shm, apr_os_shm_t *osshm, - apr_pool_t *cont); + apr_pool_t *cont); #if APR_HAS_DSO || defined(DOXYGEN) -/** +/** * @defgroup apr_os_dso DSO (Dynamic Loading) Portability Routines * @{ */ diff --git a/include/apr_proc_mutex.h b/include/apr_proc_mutex.h index 418c95048..67e02c842 100644 --- a/include/apr_proc_mutex.h +++ b/include/apr_proc_mutex.h @@ -34,11 +34,11 @@ extern "C" { /** * @defgroup apr_proc_mutex Process Locking Routines - * @ingroup APR + * @ingroup APR * @{ */ -/** +/** * Enumerated potential types for APR process locking methods * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable. @@ -89,7 +89,7 @@ APR_DECLARE(apr_status_t) apr_proc_mutex_create(apr_proc_mutex_t **mutex, * @param mutex The newly re-opened mutex structure. * @param fname A file name to use if the mutex mechanism requires one. This * argument should always be provided. The mutex code itself will - * determine if it should be used. This filename should be the + * determine if it should be used. This filename should be the * same one that was passed to apr_proc_mutex_create(). * @param pool The pool to operate on. * @remark This function must be called to maintain portability, even diff --git a/include/apr_queue.h b/include/apr_queue.h index e345da5d4..186e50aa1 100644 --- a/include/apr_queue.h +++ b/include/apr_queue.h @@ -47,14 +47,14 @@ extern "C" { */ typedef struct apr_queue_t apr_queue_t; -/** +/** * create a FIFO queue * @param queue The new queue * @param queue_capacity maximum size of the queue * @param a pool to allocate queue from */ -APR_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, - unsigned int queue_capacity, +APR_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, + unsigned int queue_capacity, apr_pool_t *a); /** diff --git a/include/apr_redis.h b/include/apr_redis.h index 6333ae0e6..d8a7fc62f 100644 --- a/include/apr_redis.h +++ b/include/apr_redis.h @@ -256,7 +256,7 @@ APR_DECLARE(apr_status_t) apr_redis_create(apr_pool_t *p, * @param baton location of the allocated value * @param len length of data at baton * @param flags any flags set by the client for this key - * @return + * @return */ APR_DECLARE(apr_status_t) apr_redis_getp(apr_redis_t *rc, apr_pool_t *p, diff --git a/include/apr_reslist.h b/include/apr_reslist.h index 85e525821..41ee490a2 100644 --- a/include/apr_reslist.h +++ b/include/apr_reslist.h @@ -17,7 +17,7 @@ #ifndef APR_RESLIST_H #define APR_RESLIST_H -/** +/** * @file apr_reslist.h * @brief APR-UTIL Resource List Routines */ diff --git a/include/apr_ring.h b/include/apr_ring.h index f45e80199..1cad0a3d6 100644 --- a/include/apr_ring.h +++ b/include/apr_ring.h @@ -39,7 +39,7 @@ /** * @defgroup apr_ring Ring Macro Implementations - * @ingroup APR + * @ingroup APR * A ring is a kind of doubly-linked list that can be manipulated * without knowing where its head is. * @{ @@ -512,6 +512,6 @@ #define APR_RING_CHECK_ELEM_CONSISTENCY(ep, elem, link) #endif -/** @} */ +/** @} */ #endif /* !APR_RING_H */ diff --git a/include/apr_rmm.h b/include/apr_rmm.h index cdb7e39d7..b1be295ad 100644 --- a/include/apr_rmm.h +++ b/include/apr_rmm.h @@ -16,7 +16,7 @@ #ifndef APR_RMM_H #define APR_RMM_H -/** +/** * @file apr_rmm.h * @brief APR-UTIL Relocatable Memory Management Routines */ @@ -54,7 +54,7 @@ typedef apr_size_t apr_rmm_off_t; * (for instance using APR_ALIGN_DEFAULT). */ APR_DECLARE(apr_status_t) apr_rmm_init(apr_rmm_t **rmm, apr_anylock_t *lock, - void *membuf, apr_size_t memsize, + void *membuf, apr_size_t memsize, apr_pool_t *cont); /** diff --git a/include/apr_sdbm.h b/include/apr_sdbm.h index 632ee2386..9fb57afc4 100644 --- a/include/apr_sdbm.h +++ b/include/apr_sdbm.h @@ -28,7 +28,7 @@ #include "apr_errno.h" #include "apr_file_io.h" /* for apr_fileperms_t */ -/** +/** * @file apr_sdbm.h * @brief apr-util SDBM library */ @@ -81,11 +81,11 @@ typedef struct { * </PRE> * @param perms Permissions to apply to if created * @param p The pool to use when creating the sdbm - * @remark The sdbm name is not a true file name, as sdbm appends suffixes + * @remark The sdbm name is not a true file name, as sdbm appends suffixes * for seperate data and index files. */ -APR_DECLARE(apr_status_t) apr_sdbm_open(apr_sdbm_t **db, const char *name, - apr_int32_t mode, +APR_DECLARE(apr_status_t) apr_sdbm_open(apr_sdbm_t **db, const char *name, + apr_int32_t mode, apr_fileperms_t perms, apr_pool_t *p); /** @@ -103,8 +103,8 @@ APR_DECLARE(apr_status_t) apr_sdbm_close(apr_sdbm_t *db); * APR_FLOCK_EXCLUSIVE * </PRE> * @remark Calls to apr_sdbm_lock may be nested. All apr_sdbm functions - * perform implicit locking. Since an APR_FLOCK_SHARED lock cannot be - * portably promoted to an APR_FLOCK_EXCLUSIVE lock, apr_sdbm_store and + * perform implicit locking. Since an APR_FLOCK_SHARED lock cannot be + * portably promoted to an APR_FLOCK_EXCLUSIVE lock, apr_sdbm_store and * apr_sdbm_delete calls will fail if an APR_FLOCK_SHARED lock is held. * The apr_sdbm_lock call requires the database to be opened with the * APR_FOPEN_SHARELOCK mode value. @@ -119,17 +119,17 @@ APR_DECLARE(apr_status_t) apr_sdbm_unlock(apr_sdbm_t *db); /** * Fetch an sdbm record value by key - * @param db The database + * @param db The database * @param value The value datum retrieved for this record * @param key The key datum to find this record */ -APR_DECLARE(apr_status_t) apr_sdbm_fetch(apr_sdbm_t *db, - apr_sdbm_datum_t *value, +APR_DECLARE(apr_status_t) apr_sdbm_fetch(apr_sdbm_t *db, + apr_sdbm_datum_t *value, apr_sdbm_datum_t key); /** * Store an sdbm record value by key - * @param db The database + * @param db The database * @param key The key datum to store this record by * @param value The value datum to store in this record * @param opt The method used to store the record @@ -143,16 +143,16 @@ APR_DECLARE(apr_status_t) apr_sdbm_store(apr_sdbm_t *db, apr_sdbm_datum_t key, /** * Delete an sdbm record value by key - * @param db The database + * @param db The database * @param key The key datum of the record to delete * @remark It is not an error to delete a non-existent record. */ -APR_DECLARE(apr_status_t) apr_sdbm_delete(apr_sdbm_t *db, +APR_DECLARE(apr_status_t) apr_sdbm_delete(apr_sdbm_t *db, const apr_sdbm_datum_t key); /** * Retrieve the first record key from a dbm - * @param db The database + * @param db The database * @param key The key datum of the first record * @remark The keys returned are not ordered. To traverse the list of keys * for an sdbm opened with APR_FOPEN_SHARELOCK, the caller must use apr_sdbm_lock @@ -163,7 +163,7 @@ APR_DECLARE(apr_status_t) apr_sdbm_firstkey(apr_sdbm_t *db, apr_sdbm_datum_t *ke /** * Retrieve the next record key from an sdbm - * @param db The database + * @param db The database * @param key The key datum of the next record */ APR_DECLARE(apr_status_t) apr_sdbm_nextkey(apr_sdbm_t *db, apr_sdbm_datum_t *key); diff --git a/include/apr_sha1.h b/include/apr_sha1.h index c7ba3cf3c..d98f2f9e4 100644 --- a/include/apr_sha1.h +++ b/include/apr_sha1.h @@ -50,7 +50,7 @@ extern "C" { /** @see apr_sha1_ctx_t */ typedef struct apr_sha1_ctx_t apr_sha1_ctx_t; -/** +/** * SHA1 context structure */ struct apr_sha1_ctx_t { diff --git a/include/apr_shm.h b/include/apr_shm.h index 635c654b1..aab8f54a8 100644 --- a/include/apr_shm.h +++ b/include/apr_shm.h @@ -33,7 +33,7 @@ extern "C" { /** * @defgroup apr_shm Shared Memory Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -65,7 +65,7 @@ typedef struct apr_shm_t apr_shm_t; * implementation to request a slightly greater segment length * from the subsystem. In all cases, the apr_shm_baseaddr_get() * function will return the first usable byte of memory. - * + * */ APR_DECLARE(apr_status_t) apr_shm_create(apr_shm_t **m, apr_size_t reqsize, @@ -110,7 +110,7 @@ APR_DECLARE(apr_status_t) apr_shm_create(apr_shm_t **m, * implementation to request a slightly greater segment length * from the subsystem. In all cases, the apr_shm_baseaddr_get() * function will return the first usable byte of memory. - * + * */ APR_DECLARE(apr_status_t) apr_shm_create_ex(apr_shm_t **m, apr_size_t reqsize, @@ -220,7 +220,7 @@ APR_PERMS_SET_IMPLEMENT(shm); */ APR_POOL_DECLARE_ACCESSOR(shm); -/** @} */ +/** @} */ #ifdef __cplusplus } diff --git a/include/apr_skiplist.h b/include/apr_skiplist.h index eeab10bf9..956a2dbf7 100644 --- a/include/apr_skiplist.h +++ b/include/apr_skiplist.h @@ -38,7 +38,7 @@ extern "C" { */ /** - * apr_skiplist_compare is the function type that must be implemented + * apr_skiplist_compare is the function type that must be implemented * per object type that is used in a skip list for comparisons to maintain * order * */ @@ -55,7 +55,7 @@ struct apr_skiplist; /** Opaque structure used to represent the skip list */ typedef struct apr_skiplist apr_skiplist; -/** +/** * Opaque structure used to represent abstract nodes in the skip list * (an abstraction above the raw elements which are collected in the * skip list). diff --git a/include/apr_strings.h b/include/apr_strings.h index 56f0426fc..f38d277e3 100644 --- a/include/apr_strings.h +++ b/include/apr_strings.h @@ -61,7 +61,7 @@ extern "C" { /** * @defgroup apr_strings String routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -76,7 +76,7 @@ extern "C" { APR_DECLARE(int) apr_strnatcmp(char const *a, char const *b); /** - * Do a natural order comparison of two strings ignoring the case of the + * Do a natural order comparison of two strings ignoring the case of the * strings. * @param a The first string to compare * @param b The second string to compare @@ -113,7 +113,7 @@ APR_DECLARE(char *) apr_pstrmemdup(apr_pool_t *p, const char *s, apr_size_t n) ; /** - * Duplicate at most n characters of a string into memory allocated + * Duplicate at most n characters of a string into memory allocated * out of a pool; the new string will be NUL-terminated * @param p The pool to allocate out of * @param s The string to duplicate @@ -162,7 +162,7 @@ APR_DECLARE(char *) apr_pstrcatv(apr_pool_t *p, const struct iovec *vec, apr_size_t nvec, apr_size_t *nbytes); /** - * printf-style style printing routine. The data is output to a string + * printf-style style printing routine. The data is output to a string * allocated from a pool * @param p The pool to allocate out of * @param fmt The format of the string @@ -172,7 +172,7 @@ APR_DECLARE(char *) apr_pstrcatv(apr_pool_t *p, const struct iovec *vec, APR_DECLARE(char *) apr_pvsprintf(apr_pool_t *p, const char *fmt, va_list ap); /** - * printf-style style printing routine. The data is output to a string + * printf-style style printing routine. The data is output to a string * allocated from a pool * @param p The pool to allocate out of * @param fmt The format of the string @@ -207,10 +207,10 @@ APR_DECLARE(apr_status_t) apr_memzero_explicit(void *buffer, apr_size_t size); * <PRE> * Note the differences between this function and strncpy(): * 1) strncpy() doesn't always NUL terminate; apr_cpystrn() does. - * 2) strncpy() pads the destination string with NULs, which is often + * 2) strncpy() pads the destination string with NULs, which is often * unnecessary; apr_cpystrn() does not. * 3) strncpy() returns a pointer to the beginning of the dst string; - * apr_cpystrn() returns a pointer to the NUL terminator of dst, + * apr_cpystrn() returns a pointer to the NUL terminator of dst, * to allow a check for truncation. * </PRE> */ @@ -227,7 +227,7 @@ APR_DECLARE(char *) apr_cpystrn(char *dst, const char *src, APR_DECLARE(char *) apr_collapse_spaces(char *dest, const char *src); /** - * Convert the arguments to a program from one string to an array of + * Convert the arguments to a program from one string to an array of * strings terminated by a NULL pointer * @param arg_str The arguments to convert * @param argv_out Output location. This is a pointer to an array of strings. @@ -238,7 +238,7 @@ APR_DECLARE(apr_status_t) apr_tokenize_to_argv(const char *arg_str, apr_pool_t *token_context); /** - * Split a string into separate null-terminated tokens. The tokens are + * Split a string into separate null-terminated tokens. The tokens are * delimited in the string by one or more characters from the sep * argument. * @param str The string to separate; this should be specified on the @@ -342,7 +342,7 @@ APR_DECLARE(char *) apr_off_t_toa(apr_pool_t *p, apr_off_t n); * @bug *end breaks type safety; where *buf is const, *end needs to be * declared as const in APR 2.0 */ -APR_DECLARE(apr_status_t) apr_strtoff(apr_off_t *offset, const char *buf, +APR_DECLARE(apr_status_t) apr_strtoff(apr_off_t *offset, const char *buf, char **end, int base); /** diff --git a/include/apr_tables.h b/include/apr_tables.h index 7ce2adaf4..788a771a9 100644 --- a/include/apr_tables.h +++ b/include/apr_tables.h @@ -35,7 +35,7 @@ extern "C" { /** * @defgroup apr_tables Table and Array Functions - * @ingroup APR + * @ingroup APR * Arrays are used to store data which is referenced sequentially or * as a stack. Functions are provided to push and pop individual * elements as well as to operate on the entire array. @@ -167,7 +167,7 @@ APR_DECLARE(void) apr_array_clear(apr_array_header_t *arr); /** * Concatenate two arrays together. - * @param dst The destination array, and the one to go first in the combined + * @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 */ @@ -179,7 +179,7 @@ APR_DECLARE(void) apr_array_cat(apr_array_header_t *dst, * @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 - * @remark The alternate apr_array_copy_hdr() copies only the header, and arranges + * @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. */ @@ -208,10 +208,10 @@ APR_DECLARE(apr_array_header_t *) apr_array_append(apr_pool_t *p, const apr_array_header_t *second); /** - * Generate a new string from the apr_pool_t containing the concatenated - * sequence of substrings referenced as elements within the array. The string - * will be empty if all substrings are empty or null, or if there are no - * elements in the array. If sep is non-NUL, it will be inserted between + * Generate a new string from the apr_pool_t containing the concatenated + * sequence of substrings referenced as elements within the array. The string + * will be empty if all substrings are empty or null, or if there are no + * elements in the array. If sep is non-NUL, it will be inserted between * elements as a separator. * @param p The pool to allocate the string out of * @param arr The array to generate the string from @@ -263,7 +263,7 @@ APR_DECLARE(void) apr_table_clear(apr_table_t *t); * the data is still in the table. * @param t The table to search for the key * @param key The key to search for (case does not matter) - * @return The value associated with the key, or NULL if the key does not exist. + * @return The value associated with the key, or NULL if the key does not exist. */ APR_DECLARE(const char *) apr_table_get(const apr_table_t *t, const char *key); @@ -297,8 +297,8 @@ APR_DECLARE(void) apr_table_set(apr_table_t *t, const char *key, * @param t The table to add the data to. * @param key The key to use (case does not matter) * @param val The value to add - * @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 + * @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, @@ -312,7 +312,7 @@ APR_DECLARE(void) apr_table_setn(apr_table_t *t, const char *key, APR_DECLARE(void) apr_table_unset(apr_table_t *t, const char *key); /** - * Add data to a table by merging the value with data that has already been + * Add data to a table by merging the value with data that has already been * stored. The merging is done by concatenating the two values, separated * by the string ", ". * @param t The table to search for the data @@ -324,7 +324,7 @@ APR_DECLARE(void) apr_table_merge(apr_table_t *t, const char *key, const char *val); /** - * Add data to a table by merging the value with data that has already been + * Add data to a table by merging the value with data that has already been * stored. The merging is done by concatenating the two values, separated * by the string ", ". * @param t The table to search for the data @@ -354,7 +354,7 @@ APR_DECLARE(void) apr_table_add(apr_table_t *t, const char *key, * @param key The key to use * @param val The value to add. * @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 + * 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, @@ -378,14 +378,14 @@ APR_DECLARE(apr_table_t *) apr_table_overlay(apr_pool_t *p, * @param key The key from this iteration of the table * @param value The value from this iteration of the table * @remark Iteration continues while this callback function returns non-zero. - * To export the callback function for apr_table_[v]do() it must be declared + * To export the callback function for apr_table_[v]do() it must be declared * in the _NONSTD convention. * @see apr_table_do @see apr_table_vdo */ -typedef int (apr_table_do_callback_fn_t)(void *rec, const char *key, +typedef int (apr_table_do_callback_fn_t)(void *rec, const char *key, const char *value); -/** +/** * Iterate over a table running the provided function once for every * element in the table. The varargs array must be a list of zero or * more (char *) keys followed by a NULL pointer. If zero keys are @@ -411,7 +411,7 @@ APR_DECLARE_NONSTD(int) apr_table_do(apr_table_do_callback_fn_t *comp, #endif ; -/** +/** * Iterate over a table running the provided function once for every * element in the table. The @p vp varargs parameter must be a * list of zero or more (char *) keys followed by a NULL pointer. If diff --git a/include/apr_thread_cond.h b/include/apr_thread_cond.h index 199f1dedc..a90b5e38b 100644 --- a/include/apr_thread_cond.h +++ b/include/apr_thread_cond.h @@ -36,7 +36,7 @@ extern "C" { /** * @defgroup apr_thread_cond Condition Variable Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -88,8 +88,8 @@ APR_DECLARE(apr_status_t) apr_thread_cond_wait(apr_thread_cond_t *cond, * @param mutex the mutex that must be locked upon entering this function, * is released while the thread is asleep, and is again acquired before * returning from this function. - * @param timeout The amount of time in microseconds to wait. This is - * a maximum, not a minimum. If the condition is signaled, we + * @param timeout The amount of time in microseconds to wait. This is + * a maximum, not a minimum. If the condition is signaled, we * will wake up before this time, otherwise the error APR_TIMEUP * is returned. */ diff --git a/include/apr_thread_mutex.h b/include/apr_thread_mutex.h index 8eb617291..c008d0782 100644 --- a/include/apr_thread_mutex.h +++ b/include/apr_thread_mutex.h @@ -33,7 +33,7 @@ extern "C" { /** * @defgroup apr_thread_mutex Thread Mutex Routines - * @ingroup APR + * @ingroup APR * @{ */ diff --git a/include/apr_thread_proc.h b/include/apr_thread_proc.h index 07571b6a1..b9a7dd1fc 100644 --- a/include/apr_thread_proc.h +++ b/include/apr_thread_proc.h @@ -39,7 +39,7 @@ extern "C" { /** * @defgroup apr_thread_proc Threads and Process Functions - * @ingroup APR + * @ingroup APR * @{ */ @@ -94,7 +94,7 @@ typedef enum { /** @see apr_file_pipe_create_ex */ #define APR_WRITE_BLOCK 4 -/** @see apr_procattr_io_set +/** @see apr_procattr_io_set * @note Win32 only effective with version 1.2.12, portably introduced in 1.3.0 */ #define APR_NO_FILE 8 @@ -124,7 +124,7 @@ typedef enum { * kill the child) */ #define APR_OC_REASON_LOST 4 /**< somehow the child exited without * us knowing ... buggy os? */ -#define APR_OC_REASON_RUNNING 5 /**< a health check is occurring, +#define APR_OC_REASON_RUNNING 5 /**< a health check is occurring, * for most maintainence functions * this is a no-op. */ @@ -141,7 +141,7 @@ typedef struct apr_proc_t { /** Parent's side of pipe to child's stdouterr */ apr_file_t *err; #if APR_HAS_PROC_INVOKED || defined(DOXYGEN) - /** Diagnositics/debugging string of the command invoked for + /** Diagnositics/debugging string of the command invoked for * this process [only present if APR_HAS_PROC_INVOKED is true] * @remark Only enabled on Win32 by default. * @bug This should either always or never be present in release @@ -237,28 +237,28 @@ typedef enum { * @param new_attr The newly created threadattr. * @param cont The pool to use */ -APR_DECLARE(apr_status_t) apr_threadattr_create(apr_threadattr_t **new_attr, +APR_DECLARE(apr_status_t) apr_threadattr_create(apr_threadattr_t **new_attr, apr_pool_t *cont); /** * Set if newly created threads should be created in detached state. - * @param attr The threadattr to affect + * @param attr The threadattr to affect * @param on Non-zero if detached threads should be created. */ -APR_DECLARE(apr_status_t) apr_threadattr_detach_set(apr_threadattr_t *attr, +APR_DECLARE(apr_status_t) apr_threadattr_detach_set(apr_threadattr_t *attr, apr_int32_t on); /** * Get the detach state for this threadattr. * @param attr The threadattr to reference * @return APR_DETACH if threads are to be detached, or APR_NOTDETACH - * if threads are to be joinable. + * if threads are to be joinable. */ APR_DECLARE(apr_status_t) apr_threadattr_detach_get(apr_threadattr_t *attr); /** * Set the stack size of newly created threads. - * @param attr The threadattr to affect + * @param attr The threadattr to affect * @param stacksize The stack size in bytes */ APR_DECLARE(apr_status_t) apr_threadattr_stacksize_set(apr_threadattr_t *attr, @@ -266,7 +266,7 @@ APR_DECLARE(apr_status_t) apr_threadattr_stacksize_set(apr_threadattr_t *attr, /** * Set the stack guard area size of newly created threads. - * @param attr The threadattr to affect + * @param attr The threadattr to affect * @param guardsize The stack guard area size in bytes * @note Thread library implementations commonly use a "guard area" * after each thread's stack which is not readable or writable such that @@ -280,10 +280,10 @@ APR_DECLARE(apr_status_t) apr_threadattr_guardsize_set(apr_threadattr_t *attr, /** * Set the threshold at which the thread pool allocator should start * giving blocks back to the system. - * @param attr The threadattr to affect + * @param attr The threadattr to affect * @param on Non-zero if detached threads should be created. */ -APR_DECLARE(apr_status_t) apr_threadattr_max_free_set(apr_threadattr_t *attr, +APR_DECLARE(apr_status_t) apr_threadattr_max_free_set(apr_threadattr_t *attr, apr_size_t size); /** @@ -294,9 +294,9 @@ APR_DECLARE(apr_status_t) apr_threadattr_max_free_set(apr_threadattr_t *attr, * @param data Any data to be passed to the starting function * @param cont The pool to use */ -APR_DECLARE(apr_status_t) apr_thread_create(apr_thread_t **new_thread, - apr_threadattr_t *attr, - apr_thread_start_t func, +APR_DECLARE(apr_status_t) apr_thread_create(apr_thread_t **new_thread, + apr_threadattr_t *attr, + apr_thread_start_t func, void *data, apr_pool_t *cont); /** @@ -336,8 +336,8 @@ APR_DECLARE(void) apr_thread_exit(apr_thread_t *thd, apr_status_t retval) * @param retval The return value from the dead thread. * @param thd The thread to join */ -APR_DECLARE(apr_status_t) apr_thread_join(apr_status_t *retval, - apr_thread_t *thd); +APR_DECLARE(apr_status_t) apr_thread_join(apr_status_t *retval, + apr_thread_t *thd); /** * force the current thread to yield the processor @@ -367,7 +367,7 @@ APR_DECLARE(apr_status_t) apr_thread_once(apr_thread_once_t *control, /** * detach a thread - * @param thd The thread to detach + * @param thd The thread to detach */ APR_DECLARE(apr_status_t) apr_thread_detach(apr_thread_t *thd); @@ -397,29 +397,29 @@ APR_DECLARE(apr_status_t) apr_thread_data_set(void *data, const char *key, * @param dest The destructor to use when freeing the private memory. * @param cont The pool to use */ -APR_DECLARE(apr_status_t) apr_threadkey_private_create(apr_threadkey_t **key, +APR_DECLARE(apr_status_t) apr_threadkey_private_create(apr_threadkey_t **key, void (*dest)(void *), apr_pool_t *cont); /** * Get a pointer to the thread private memory - * @param new_mem The data stored in private memory - * @param key The handle for the desired thread private memory + * @param new_mem The data stored in private memory + * @param key The handle for the desired thread private memory */ -APR_DECLARE(apr_status_t) apr_threadkey_private_get(void **new_mem, +APR_DECLARE(apr_status_t) apr_threadkey_private_get(void **new_mem, apr_threadkey_t *key); /** * Set the data to be stored in thread private memory - * @param priv The data to be stored in private memory - * @param key The handle for the desired thread private memory + * @param priv The data to be stored in private memory + * @param key The handle for the desired thread private memory */ -APR_DECLARE(apr_status_t) apr_threadkey_private_set(void *priv, +APR_DECLARE(apr_status_t) apr_threadkey_private_set(void *priv, apr_threadkey_t *key); /** * Free the thread private memory - * @param key The handle for the desired thread private memory + * @param key The handle for the desired thread private memory */ APR_DECLARE(apr_status_t) apr_threadkey_private_delete(apr_threadkey_t *key); @@ -451,39 +451,39 @@ APR_DECLARE(apr_status_t) apr_threadkey_data_set(void *data, const char *key, /** * Create and initialize a new procattr variable - * @param new_attr The newly created procattr. + * @param new_attr The newly created procattr. * @param cont The pool to use */ APR_DECLARE(apr_status_t) apr_procattr_create(apr_procattr_t **new_attr, apr_pool_t *cont); /** - * Determine if any of stdin, stdout, or stderr should be linked to pipes + * Determine if any of stdin, stdout, or stderr should be linked to pipes * when starting a child process. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param in Should stdin be a pipe back to the parent? * @param out Should stdout be a pipe back to the parent? * @param err Should stderr be a pipe back to the parent? * @note If APR_NO_PIPE, there will be no special channel, the child - * inherits the parent's corresponding stdio stream. If APR_NO_FILE is + * inherits the parent's corresponding stdio stream. If APR_NO_FILE is * specified, that corresponding stream is closed in the child (and will - * be INVALID_HANDLE_VALUE when inspected on Win32). This can have ugly + * be INVALID_HANDLE_VALUE when inspected on Win32). This can have ugly * side effects, as the next file opened in the child on Unix will fall * into the stdio stream fd slot! */ -APR_DECLARE(apr_status_t) apr_procattr_io_set(apr_procattr_t *attr, +APR_DECLARE(apr_status_t) apr_procattr_io_set(apr_procattr_t *attr, apr_int32_t in, apr_int32_t out, apr_int32_t err); /** * Set the child_in and/or parent_in values to existing apr_file_t values. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param child_in apr_file_t value to use as child_in. Must be a valid file. * @param parent_in apr_file_t value to use as parent_in. Must be a valid file. * @remark This is NOT a required initializer function. This is * useful if you have already opened a pipe (or multiple files) * that you wish to use, perhaps persistently across multiple - * process invocations - such as a log file. You can save some + * process invocations - such as a log file. You can save some * extra function calls by not creating your own pipe since this * creates one in the process space for you. * @bug Note that calling this function with two NULL files on some platforms @@ -496,13 +496,13 @@ APR_DECLARE(apr_status_t) apr_procattr_child_in_set(struct apr_procattr_t *attr, /** * Set the child_out and parent_out values to existing apr_file_t values. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param child_out apr_file_t value to use as child_out. Must be a valid file. * @param parent_out apr_file_t value to use as parent_out. Must be a valid file. * @remark This is NOT a required initializer function. This is * useful if you have already opened a pipe (or multiple files) * that you wish to use, perhaps persistently across multiple - * process invocations - such as a log file. + * process invocations - such as a log file. * @bug Note that calling this function with two NULL files on some platforms * creates an APR_FULL_BLOCK pipe, but this behavior is neither portable nor * is it supported. @see apr_procattr_io_set instead for simple pipes. @@ -513,13 +513,13 @@ APR_DECLARE(apr_status_t) apr_procattr_child_out_set(struct apr_procattr_t *attr /** * Set the child_err and parent_err values to existing apr_file_t values. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param child_err apr_file_t value to use as child_err. Must be a valid file. * @param parent_err apr_file_t value to use as parent_err. Must be a valid file. * @remark This is NOT a required initializer function. This is * useful if you have already opened a pipe (or multiple files) * that you wish to use, perhaps persistently across multiple - * process invocations - such as a log file. + * process invocations - such as a log file. * @bug Note that calling this function with two NULL files on some platforms * creates an APR_FULL_BLOCK pipe, but this behavior is neither portable nor * is it supported. @see apr_procattr_io_set instead for simple pipes. @@ -530,21 +530,21 @@ APR_DECLARE(apr_status_t) apr_procattr_child_err_set(struct apr_procattr_t *attr /** * Set which directory the child process should start executing in. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param dir Which dir to start in. By default, this is the same dir as * the parent currently resides in, when the createprocess call - * is made. + * is made. */ -APR_DECLARE(apr_status_t) apr_procattr_dir_set(apr_procattr_t *attr, +APR_DECLARE(apr_status_t) apr_procattr_dir_set(apr_procattr_t *attr, const char *dir); /** * Set what type of command the child process will call. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param cmd The type of command. One of: * <PRE> * APR_SHELLCMD -- Anything that the shell can handle - * APR_PROGRAM -- Executable program (default) + * APR_PROGRAM -- Executable program (default) * APR_PROGRAM_ENV -- Executable program, copy environment * APR_PROGRAM_PATH -- Executable program on PATH, copy env * </PRE> @@ -554,16 +554,16 @@ APR_DECLARE(apr_status_t) apr_procattr_cmdtype_set(apr_procattr_t *attr, /** * Determine if the child should start in detached state. - * @param attr The procattr we care about. - * @param detach Should the child start in detached state? Default is no. + * @param attr The procattr we care about. + * @param detach Should the child start in detached state? Default is no. */ -APR_DECLARE(apr_status_t) apr_procattr_detach_set(apr_procattr_t *attr, +APR_DECLARE(apr_status_t) apr_procattr_detach_set(apr_procattr_t *attr, apr_int32_t detach); #if APR_HAVE_STRUCT_RLIMIT /** * Set the Resource Utilization limits when starting a new process. - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param what Which limit to set, one of: * <PRE> * APR_LIMIT_CPU @@ -573,7 +573,7 @@ APR_DECLARE(apr_status_t) apr_procattr_detach_set(apr_procattr_t *attr, * </PRE> * @param limit Value to set the limit to. */ -APR_DECLARE(apr_status_t) apr_procattr_limit_set(apr_procattr_t *attr, +APR_DECLARE(apr_status_t) apr_procattr_limit_set(apr_procattr_t *attr, apr_int32_t what, struct rlimit *limit); #endif @@ -608,9 +608,9 @@ APR_DECLARE(apr_status_t) apr_procattr_error_check_set(apr_procattr_t *attr, apr_int32_t chk); /** - * Determine if the child should start in its own address space or using the + * Determine if the child should start in its own address space or using the * current one from its parent - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param addrspace Should the child start in its own address space? Default * is no on NetWare and yes on other platforms. */ @@ -619,7 +619,7 @@ APR_DECLARE(apr_status_t) apr_procattr_addrspace_set(apr_procattr_t *attr, /** * Set the username used for running process - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param username The username used * @param password User password if needed. Password is needed on WIN32 * or any other platform having @@ -631,7 +631,7 @@ APR_DECLARE(apr_status_t) apr_procattr_user_set(apr_procattr_t *attr, /** * Set the group used for running process - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param groupname The group name used */ APR_DECLARE(apr_status_t) apr_procattr_group_set(apr_procattr_t *attr, @@ -640,7 +640,7 @@ APR_DECLARE(apr_status_t) apr_procattr_group_set(apr_procattr_t *attr, /** * Register permission set function - * @param attr The procattr we care about. + * @param attr The procattr we care about. * @param perms_set_fn Permission set callback * @param data Data to pass to permission callback function * @param perms Permissions to set @@ -652,10 +652,10 @@ APR_DECLARE(apr_status_t) apr_procattr_perms_set_register(apr_procattr_t *attr, #if APR_HAS_FORK /** - * This is currently the only non-portable call in APR. This executes + * This is currently the only non-portable call in APR. This executes * a standard unix fork. - * @param proc The resulting process handle. - * @param cont The pool to use. + * @param proc The resulting process handle. + * @param cont The pool to use. * @remark returns APR_INCHILD for the child, and APR_INPARENT for the parent * or an error. */ @@ -665,10 +665,10 @@ APR_DECLARE(apr_status_t) apr_proc_fork(apr_proc_t *proc, apr_pool_t *cont); /** * Create a new process and execute a new program within that process. * @param new_proc The resulting process handle. - * @param progname The program to run - * @param args the arguments to pass to the new program. The first + * @param progname The program to run + * @param args the arguments to pass to the new program. The first * one should be the program name. - * @param env The new environment table for the new process. This + * @param env The new environment table for the new process. This * should be a list of NULL-terminated strings. This argument * is ignored for APR_PROGRAM_ENV, APR_PROGRAM_PATH, and * APR_SHELLCMD_ENV types of commands. @@ -681,16 +681,16 @@ APR_DECLARE(apr_status_t) apr_proc_fork(apr_proc_t *proc, apr_pool_t *cont); APR_DECLARE(apr_status_t) apr_proc_create(apr_proc_t *new_proc, const char *progname, const char * const *args, - const char * const *env, - apr_procattr_t *attr, + const char * const *env, + apr_procattr_t *attr, apr_pool_t *pool); /** * Wait for a child process to die - * @param proc The process handle that corresponds to the desired child process - * @param exitcode The returned exit status of the child, if a child process + * @param proc The process handle that corresponds to the desired child process + * @param exitcode The returned exit status of the child, if a child process * dies, or the signal that caused the child to die. - * On platforms that don't support obtaining this information, + * On platforms that don't support obtaining this information, * the status parameter will be returned as APR_ENOTIMPL. * @param exitwhy Why the child died, the bitwise or of: * <PRE> @@ -702,7 +702,7 @@ APR_DECLARE(apr_status_t) apr_proc_create(apr_proc_t *new_proc, * @param waithow How should we wait. One of: * <PRE> * APR_WAIT -- block until the child process dies. - * APR_NOWAIT -- return immediately regardless of if the + * APR_NOWAIT -- return immediately regardless of if the * child is dead or not. * </PRE> * @remark The child's status is in the return code to this process. It is one of: @@ -716,13 +716,13 @@ APR_DECLARE(apr_status_t) apr_proc_wait(apr_proc_t *proc, apr_wait_how_e waithow); /** - * Wait for any current child process to die and return information + * Wait for any current child process to die and return information * about that child. - * @param proc Pointer to NULL on entry, will be filled out with child's - * information - * @param exitcode The returned exit status of the child, if a child process + * @param proc Pointer to NULL on entry, will be filled out with child's + * information + * @param exitcode The returned exit status of the child, if a child process * dies, or the signal that caused the child to die. - * On platforms that don't support obtaining this information, + * On platforms that don't support obtaining this information, * the status parameter will be returned as APR_ENOTIMPL. * @param exitwhy Why the child died, the bitwise or of: * <PRE> @@ -734,7 +734,7 @@ APR_DECLARE(apr_status_t) apr_proc_wait(apr_proc_t *proc, * @param waithow How should we wait. One of: * <PRE> * APR_WAIT -- block until the child process dies. - * APR_NOWAIT -- return immediately regardless of if the + * APR_NOWAIT -- return immediately regardless of if the * child is dead or not. * </PRE> * @param p Pool to allocate child information out of. @@ -759,31 +759,31 @@ APR_DECLARE(apr_status_t) apr_proc_wait_all_procs(apr_proc_t *proc, APR_DECLARE(apr_status_t) apr_proc_detach(int daemonize); /** - * Register an other_child -- a child associated to its registered + * Register an other_child -- a child associated to its registered * maintence callback. This callback is invoked when the process * dies, is disconnected or disappears. * @param proc The child process to register. - * @param maintenance maintenance is a function that is invoked with a + * @param maintenance maintenance is a function that is invoked with a * reason and the data pointer passed here. * @param data Opaque context data passed to the maintenance function. - * @param write_fd This argument is currently unused and should be passed + * @param write_fd This argument is currently unused and should be passed * as NULL. * @param p The pool to use for allocating memory. */ -APR_DECLARE(void) apr_proc_other_child_register(apr_proc_t *proc, - void (*maintenance) (int reason, - void *, +APR_DECLARE(void) apr_proc_other_child_register(apr_proc_t *proc, + void (*maintenance) (int reason, + void *, int status), void *data, apr_file_t *write_fd, apr_pool_t *p); /** - * Stop watching the specified other child. + * Stop watching the specified other child. * @param data The data to pass to the maintenance function. This is * used to find the process to unregister. * @warning Since this can be called by a maintenance function while we're - * scanning the other_children list, all scanners should protect - * themself by loading ocr->next before calling any maintenance + * scanning the other_children list, all scanners should protect + * themself by loading ocr->next before calling any maintenance * function. */ APR_DECLARE(void) apr_proc_other_child_unregister(void *data); @@ -808,13 +808,13 @@ APR_DECLARE(void) apr_proc_other_child_unregister(void *data); * [... handling non-otherchild processes death ...] * </pre> */ -APR_DECLARE(apr_status_t) apr_proc_other_child_alert(apr_proc_t *proc, +APR_DECLARE(apr_status_t) apr_proc_other_child_alert(apr_proc_t *proc, int reason, int status); /** - * Test one specific other child processes and invoke the maintenance callback - * with the appropriate reason code, if still running, or the appropriate reason + * Test one specific other child processes and invoke the maintenance callback + * with the appropriate reason code, if still running, or the appropriate reason * code if the process is no longer healthy. * @param ocr The registered other child * @param reason The reason code (e.g. APR_OC_REASON_RESTART) if still running @@ -823,14 +823,14 @@ APR_DECLARE(void) apr_proc_other_child_refresh(apr_other_child_rec_t *ocr, int reason); /** - * Test all registered other child processes and invoke the maintenance callback - * with the appropriate reason code, if still running, or the appropriate reason + * Test all registered other child processes and invoke the maintenance callback + * with the appropriate reason code, if still running, or the appropriate reason * code if the process is no longer healthy. * @param reason The reason code (e.g. APR_OC_REASON_RESTART) to running processes */ APR_DECLARE(void) apr_proc_other_child_refresh_all(int reason); -/** +/** * Terminate a process. * @param proc The process to terminate. * @param sig How to kill the process. @@ -839,7 +839,7 @@ APR_DECLARE(apr_status_t) apr_proc_kill(apr_proc_t *proc, int sig); /** * Register a process to be killed when a pool dies. - * @param a The pool to use to define the processes lifetime + * @param a The pool to use to define the processes lifetime * @param proc The process to register * @param how How to kill the process, one of: * <PRE> @@ -853,7 +853,7 @@ APR_DECLARE(apr_status_t) apr_proc_kill(apr_proc_t *proc, int sig); APR_DECLARE(void) apr_pool_note_subprocess(apr_pool_t *a, apr_proc_t *proc, apr_kill_conditions_e how); -#if APR_HAS_THREADS +#if APR_HAS_THREADS #if (APR_HAVE_SIGWAIT || APR_HAVE_SIGSUSPEND) && !defined(OS2) diff --git a/include/apr_thread_rwlock.h b/include/apr_thread_rwlock.h index 0bd958fbf..eba862168 100644 --- a/include/apr_thread_rwlock.h +++ b/include/apr_thread_rwlock.h @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup apr_thread_rwlock Reader/Writer Lock Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -89,7 +89,7 @@ APR_DECLARE(apr_status_t) apr_thread_rwlock_tryrdlock(apr_thread_rwlock_t *rwloc APR_DECLARE(apr_status_t) apr_thread_rwlock_wrlock(apr_thread_rwlock_t *rwlock); /** - * Attempt to acquire the exclusive-write lock on the given read-write lock. + * Attempt to acquire the exclusive-write lock on the given read-write lock. * This is the same as apr_thread_rwlock_wrlock(), only that the function fails * if there is any other thread holding the lock (for reading or writing), * in which case the function will return APR_EBUSY. Note: it is important diff --git a/include/apr_time.h b/include/apr_time.h index b0efd791c..06ec5ae9b 100644 --- a/include/apr_time.h +++ b/include/apr_time.h @@ -31,7 +31,7 @@ extern "C" { /** * @defgroup apr_time Time Routines - * @ingroup APR + * @ingroup APR * @{ */ @@ -127,7 +127,7 @@ struct apr_time_exp_t { * @param result the resulting apr_time_t * @param input the time_t to convert */ -APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, +APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, time_t input); /** @@ -146,7 +146,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result, * @param result the exploded time * @param input the time to explode */ -APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, +APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, apr_time_t input); /** @@ -154,7 +154,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, * @param result the exploded time * @param input the time to explode */ -APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, +APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, apr_time_t input); /** @@ -163,7 +163,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, * @param result the resulting imploded time * @param input the input exploded time */ -APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, +APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, apr_time_exp_t *input); /** @@ -172,13 +172,13 @@ APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, * @param result the resulting imploded time * @param input the input exploded time */ -APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result, +APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result, apr_time_exp_t *input); /** * Sleep for the specified number of micro-seconds. * @param t desired amount of time to sleep. - * @warning 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); @@ -190,7 +190,7 @@ APR_DECLARE(void) apr_sleep(apr_interval_time_t t); * format which requires APR_RFC822_DATA_LEN bytes of storage, * including the trailing NUL terminator. * @param date_str String to write to. - * @param t the time to convert + * @param t the time to convert */ APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t); @@ -204,7 +204,7 @@ APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t); * Unlike ANSI/ISO C ctime(), apr_ctime() does not include * a \\n at the end of the string. * @param date_str String to write to. - * @param t the time to convert + * @param t the time to convert */ APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t); @@ -216,15 +216,15 @@ APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t); * @param format The format for the time string * @param tm The time to convert */ -APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, - apr_size_t max, const char *format, +APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, + apr_size_t max, const char *format, apr_time_exp_t *tm); /** * Improve the clock resolution for the lifetime of the given pool. * Generally this is only desirable on benchmarking and other very * time-sensitive applications, and has no impact on most platforms. - * @param p The pool to associate the finer clock resolution + * @param p The pool to associate the finer clock resolution */ APR_DECLARE(void) apr_time_clock_hires(apr_pool_t *p); diff --git a/include/apr_uri.h b/include/apr_uri.h index 25ad8f281..f6ba4610a 100644 --- a/include/apr_uri.h +++ b/include/apr_uri.h @@ -107,7 +107,7 @@ struct apr_uri_t { /** The port number, numeric, valid only if port_str != NULL */ apr_port_t port; - + /** has the structure been initialized */ unsigned is_initialized:1; @@ -123,27 +123,27 @@ struct apr_uri_t { * http, ftp, https, gopher, wais, nntp, snews, and prospero * @param scheme_str The string that contains the current scheme * @return The default port for this scheme - */ + */ APR_DECLARE(apr_port_t) apr_uri_port_of_scheme(const char *scheme_str); /** - * Unparse a apr_uri_t structure to an URI string. Optionally + * Unparse a apr_uri_t structure to an URI string. Optionally * suppress the password for security reasons. * @param p The pool to allocate out of * @param uptr All of the parts of the uri * @param flags How to unparse the uri. One of: * <PRE> - * APR_URI_UNP_OMITSITEPART Suppress "scheme://user\@site:port" - * APR_URI_UNP_OMITUSER Just omit user - * APR_URI_UNP_OMITPASSWORD Just omit password + * APR_URI_UNP_OMITSITEPART Suppress "scheme://user\@site:port" + * APR_URI_UNP_OMITUSER Just omit user + * APR_URI_UNP_OMITPASSWORD Just omit password * APR_URI_UNP_OMITUSERINFO Omit "user:password\@" part * APR_URI_UNP_REVEALPASSWORD Show plain text password (default: show XXXXXXXX) - * APR_URI_UNP_OMITPATHINFO Show "scheme://user\@site:port" only - * APR_URI_UNP_OMITQUERY Omit "?queryarg" or "#fragment" + * APR_URI_UNP_OMITPATHINFO Show "scheme://user\@site:port" only + * APR_URI_UNP_OMITQUERY Omit "?queryarg" or "#fragment" * </PRE> * @return The uri as a string */ -APR_DECLARE(char *) apr_uri_unparse(apr_pool_t *p, +APR_DECLARE(char *) apr_uri_unparse(apr_pool_t *p, const apr_uri_t *uptr, unsigned flags); @@ -156,7 +156,7 @@ APR_DECLARE(char *) apr_uri_unparse(apr_pool_t *p, * @param uptr The apr_uri_t to fill out * @return APR_SUCCESS for success or error code */ -APR_DECLARE(apr_status_t) apr_uri_parse(apr_pool_t *p, const char *uri, +APR_DECLARE(apr_status_t) apr_uri_parse(apr_pool_t *p, const char *uri, apr_uri_t *uptr); /** @@ -166,8 +166,8 @@ APR_DECLARE(apr_status_t) apr_uri_parse(apr_pool_t *p, const char *uri, * @param uptr The apr_uri_t to fill out * @return APR_SUCCESS for success or error code */ -APR_DECLARE(apr_status_t) apr_uri_parse_hostinfo(apr_pool_t *p, - const char *hostinfo, +APR_DECLARE(apr_status_t) apr_uri_parse_hostinfo(apr_pool_t *p, + const char *hostinfo, apr_uri_t *uptr); /** @} */ diff --git a/include/apr_user.h b/include/apr_user.h index 0e0a3ac5a..4b850262c 100644 --- a/include/apr_user.h +++ b/include/apr_user.h @@ -19,7 +19,7 @@ /** * @file apr_user.h - * @brief APR User ID Services + * @brief APR User ID Services */ #include "apr.h" @@ -32,7 +32,7 @@ extern "C" { /** * @defgroup apr_user User and Group ID Services - * @ingroup APR + * @ingroup APR * @{ */ @@ -54,7 +54,7 @@ typedef PSID apr_gid_t; typedef gid_t apr_gid_t; #endif -#if APR_HAS_USER +#if APR_HAS_USER /** * Get the userid (and groupid) of the calling process @@ -95,8 +95,8 @@ APR_DECLARE(apr_status_t) apr_uid_get(apr_uid_t *userid, apr_gid_t *groupid, * @param p The pool from which to allocate the string * @remark This function is available only if APR_HAS_USER is defined. */ -APR_DECLARE(apr_status_t) apr_uid_homepath_get(char **dirname, - const char *username, +APR_DECLARE(apr_status_t) apr_uid_homepath_get(char **dirname, + const char *username, apr_pool_t *p); /** @@ -120,7 +120,7 @@ APR_DECLARE(apr_status_t) apr_uid_compare(apr_uid_t left, apr_uid_t right); * @param p The pool from which to allocate the string * @remark This function is available only if APR_HAS_USER is defined. */ -APR_DECLARE(apr_status_t) apr_gid_name_get(char **groupname, +APR_DECLARE(apr_status_t) apr_gid_name_get(char **groupname, apr_gid_t groupid, apr_pool_t *p); /** @@ -130,7 +130,7 @@ APR_DECLARE(apr_status_t) apr_gid_name_get(char **groupname, * @param p The pool from which to allocate the string * @remark This function is available only if APR_HAS_USER is defined. */ -APR_DECLARE(apr_status_t) apr_gid_get(apr_gid_t *groupid, +APR_DECLARE(apr_status_t) apr_gid_get(apr_gid_t *groupid, const char *groupname, apr_pool_t *p); /** diff --git a/include/apr_uuid.h b/include/apr_uuid.h index bb8841f1c..0eaa3bab4 100644 --- a/include/apr_uuid.h +++ b/include/apr_uuid.h @@ -49,7 +49,7 @@ typedef struct { /** * Generate and return a (new) UUID * @param uuid The resulting UUID - */ + */ APR_DECLARE(void) apr_uuid_get(apr_uuid_t *uuid); /** @@ -58,14 +58,14 @@ APR_DECLARE(void) apr_uuid_get(apr_uuid_t *uuid); * 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 - */ + */ APR_DECLARE(void) apr_uuid_format(char *buffer, const apr_uuid_t *uuid); /** * Parse a standard-format string into a UUID * @param uuid The resulting UUID * @param uuid_str The formatted UUID - */ + */ APR_DECLARE(apr_status_t) apr_uuid_parse(apr_uuid_t *uuid, const char *uuid_str); /** @} */ diff --git a/include/apr_version.h b/include/apr_version.h index 24847dd2c..527ccf70c 100644 --- a/include/apr_version.h +++ b/include/apr_version.h @@ -20,7 +20,7 @@ /** * @file apr_version.h * @brief APR Versioning Interface - * + * * APR's Version * * There are several different mechanisms for accessing the version. There @@ -42,10 +42,10 @@ "Foundation or its licensors, as applicable." /* The numeric compile-time version constants. These constants are the - * authoritative version numbers for APR. + * authoritative version numbers for APR. */ -/** major version +/** major version * Major API changes that could cause compatibility problems for older * programs such as structure size changes. No binary compatibility is * possible across a change in the major version. @@ -58,13 +58,13 @@ */ #define APR_MINOR_VERSION 0 -/** patch level +/** patch level * The Patch Level never includes API changes, simply bug fixes. * Reset to 0 when upgrading APR_MINOR_VERSION */ #define APR_PATCH_VERSION 0 -/** +/** * The symbol APR_IS_DEV_VERSION is only defined for internal, * "development" copies of APR. It is undefined for released versions * of APR. @@ -121,9 +121,9 @@ #ifndef APR_VERSION_ONLY -/* The C language API to access the version at run time, - * as opposed to compile time. APR_VERSION_ONLY may be defined - * externally when preprocessing apr_version.h to obtain strictly +/* The C language API to access the version at run time, + * as opposed to compile time. APR_VERSION_ONLY may be defined + * externally when preprocessing apr_version.h to obtain strictly * the C Preprocessor macro declarations. */ @@ -133,9 +133,9 @@ extern "C" { #endif -/** - * The numeric version information is broken out into fields within this - * structure. +/** + * The numeric version information is broken out into fields within this + * structure. */ typedef struct { int major; /**< major number */ diff --git a/include/apr_xlate.h b/include/apr_xlate.h index 6f27fda0b..bca3ff4d2 100644 --- a/include/apr_xlate.h +++ b/include/apr_xlate.h @@ -63,12 +63,12 @@ typedef struct apr_xlate_t apr_xlate_t; * if charset transcoding is not available in this instance of * apr-util at all (i.e., APR_HAS_XLATE is undefined). */ -APR_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset, - const char *topage, - const char *frompage, +APR_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset, + const char *topage, + 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 @@ -77,13 +77,13 @@ APR_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset, */ #define APR_DEFAULT_CHARSET (const char *)0 /** - * To indicate charset names of the current locale + * To indicate charset names of the current locale */ #define APR_LOCALE_CHARSET (const char *)1 /** * Find out whether or not the specified conversion is single-byte-only. - * @param convset The handle allocated by apr_xlate_open, specifying the + * @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 * @remark @@ -94,11 +94,11 @@ APR_DECLARE(apr_status_t) apr_xlate_sb_get(apr_xlate_t *convset, int *onoff); /** * Convert a buffer of text from one codepage to another. - * @param convset The handle allocated by apr_xlate_open, specifying + * @param convset The handle allocated by apr_xlate_open, specifying * the parameters of conversion * @param inbuf The address of the source buffer * @param inbytes_left Input: the amount of input data to be translated - * Output: the amount of input data not yet translated + * Output: the amount of input data not yet translated * @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 @@ -114,9 +114,9 @@ APR_DECLARE(apr_status_t) apr_xlate_sb_get(apr_xlate_t *convset, int *onoff); * the inbuf and inbytes_left parameters as NULL. (Note that this * mode only works from version 1.1.0 onwards) */ -APR_DECLARE(apr_status_t) apr_xlate_conv_buffer(apr_xlate_t *convset, - const char *inbuf, - apr_size_t *inbytes_left, +APR_DECLARE(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); @@ -125,25 +125,25 @@ APR_DECLARE(apr_status_t) apr_xlate_conv_buffer(apr_xlate_t *convset, /** * 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. + * with double-byte character sets. * @param convset The handle allocated by apr_xlate_open, specifying the * parameters of conversion * @param inchar The character to convert * @param outchar The converted character */ -APR_DECLARE(apr_status_t) apr_xlate_conv_char(apr_xlate_t *convset, +APR_DECLARE(apr_status_t) apr_xlate_conv_char(apr_xlate_t *convset, char inchar, char outchar); #endif /** * Convert a single-byte character from one charset to another. - * @param convset The handle allocated by apr_xlate_open, specifying the + * @param convset The handle allocated by apr_xlate_open, specifying the * parameters of conversion * @param inchar The single-byte character to convert. * @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, +APR_DECLARE(apr_int32_t) apr_xlate_conv_byte(apr_xlate_t *convset, unsigned char inchar); /** diff --git a/include/apr_xml.h b/include/apr_xml.h index bd0b1000c..099bf0d93 100644 --- a/include/apr_xml.h +++ b/include/apr_xml.h @@ -21,7 +21,7 @@ #define APR_XML_H /** - * @defgroup APR_Util_XML XML + * @defgroup APR_Util_XML XML * @ingroup APR * @{ */ @@ -173,13 +173,13 @@ struct apr_xml_elem { apr_text_header following_cdata; /** parent element */ - struct apr_xml_elem *parent; + struct apr_xml_elem *parent; /** next (sibling) element */ - struct apr_xml_elem *next; + struct apr_xml_elem *next; /** first child element */ struct apr_xml_elem *first_child; /** first attribute */ - struct apr_xml_attr *attr; + struct apr_xml_attr *attr; /* used only during parsing */ /** last child element */ @@ -199,7 +199,7 @@ struct apr_xml_elem { /** apr_xml_doc: holds a parsed XML document */ struct apr_xml_doc { /** root element */ - apr_xml_elem *root; + apr_xml_elem *root; /** array of namespaces used */ apr_array_header_t *namespaces; }; @@ -221,7 +221,7 @@ APR_DECLARE(apr_xml_parser *) apr_xml_parser_create(apr_pool_t *pool); * errors), will be set to NULL on successful completion. * @param ppdoc A pointer to *apr_xml_doc (which has the parsed results in it) * @param xmlfd A file to read from. - * @param buffer_length Buffer length which would be suitable + * @param buffer_length Buffer length which would be suitable * @return Any errors found during parsing. */ APR_DECLARE(apr_status_t) apr_xml_parse_file(apr_pool_t *p, @@ -267,15 +267,15 @@ APR_DECLARE(char *) apr_xml_parser_geterror(apr_xml_parser *parser, /** - * Converts an XML element tree to flat text + * Converts an XML element tree to flat text * @param p The pool to allocate out of * @param elem The XML element to convert * @param style How to covert the XML. One of: * <PRE> - * APR_XML_X2T_FULL start tag, contents, end tag - * APR_XML_X2T_INNER contents only - * APR_XML_X2T_LANG_INNER xml:lang + inner contents - * APR_XML_X2T_FULL_NS_LANG FULL + ns defns + xml:lang + * APR_XML_X2T_FULL start tag, contents, end tag + * APR_XML_X2T_INNER contents only + * APR_XML_X2T_LANG_INNER xml:lang + inner contents + * APR_XML_X2T_FULL_NS_LANG FULL + ns defns + xml:lang * APR_XML_X2T_PARSED original prefixes * </PRE> * @param namespaces The namespace of the current XML element @@ -327,7 +327,7 @@ APR_DECLARE(void) apr_xml_quote_elem(apr_pool_t *p, apr_xml_elem *elem); /* manage an array of unique URIs: apr_xml_insert_uri() and APR_XML_URI_ITEM() */ /** - * return the URI's (existing) index, or insert it and return a new index + * return the URI's (existing) index, or insert it and return a new index * @param uri_array array to insert into * @param uri The uri to insert * @return int The uri's index @@ -340,7 +340,7 @@ APR_DECLARE(int) apr_xml_insert_uri(apr_array_header_t *uri_array, #if APR_CHARSET_EBCDIC /** - * Convert parsed tree in EBCDIC + * Convert parsed tree in EBCDIC * @param p The pool to allocate out of * @param pdoc The apr_xml_doc to convert. * @param xlate The translation handle to use. diff --git a/include/apu_version.h b/include/apu_version.h index b46aad503..2e9f6341d 100644 --- a/include/apu_version.h +++ b/include/apu_version.h @@ -20,7 +20,7 @@ /** * @file apu_version.h * @brief APR-util Versioning Interface - * + * * APR-util's Version * * There are several different mechanisms for accessing the version. There @@ -45,7 +45,7 @@ * a compatibility stub. */ -/** major version +/** major version * Major API changes that could cause compatibility problems for older * programs such as structure size changes. No binary compatibility is * possible across a change in the major version. @@ -62,7 +62,7 @@ */ #define APU_MINOR_VERSION APR_MINOR_VERSION -/** patch level +/** patch level * The Patch Level never includes API changes, simply bug fixes. * Reset to 0 when upgrading APR_MINOR_VERSION * In 2.0, for legacy support, this is an identity of the APR version. @@ -70,7 +70,7 @@ */ #define APU_PATCH_VERSION APR_PATCH_VERSION -/** +/** * The symbol APU_IS_DEV_VERSION is only defined for internal, * "development" copies of APU. It is undefined for released versions * of APU. diff --git a/include/arch/beos/apr_arch_proc_mutex.h b/include/arch/beos/apr_arch_proc_mutex.h index c60d8c622..523189c3e 100644 --- a/include/arch/beos/apr_arch_proc_mutex.h +++ b/include/arch/beos/apr_arch_proc_mutex.h @@ -26,7 +26,7 @@ struct apr_proc_mutex_t { apr_pool_t *pool; - + /* Our lock :) */ sem_id Lock; int32 LockCount; diff --git a/include/arch/beos/apr_arch_thread_mutex.h b/include/arch/beos/apr_arch_thread_mutex.h index bb7d4ae80..b74ded5cc 100644 --- a/include/arch/beos/apr_arch_thread_mutex.h +++ b/include/arch/beos/apr_arch_thread_mutex.h @@ -27,13 +27,13 @@ struct apr_thread_mutex_t { apr_pool_t *pool; - + /* Our lock :) */ sem_id Lock; int32 LockCount; /* If we nest locks we need these... */ - int nested; + int nested; apr_os_thread_t owner; int owner_ref; }; diff --git a/include/arch/beos/apr_arch_threadproc.h b/include/arch/beos/apr_arch_threadproc.h index 5c67c879e..292adf9f7 100644 --- a/include/arch/beos/apr_arch_threadproc.h +++ b/include/arch/beos/apr_arch_threadproc.h @@ -31,11 +31,11 @@ #define SHELL_PATH "/bin/sh" -#define PTHREAD_CANCEL_AYNCHRONOUS CANCEL_ASYNCH; -#define PTHREAD_CANCEL_DEFERRED CANCEL_DEFER; - -#define PTHREAD_CANCEL_ENABLE CANCEL_ENABLE; -#define PTHREAD_CANCEL_DISABLE CANCEL_DISABLE; +#define PTHREAD_CANCEL_AYNCHRONOUS CANCEL_ASYNCH; +#define PTHREAD_CANCEL_DEFERRED CANCEL_DEFER; + +#define PTHREAD_CANCEL_ENABLE CANCEL_ENABLE; +#define PTHREAD_CANCEL_DISABLE CANCEL_DISABLE; #define BEOS_MAX_DATAKEYS 128 diff --git a/include/arch/netware/apr_arch_file_io.h b/include/arch/netware/apr_arch_file_io.h index 659eb2006..e6e959a21 100644 --- a/include/arch/netware/apr_arch_file_io.h +++ b/include/arch/netware/apr_arch_file_io.h @@ -162,14 +162,14 @@ struct apr_stat_entry_t { apr_status_t filepath_root_case(char **rootpath, char *root, apr_pool_t *p); /* This function check to see of the given path includes a drive/volume - * specifier. If the _only_ parameter is set to DRIVE_ONLY then it + * specifier. If the _only_ parameter is set to DRIVE_ONLY then it * check to see of the path only contains a drive/volume specifier and * nothing else. */ apr_status_t filepath_has_drive(const char *rootpath, int only, apr_pool_t *p); /* This function compares the drive/volume specifiers for each given path. - * It returns zero if they match or non-zero if not. + * It returns zero if they match or non-zero if not. */ apr_status_t filepath_compare_drive(const char *path1, const char *path2, apr_pool_t *p); diff --git a/include/arch/netware/apr_arch_networkio.h b/include/arch/netware/apr_arch_networkio.h index 63f17abe5..dfbc5dcf8 100644 --- a/include/arch/netware/apr_arch_networkio.h +++ b/include/arch/netware/apr_arch_networkio.h @@ -19,7 +19,7 @@ #ifdef USE_WINSOCK /* Making sure that we include the correct networkio.h since the the project file is configured to first look for headers in - arch/netware and then arch/unix. But in this specific case we + arch/netware and then arch/unix. But in this specific case we want arch/win32. */ #include <../win32/apr_arch_networkio.h> diff --git a/include/arch/netware/apr_private.h b/include/arch/netware/apr_private.h index c4558afa7..849916701 100644 --- a/include/arch/netware/apr_private.h +++ b/include/arch/netware/apr_private.h @@ -15,7 +15,7 @@ */ /* - * Note: + * Note: * This is the netware-specific autoconf-like config file * which unix creates at ./configure time. */ @@ -31,7 +31,7 @@ /* Pick up privately consumed headers */ #include <ndkvers.h> -/* Include alloca.h to get compiler-dependent defines */ +/* Include alloca.h to get compiler-dependent defines */ #include <alloca.h> /* Use this section to define all of the HAVE_FOO_H @@ -92,7 +92,7 @@ #if (CURRENT_NDK_THRESHOLD < 306030000) #define SIGKILL 11 #define SIGALRM 13 -#define SIGCHLD 14 +#define SIGCHLD 14 #define SIGCONT 15 #define SIGHUP 16 #define SIGPIPE 17 @@ -163,7 +163,7 @@ void* getGlobalPool(); int setStatCache(void *data); void* getStatCache(); -/* Redefine malloc to use the library malloc call so +/* Redefine malloc to use the library malloc call so that all of the memory resources will be owned and can be shared by the library. */ #undef malloc diff --git a/include/arch/os2/apr_arch_file_io.h b/include/arch/os2/apr_arch_file_io.h index a742bf477..3fbdcfc94 100644 --- a/include/arch/os2/apr_arch_file_io.h +++ b/include/arch/os2/apr_arch_file_io.h @@ -25,7 +25,7 @@ #include "apr_errno.h" #include "apr_poll.h" -/* We have an implementation of mkstemp but it's not very multi-threading +/* We have an implementation of mkstemp but it's not very multi-threading * friendly & is part of the POSIX emulation rather than native so don't * use it. */ @@ -68,7 +68,7 @@ struct apr_dir_t { }; apr_status_t apr_file_cleanup(void *); -apr_status_t apr_os2_time_to_apr_time(apr_time_t *result, FDATE os2date, +apr_status_t apr_os2_time_to_apr_time(apr_time_t *result, FDATE os2date, FTIME os2time); apr_status_t apr_apr_time_to_os2_time(FDATE *os2date, FTIME *os2time, apr_time_t aprtime); @@ -79,7 +79,7 @@ extern const char c_is_fnchar[256]; #define IS_FNCHAR(c) c_is_fnchar[(unsigned char)c] apr_status_t filepath_root_test(char *path, apr_pool_t *p); -apr_status_t filepath_drive_get(char **rootpath, char drive, +apr_status_t filepath_drive_get(char **rootpath, char drive, apr_int32_t flags, apr_pool_t *p); apr_status_t filepath_root_case(char **rootpath, char *root, apr_pool_t *p); diff --git a/include/arch/unix/apr_arch_networkio.h b/include/arch/unix/apr_arch_networkio.h index 5f3189d96..93c5f6d8e 100644 --- a/include/arch/unix/apr_arch_networkio.h +++ b/include/arch/unix/apr_arch_networkio.h @@ -107,7 +107,7 @@ struct apr_socket_t { int protocol; apr_sockaddr_t *local_addr; apr_sockaddr_t *remote_addr; - apr_interval_time_t timeout; + apr_interval_time_t timeout; #ifndef HAVE_POLL int connected; #endif diff --git a/include/arch/unix/apr_arch_poll_private.h b/include/arch/unix/apr_arch_poll_private.h index 7b91963a6..eb64517cc 100644 --- a/include/arch/unix/apr_arch_poll_private.h +++ b/include/arch/unix/apr_arch_poll_private.h @@ -191,8 +191,8 @@ struct apr_pollcb_provider_t { const char *name; }; -/* - * Private functions used for the implementation of both apr_pollcb_* and +/* + * Private functions used for the implementation of both apr_pollcb_* and * apr_pollset_* */ #if WAKEUP_USES_PIPE diff --git a/include/arch/win32/apr_arch_atime.h b/include/arch/win32/apr_arch_atime.h index 35f2041a9..652b7905e 100644 --- a/include/arch/win32/apr_arch_atime.h +++ b/include/arch/win32/apr_arch_atime.h @@ -31,7 +31,7 @@ struct atime_t { /* Number of micro-seconds between the beginning of the Windows epoch - * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970) + * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970) */ #define APR_DELTA_EPOCH_IN_USEC APR_TIME_C(11644473600000000); diff --git a/include/arch/win32/apr_arch_file_io.h b/include/arch/win32/apr_arch_file_io.h index fdd841002..063a2fbab 100644 --- a/include/arch/win32/apr_arch_file_io.h +++ b/include/arch/win32/apr_arch_file_io.h @@ -53,8 +53,8 @@ #include <wchar.h> /* Helper functions for the WinNT ApiW() functions. APR treats all - * resource identifiers (files, etc) by their UTF-8 name, to provide - * access to all named identifiers. [UTF-8 completely maps Unicode + * resource identifiers (files, etc) by their UTF-8 name, to provide + * access to all named identifiers. [UTF-8 completely maps Unicode * into char type strings.] * * The _path flavors below provide us fast mappings of the @@ -64,9 +64,9 @@ * Ascii API calls. So we tack them on in utf8_to_unicode_path, and * strip them right back off in unicode_to_utf8_path. */ -apr_status_t utf8_to_unicode_path(apr_wchar_t* dststr, apr_size_t dstchars, +apr_status_t utf8_to_unicode_path(apr_wchar_t* dststr, apr_size_t dstchars, const char* srcstr); -apr_status_t unicode_to_utf8_path(char* dststr, apr_size_t dstchars, +apr_status_t unicode_to_utf8_path(char* dststr, apr_size_t dstchars, const apr_wchar_t* srcstr); #endif /* APR_HAS_UNICODE_FS */ @@ -131,22 +131,22 @@ void *res_name_from_filename(const char *file, int global, apr_pool_t *pool); | APR_FINFO_MTIME | APR_FINFO_SIZE) /* Sneak the Readonly bit through finfo->protection for internal use _only_ */ -#define APR_FREADONLY 0x10000000 +#define APR_FREADONLY 0x10000000 /* Private function for apr_stat/lstat/getfileinfo/dir_read */ -int fillin_fileinfo(apr_finfo_t *finfo, WIN32_FILE_ATTRIBUTE_DATA *wininfo, +int fillin_fileinfo(apr_finfo_t *finfo, WIN32_FILE_ATTRIBUTE_DATA *wininfo, int byhandle, int finddata, const char *fname, apr_int32_t wanted); /* Private function that extends apr_stat/lstat/getfileinfo/dir_read */ -apr_status_t more_finfo(apr_finfo_t *finfo, const void *ufile, +apr_status_t more_finfo(apr_finfo_t *finfo, const void *ufile, apr_int32_t wanted, int whatfile); /* whatfile types for the ufile arg */ #define MORE_OF_HANDLE 0 #define MORE_OF_WFSPEC 2 -/* quick run-down of fields in windows' apr_file_t structure that may have +/* quick run-down of fields in windows' apr_file_t structure that may have * obvious uses. * fname -- the filename as passed to the open call. * dwFileAttricutes -- Attributes used to open the file. @@ -162,7 +162,7 @@ typedef enum { APR_FILETYPE_FILE = 0, APR_FILETYPE_PIPE } apr_filetype_e; - + struct apr_file_t { apr_pool_t *pool; HANDLE filehand; @@ -178,7 +178,7 @@ struct apr_file_t { int eof_hit; BOOLEAN buffered; /* Use buffered I/O? */ int ungetchar; /* Last char provided by an unget op. (-1 = no char) */ - int append; + int append; /* Stuff for buffered mode */ char *buffer; @@ -194,7 +194,7 @@ struct apr_file_t { /* if there is a timeout set, then this pollset is used */ apr_pollset_t *pollset; #endif - /* Pipe specific info */ + /* Pipe specific info */ }; struct apr_dir_t { @@ -225,7 +225,7 @@ extern const char apr_c_is_fnchar[256]; apr_status_t filepath_root_test(char *path, apr_pool_t *p); -/* The apr_filepath_merge wants to canonicalize the cwd to the +/* The apr_filepath_merge wants to canonicalize the cwd to the * addpath if the user passes NULL as the old root path (this * isn't true of an empty string "", which won't be concatenated. * @@ -235,7 +235,7 @@ apr_status_t filepath_root_test(char *path, apr_pool_t *p); * If flags includes the bit APR_FILEPATH_NATIVE, the path returned * is in the os-native format. */ -apr_status_t filepath_drive_get(char **rootpath, char drive, +apr_status_t filepath_drive_get(char **rootpath, char drive, apr_int32_t flags, apr_pool_t *p); diff --git a/include/arch/win32/apr_arch_misc.h b/include/arch/win32/apr_arch_misc.h index 6be12892f..eb8ec0838 100644 --- a/include/arch/win32/apr_arch_misc.h +++ b/include/arch/win32/apr_arch_misc.h @@ -67,7 +67,7 @@ struct apr_other_child_rec_t { */ extern int APR_DECLARE_DATA apr_app_init_complete; -int apr_wastrtoastr(char const * const * *retarr, +int apr_wastrtoastr(char const * const * *retarr, wchar_t const * const *arr, int args); /* Platform specific designation of run time os version. @@ -150,7 +150,7 @@ static APR_INLINE void* apr_realloc_dbg(void* userData, size_t newSize, #endif /* ! _MSC_VER */ /* Wrapper around WaitForSingleObject() that accepts apr_interval_time_t - * in microseconds instead of milliseconds. Values < 0 mean wait + * in microseconds instead of milliseconds. Values < 0 mean wait * forever, 0 means do not wait at all. */ DWORD apr_wait_for_single_object(HANDLE handle, apr_interval_time_t timeout); diff --git a/include/arch/win32/apr_arch_networkio.h b/include/arch/win32/apr_arch_networkio.h index 8afbbd0f3..a9199c47b 100644 --- a/include/arch/win32/apr_arch_networkio.h +++ b/include/arch/win32/apr_arch_networkio.h @@ -44,8 +44,8 @@ struct apr_socket_t { apr_int32_t options; apr_int32_t inherit; #if APR_HAS_SENDFILE - /* As of 07.20.04, the overlapped structure is only used by - * apr_socket_sendfile and that's where it will be allocated + /* As of 07.20.04, the overlapped structure is only used by + * apr_socket_sendfile and that's where it will be allocated * and initialized. */ OVERLAPPED *overlapped; diff --git a/include/arch/win32/apr_arch_thread_mutex.h b/include/arch/win32/apr_arch_thread_mutex.h index b6d0384a5..2c7f473f3 100644 --- a/include/arch/win32/apr_arch_thread_mutex.h +++ b/include/arch/win32/apr_arch_thread_mutex.h @@ -25,8 +25,8 @@ typedef enum thread_mutex_type { thread_mutex_nested_mutex } thread_mutex_type; -/* handle applies only to unnested_semaphore on all platforms - * and nested_mutex on Win9x only. Otherwise critical_section +/* handle applies only to unnested_semaphore on all platforms + * and nested_mutex on Win9x only. Otherwise critical_section * is used for NT nexted mutexes providing optimal performance. */ struct apr_thread_mutex_t { diff --git a/include/arch/win32/apr_arch_utf8.h b/include/arch/win32/apr_arch_utf8.h index aa7c52e2f..08d4b4ce9 100644 --- a/include/arch/win32/apr_arch_utf8.h +++ b/include/arch/win32/apr_arch_utf8.h @@ -35,9 +35,9 @@ typedef apr_uint16_t apr_wchar_t; * when the character code is invalid (in or out of context) and the later * when more characters were expected, but insufficient characters remain. */ -APR_DECLARE(apr_status_t) apr_conv_utf8_to_utf16(const char *in, +APR_DECLARE(apr_status_t) apr_conv_utf8_to_utf16(const char *in, apr_size_t *inbytes, - apr_wchar_t *out, + apr_wchar_t *out, apr_size_t *outwords); /** @@ -55,9 +55,9 @@ APR_DECLARE(apr_status_t) apr_conv_utf8_to_utf16(const char *in, * when the surrogate word is invalid (in or out of context) and the later * when another surrogate word is expected, but insufficient words remain. */ -APR_DECLARE(apr_status_t) apr_conv_utf16_to_utf8(const apr_wchar_t *in, +APR_DECLARE(apr_status_t) apr_conv_utf16_to_utf8(const apr_wchar_t *in, apr_size_t *inwords, - char *out, + char *out, apr_size_t *outbytes); /** diff --git a/include/arch/win32/apr_dbg_win32_handles.h b/include/arch/win32/apr_dbg_win32_handles.h index 471cd66db..20393dc3c 100644 --- a/include/arch/win32/apr_dbg_win32_handles.h +++ b/include/arch/win32/apr_dbg_win32_handles.h @@ -22,7 +22,7 @@ extern "C" { #endif /* USAGE: - * + * * Add the following include to apr_private.h for internal debugging, * or copy this header into apr/include add the include below to apr.h * for really global debugging; @@ -34,7 +34,7 @@ extern "C" { * executing application with a .pid suffix. Ergo several instances * may be executing and logged at once. * - * HANDLE apr_dbg_log(char* fn, HANDLE ha, char* fl, int ln, int nh + * HANDLE apr_dbg_log(char* fn, HANDLE ha, char* fl, int ln, int nh * [, HANDLE *hv, char *dsc...]) * * returns: the handle passed in ha, which is cast back to the real return type. @@ -53,7 +53,7 @@ extern "C" { * treated as a handle. */ -APR_DECLARE_NONSTD(HANDLE) apr_dbg_log(char* fn, HANDLE ha, char* fl, int ln, +APR_DECLARE_NONSTD(HANDLE) apr_dbg_log(char* fn, HANDLE ha, char* fl, int ln, int nh,/* HANDLE *hv, char *dsc */...); #define apr_dbg_rv(fn, args) (apr_dbg_log(#fn,(fn) args,__FILE__,__LINE__,0)) diff --git a/include/arch/win32/apr_private.h b/include/arch/win32/apr_private.h index 8842638cc..4029b93ff 100644 --- a/include/arch/win32/apr_private.h +++ b/include/arch/win32/apr_private.h @@ -15,7 +15,7 @@ */ /* - * Note: + * Note: * This is the win32-specific autoconf-like config file * which unix creates at ./configure time. */ @@ -28,7 +28,7 @@ */ #include <apr.h> -/* +/* * Add a _very_few_ declarations missing from the restricted set of headers * (If this list becomes extensive, re-enable the required headers in apr.hw!) * ACL headers were excluded by default, so include them now. @@ -37,7 +37,7 @@ #define SW_HIDE 0 #endif -/* For the misc.h late-loaded dynamic symbols, we need some obscure types +/* For the misc.h late-loaded dynamic symbols, we need some obscure types * Avoid dragging in wtypes.h unless it's absolutely necessary [generally * not with APR itself, until some GUI-related security is introduced.] */ @@ -84,7 +84,7 @@ #define SIGALRM 14 /* 15 is used for SIGTERM on windows */ #define SIGSTKFLT 16 -#define SIGCHLD 17 +#define SIGCHLD 17 #define SIGCONT 18 #define SIGSTOP 19 #define SIGTSTP 20 diff --git a/include/private/apr_dbd_internal.h b/include/private/apr_dbd_internal.h index 3d50cc603..c838c57b8 100644 --- a/include/private/apr_dbd_internal.h +++ b/include/private/apr_dbd_internal.h @@ -161,7 +161,7 @@ struct apr_dbd_driver_t { */ int (*get_row)(apr_pool_t *pool, apr_dbd_results_t *res, apr_dbd_row_t **row, int rownum); - + /** get_entry: get an entry from a row * * @param row - row pointer @@ -170,7 +170,7 @@ struct apr_dbd_driver_t { * @return 0 for success, -1 for no data, +1 for general error */ const char* (*get_entry)(const apr_dbd_row_t *row, int col); - + /** error: get current error message (if any) * * @param handle - the connection @@ -179,7 +179,7 @@ struct apr_dbd_driver_t { * (implementation-dependent whether errnum is ignored) */ const char *(*error)(apr_dbd_t *handle, int errnum); - + /** escape: escape a string so it is safe for use in query/select * * @param pool - pool to alloc the result from @@ -189,7 +189,7 @@ struct apr_dbd_driver_t { */ const char *(*escape)(apr_pool_t *pool, const char *string, apr_dbd_t *handle); - + /** prepare: prepare a statement * * @param pool - pool to alloc the result from @@ -260,7 +260,7 @@ struct apr_dbd_driver_t { apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random, const char **args); - + /** get_name: get a column title from a result set * * @param res - result set pointer @@ -338,7 +338,7 @@ struct apr_dbd_driver_t { int (*pbselect)(apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random, const void **args); - + /** datum_get: get a binary entry from a row * * @param row - row pointer @@ -351,7 +351,7 @@ struct apr_dbd_driver_t { apr_dbd_type_e type, void *data); }; -/* Export mutex lock/unlock for drivers that need it +/* Export mutex lock/unlock for drivers that need it * deprecated; create a per-dbd mutex within the (*init) function * to avoid blocking other providers running on other threads */ diff --git a/include/private/apr_dbm_private.h b/include/private/apr_dbm_private.h index b3123a6ae..218432bb6 100644 --- a/include/private/apr_dbm_private.h +++ b/include/private/apr_dbm_private.h @@ -91,7 +91,7 @@ struct apr_dbm_driver_t { * The actual DBM */ struct apr_dbm_t -{ +{ /** Associated pool */ apr_pool_t *pool; diff --git a/include/private/apr_support.h b/include/private/apr_support.h index 90491ec76..e8035ae01 100644 --- a/include/private/apr_support.h +++ b/include/private/apr_support.h @@ -52,7 +52,7 @@ extern "C" { /** * @defgroup apr_support Internal APR support functions - * @ingroup APR + * @ingroup APR * @{ */ @@ -62,7 +62,7 @@ extern "C" { * @param f The file to wait on. * @param s The socket to wait on if @a f is @c NULL. * @param for_read If non-zero wait for data to be available to read, - * otherwise wait for data to be able to be written. + * otherwise wait for data to be able to be written. * @return APR_TIMEUP if we run out of time. */ apr_status_t apr_wait_for_io_or_timeout(apr_file_t *f, apr_socket_t *s, diff --git a/random/unix/sha2.h b/random/unix/sha2.h index 0a030d7db..b9a1c10a3 100644 --- a/random/unix/sha2.h +++ b/random/unix/sha2.h @@ -16,7 +16,7 @@ /* * FILE: sha2.h * AUTHOR: Aaron D. Gifford <me@aarongifford.com> - * + * * A licence was granted to the ASF by Aaron on 4 November 2003. */ @@ -50,7 +50,7 @@ void apr__SHA256_Final(apr_byte_t [SHA256_DIGEST_LENGTH], SHA256_CTX *); char* apr__SHA256_End(SHA256_CTX *, char [SHA256_DIGEST_STRING_LENGTH]); char* apr__SHA256_Data(const apr_byte_t *, size_t, char [SHA256_DIGEST_STRING_LENGTH]); - + #ifdef __cplusplus } #endif /* __cplusplus */ diff --git a/test/testshm.h b/test/testshm.h index 4d4f0c5db..d8cb50be8 100644 --- a/test/testshm.h +++ b/test/testshm.h @@ -25,8 +25,8 @@ #include <assert.h> typedef struct mbox { - char msg[1024]; - apr_uint32_t msgavail; + char msg[1024]; + apr_uint32_t msgavail; } mbox; mbox *boxes; diff --git a/test/testutil.h b/test/testutil.h index fb9ccd026..8ac6084f8 100644 --- a/test/testutil.h +++ b/test/testutil.h @@ -21,7 +21,7 @@ #ifndef APR_TEST_UTIL #define APR_TEST_UTIL -/* XXX: FIXME - these all should become much more utilitarian +/* XXX: FIXME - these all should become much more utilitarian * and part of apr, itself */ @@ -53,7 +53,7 @@ extern apr_pool_t *p; /* Assert that RV is an APR_SUCCESS value; else fail giving strerror * for RV and CONTEXT message. */ -void apr_assert_success(abts_case* tc, const char *context, +void apr_assert_success(abts_case* tc, const char *context, apr_status_t rv, int lineno); #define APR_ASSERT_SUCCESS(tc, ctxt, rv) \ apr_assert_success(tc, ctxt, rv, __LINE__) |