diff options
| -rw-r--r-- | docs/doxygen.conf | 9 | ||||
| -rw-r--r-- | include/apr_getopt.h | 16 | ||||
| -rw-r--r-- | include/apr_inherit.h | 20 | ||||
| -rw-r--r-- | include/apr_lib.h | 59 | ||||
| -rw-r--r-- | include/apr_thread_proc.h | 120 | ||||
| -rw-r--r-- | include/arch/netware/pre_nw.h | 2 |
6 files changed, 125 insertions, 101 deletions
diff --git a/docs/doxygen.conf b/docs/doxygen.conf index dbe4b75c8..d05be9c0d 100644 --- a/docs/doxygen.conf +++ b/docs/doxygen.conf @@ -1,6 +1,7 @@ -PROJECT_NAME=Apache Portable Run-Time +PROJECT_NAME="Apache Portable Run-Time" INPUT=. +QUIET=YES RECURSIVE=YES FILE_PATTERNS=*.h @@ -8,9 +9,11 @@ OUTPUT_DIRECTORY=docs/dox MACRO_EXPANSION=YES EXPAND_ONLY_PREDEF=YES -EXPAND_AS_DEFINED= +#EXPAND_AS_DEFINED= # not sure why this doesn't work as EXPAND_AS_DEFINED, it should! -PREDEFINED=APR_DECLARE(x)=x APR_DECLARE_NONSTD(x)=x \ +PREDEFINED="APR_DECLARE(x)=x" \ + "APR_DECLARE_NONSTD(x)=x" \ + DOXYGEN= OPTIMIZE_OUTPUT_FOR_C=YES diff --git a/include/apr_getopt.h b/include/apr_getopt.h index e206d4f26..263635576 100644 --- a/include/apr_getopt.h +++ b/include/apr_getopt.h @@ -62,8 +62,14 @@ extern "C" { #endif /* __cplusplus */ /** - * @package APR command arguments - */ + * @file apr_getopt.h + * @brief APR Command Arguments (getopt) + */ +/** + * @defgroup APR_getopt Command Argument Parsing + * @ingroup APR + * @{ + */ typedef struct apr_getopt_t apr_getopt_t; /** @@ -114,8 +120,7 @@ struct apr_getopt_option_t { * @param cont The pool to operate on * @param argc The number of arguments to parse * @param argv The array of arguments to parse - * @tip Arguments 2 and 3 are most commonly argc and argv from main(argc, argv) - * @deffunc apr_status_t apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont,int argc, char *const *argv) + * @remark Arguments 2 and 3 are most commonly argc and argv from main(argc, argv) */ APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, int argc, const char * const *argv); @@ -135,7 +140,6 @@ APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, * APR_BADARG -- No argument followed @parameter: * APR_SUCCESS -- The next option was found. * </PRE> - * @deffunc apr_status_t apr_getopt(apr_getopt_t *os, const char *opts, char *optch, const char **optarg) */ APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, char *option_ch, const char **option_arg); @@ -164,12 +168,12 @@ APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, * os->err is set to 0. If os->interleave is set to nonzero, options can come * after arguments, and os->argv will be permuted to leave non-option arguments * at the end (the original argv is unaffected). - * @deffunc apr_status_t apr_getopt_long(apr_getopt_t *os, const apr_getopt_option_t *opts, int *optch, const char **optarg) */ APR_DECLARE(apr_status_t) apr_getopt_long(apr_getopt_t *os, const apr_getopt_option_t *opts, int *option_ch, const char **option_arg); +/** @} */ #ifdef __cplusplus } diff --git a/include/apr_inherit.h b/include/apr_inherit.h index 849fa8b8c..76c80a9bd 100644 --- a/include/apr_inherit.h +++ b/include/apr_inherit.h @@ -54,13 +54,30 @@ #ifndef APR_INHERIT_H #define APR_INHERIT_H +/** + * @file apr_inherit.h + * @brief APR File Handle Inheritance + */ +/** + * @defgroup APR_File_Inheritance Inheritance Of File/Sockets + * @ingroup APR_File_Handle + * Sets/Unsets inheritance for File descriptor inheritance in children + * processes. + * + * @{ + */ #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ - +/** + * @param name Set Inheritance for this Socket/File Handle + */ #define APR_DECLARE_SET_INHERIT(name) \ APR_DECLARE(void) apr_##name##_set_inherit(apr_##name##_t *name) +/** + * @param name Unset Inheritance for this Socket/File Handle + */ #define APR_DECLARE_UNSET_INHERIT(name) \ APR_DECLARE(void) apr_##name##_unset_inherit(apr_##name##_t *name) @@ -68,5 +85,6 @@ extern "C" { #ifdef __cplusplus } #endif +/** @} */ #endif /* ! APR_INHERIT_H */ diff --git a/include/apr_lib.h b/include/apr_lib.h index d66d122e5..cd7c948dd 100644 --- a/include/apr_lib.h +++ b/include/apr_lib.h @@ -54,6 +54,10 @@ #ifndef APR_LIB_H #define APR_LIB_H +/** + * @file apr_lib.h + * @brief general purpose library routines + */ #include "apr.h" #include "apr_errno.h" @@ -64,9 +68,10 @@ #if APR_HAVE_STDARG_H #include <stdarg.h> #endif - /** - * @package APR general-purpose library + * @defgroup APR_General General Purpose Library Routines + * @ingroup APR + * @{ */ #ifdef __cplusplus @@ -95,42 +100,62 @@ struct apr_vformatter_buff_t { * return the final element of the pathname * @param pathname The path to get the final element of * @return the final element of the path - * @tip Examples: + * @example + */ +/** + * Examples: * <PRE> * "/foo/bar/gum" -> "gum" * "/foo/bar/gum/" -> "" * "gum" -> "gum" * "wi\\n32\\stuff" -> "stuff" * </PRE> - * @deffunc const char * apr_filename_of_pathname(const char *pathname) */ APR_DECLARE(const char *) apr_filename_of_pathname(const char *pathname); -/* These macros allow correct support of 8-bit characters on systems which +/** + * These macros allow correct support of 8-bit characters on systems which * support 8-bit characters. Pretty dumb how the cast is required, but * that's legacy libc for ya. These new macros do not support EOF like * the standard macros do. Tough. + * @defgroup apr_ctype ctype functions + * @{ */ +/** @see isalnum */ #define apr_isalnum(c) (isalnum(((unsigned char)(c)))) +/** @see isalpha */ #define apr_isalpha(c) (isalpha(((unsigned char)(c)))) +/** @see iscntrl */ #define apr_iscntrl(c) (iscntrl(((unsigned char)(c)))) +/** @see isdigit */ #define apr_isdigit(c) (isdigit(((unsigned char)(c)))) +/** @see isgraph */ #define apr_isgraph(c) (isgraph(((unsigned char)(c)))) +/** @see islower*/ #define apr_islower(c) (islower(((unsigned char)(c)))) +/** @see isascii */ #ifdef isascii #define apr_isascii(c) (isascii(((unsigned char)(c)))) #else #define apr_isascii(c) (((c) & ~0x7f)==0) #endif +/** @see isprint */ #define apr_isprint(c) (isprint(((unsigned char)(c)))) +/** @see ispunct */ #define apr_ispunct(c) (ispunct(((unsigned char)(c)))) +/** @see isspace */ #define apr_isspace(c) (isspace(((unsigned char)(c)))) +/** @see isupper */ #define apr_isupper(c) (isupper(((unsigned char)(c)))) +/** @see isxdigit */ #define apr_isxdigit(c) (isxdigit(((unsigned char)(c)))) +/** @see tolower */ #define apr_tolower(c) (tolower(((unsigned char)(c)))) +/** @see toupper */ #define apr_toupper(c) (toupper(((unsigned char)(c)))) - -/* +/** @} */ +/** + * apr_killpg * Small utility macros to make things easier to read. Not usually a * goal, to be sure.. */ @@ -153,17 +178,20 @@ APR_DECLARE(const char *) apr_filename_of_pathname(const char *pathname); * @param fmt The format string * @param ap The arguments to use to fill out the format string. * - * @tip <PRE> + * @example + */ +/** + * <PRE> * The extensions are: * - * %pA takes a struct in_addr *, and prints it as a.b.c.d - * %pI takes an apr_sockaddr_t * and prints it as a.b.c.d:port or + * %%pA takes a struct in_addr *, and prints it as a.b.c.d + * %%pI takes an apr_sockaddr_t * and prints it as a.b.c.d:port or * [ipv6-address]:port - * %pp takes a void * and outputs it in hex + * %%pp takes a void * and outputs it in hex * - * The %p hacks are to force gcc's printf warning code to skip + * The %%p hacks are to force gcc's printf warning code to skip * over a pointer argument without complaining. This does - * mean that the ANSI-style %p (output a void * in hex format) won't + * mean that the ANSI-style %%p (output a void * in hex format) won't * work as expected at all, but that seems to be a fair trade-off * for the increased robustness of having printf-warnings work. * @@ -202,7 +230,6 @@ APR_DECLARE(const char *) apr_filename_of_pathname(const char *pathname); * that the space is in use until it either has to flush the buffer * or until apr_vformatter returns. * </PRE> - * @deffunc int apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b), apr_vformatter_buff_t *c, const char *fmt, va_list ap) */ APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b), apr_vformatter_buff_t *c, const char *fmt, @@ -212,7 +239,6 @@ APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b), * Validate any password encypted with any algorithm that APR understands * @param passwd The password to validate * @param hash The password to validate against - * @deffunc apr_status_t apr_password_validate(const char *passwd, const char *hash) */ APR_DECLARE(apr_status_t) apr_password_validate(const char *passwd, const char *hash); @@ -222,7 +248,6 @@ APR_DECLARE(apr_status_t) apr_password_validate(const char *passwd, * @param prompt The prompt to display * @param pwbuf Buffer to store the password * @param bufsize The length of the password buffer. - * @deffunc apr_status_t apr_password_get(const char *prompt, char *pwbuf, size_t *bufsize) */ APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, size_t *bufsize); @@ -230,5 +255,5 @@ APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, #ifdef __cplusplus } #endif - +/** @} */ #endif /* ! APR_LIB_H */ diff --git a/include/apr_thread_proc.h b/include/apr_thread_proc.h index ddfd5528c..b7ba4aa21 100644 --- a/include/apr_thread_proc.h +++ b/include/apr_thread_proc.h @@ -69,9 +69,14 @@ #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ - /** - * @package APR Thread library + * @file apr_thread_proc.h + * @brief APR Thread Libraru + */ +/** + * @defgroup APR_Thread Thread Library + * @ingroup APR + * @{ */ typedef enum {APR_SHELLCMD, APR_PROGRAM} apr_cmdtype_e; @@ -87,19 +92,24 @@ typedef enum {APR_WAIT, APR_NOWAIT} apr_wait_how_e; #define APR_LIMIT_MEM 1 #define APR_LIMIT_NPROC 2 -#if APR_HAS_OTHER_CHILD -#define APR_OC_REASON_DEATH 0 /* child has died, caller must call +#if APR_HAS_OTHER_CHILD || defined(DOXYGEN) +/** + * @defgroup Other_Child Other Child Flags + * @{ + */ +#define APR_OC_REASON_DEATH 0 /**< child has died, caller must call * unregister still */ -#define APR_OC_REASON_UNWRITABLE 1 /* write_fd is unwritable */ -#define APR_OC_REASON_RESTART 2 /* a restart is occuring, perform +#define APR_OC_REASON_UNWRITABLE 1 /**< write_fd is unwritable */ +#define APR_OC_REASON_RESTART 2 /**< a restart is occuring, perform * any necessary cleanup (including * sending a special signal to child) */ -#define APR_OC_REASON_UNREGISTER 3 /* unregister has been called, do +#define APR_OC_REASON_UNREGISTER 3 /**< unregister has been called, do * whatever is necessary (including * kill the child) */ -#define APR_OC_REASON_LOST 4 /* somehow the child exited without +#define APR_OC_REASON_LOST 4 /**< somehow the child exited without * us knowing ... buggy os? */ +/** @} */ #endif /* APR_HAS_OTHER_CHILD */ typedef struct apr_proc_t apr_proc_t; @@ -112,7 +122,7 @@ struct apr_proc_t { apr_file_t *in; /** Parent's side of pipe to child's stdout */ apr_file_t *out; - /* Parent's side of pipe to child's stdouterr */ + /** Parent's side of pipe to child's stdouterr */ apr_file_t *err; }; @@ -131,11 +141,11 @@ typedef struct apr_other_child_rec_t apr_other_child_rec_t; typedef void *(APR_THREAD_FUNC *apr_thread_start_t)(apr_thread_t*, void*); enum kill_conditions { - kill_never, /* process is never sent any signals */ - kill_always, /* process is sent SIGKILL on apr_pool_t cleanup */ - kill_after_timeout, /* SIGTERM, wait 3 seconds, SIGKILL */ - just_wait, /* wait forever for the process to complete */ - kill_only_once /* send SIGTERM and then wait */ + kill_never, /**< process is never sent any signals */ + kill_always, /**< process is sent SIGKILL on apr_pool_t cleanup */ + kill_after_timeout, /**< SIGTERM, wait 3 seconds, SIGKILL */ + just_wait, /**< wait forever for the process to complete */ + kill_only_once /**< send SIGTERM and then wait */ }; /** A list of processes */ @@ -150,8 +160,7 @@ struct process_chain { * kill_only_once -- send SIGTERM and then wait </PRE> */ enum kill_conditions kill_how; - /** The next process in the list - * @defvar process_chain *next */ + /** The next process in the list */ struct process_chain *next; }; @@ -163,7 +172,6 @@ struct process_chain { * Create and initialize a new threadattr variable * @param new_attr The newly created threadattr. * @param cont The pool to use - * @deffunc apr_status_t apr_threadattr_create(apr_threadattr_t **new_attr, apr_pool_t *cont) */ APR_DECLARE(apr_status_t) apr_threadattr_create(apr_threadattr_t **new_attr, apr_pool_t *cont); @@ -172,7 +180,6 @@ APR_DECLARE(apr_status_t) apr_threadattr_create(apr_threadattr_t **new_attr, * Set if newly created threads should be created in detached state. * @param attr The threadattr to affect * @param on Thread detach state on or off - * @deffunc apr_status_t apr_threadattr_detach_set(apr_threadattr_t *attr, apr_int32_t on) */ APR_DECLARE(apr_status_t) apr_threadattr_detach_set(apr_threadattr_t *attr, apr_int32_t on); @@ -180,7 +187,6 @@ APR_DECLARE(apr_status_t) apr_threadattr_detach_set(apr_threadattr_t *attr, /** * Get the detach state for this threadattr. * @param attr The threadattr to reference - * @deffunc apr_status_t apr_threadattr_detach_get(apr_threadattr_t *attr) */ APR_DECLARE(apr_status_t) apr_threadattr_detach_get(apr_threadattr_t *attr); @@ -191,7 +197,6 @@ APR_DECLARE(apr_status_t) apr_threadattr_detach_get(apr_threadattr_t *attr); * @param func The function to start the new thread in * @param data Any data to be passed to the starting function * @param cont The pool to use - * @deffunc 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) */ APR_DECLARE(apr_status_t) apr_thread_create(apr_thread_t **new_thread, apr_threadattr_t *attr, @@ -202,7 +207,6 @@ APR_DECLARE(apr_status_t) apr_thread_create(apr_thread_t **new_thread, * stop the current thread * @param thd The thread to stop * @param retval The return value to pass back to any thread that cares - * @deffunc apr_status_t apr_thread_exit(apr_thread_t *thd, apr_status_t *retval) */ APR_DECLARE(apr_status_t) apr_thread_exit(apr_thread_t *thd, apr_status_t *retval); @@ -211,21 +215,18 @@ APR_DECLARE(apr_status_t) apr_thread_exit(apr_thread_t *thd, * block until the desired thread stops executing. * @param retval The return value from the dead thread. * @param thd The thread to join - * @deffunc 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 - * @deffunc void apr_thread_yield() */ APR_DECLARE(void) apr_thread_yield(void); /** * detach a thread * @param thd The thread to detach - * @deffunc apr_status_t apr_thread_detach(apr_thread_t *thd) */ APR_DECLARE(apr_status_t) apr_thread_detach(apr_thread_t *thd); @@ -234,7 +235,6 @@ APR_DECLARE(apr_status_t) apr_thread_detach(apr_thread_t *thd); * @param data The user data associated with the thread. * @param key The key to associate with the data * @param thread The currently open thread. - * @deffunc apr_status_t apr_thread_data_get(void **data, const char *key, apr_thread_t *thread) */ APR_DECLARE(apr_status_t) apr_thread_data_get(void **data, const char *key, apr_thread_t *thread); @@ -245,7 +245,6 @@ APR_DECLARE(apr_status_t) apr_thread_data_get(void **data, const char *key, * @param key The key to use for associating the data with the tread * @param cleanup The cleanup routine to use when the thread is destroyed. * @param thread The currently open thread. - * @deffunc apr_status_t apr_thread_data_set(void *data, const char *key, apr_status_t (*cleanup) (void *), apr_thread_t *thread) */ APR_DECLARE(apr_status_t) apr_thread_data_set(void *data, const char *key, apr_status_t (*cleanup) (void *), @@ -256,7 +255,6 @@ APR_DECLARE(apr_status_t) apr_thread_data_set(void *data, const char *key, * @param key The thread private handle. * @param dest The destructor to use when freeing the private memory. * @param cont The pool to use - * @deffunc apr_status_t apr_threadkey_private_create(apr_threadkey_t **key, void (*dest)(void *), apr_pool_t *cont) */ APR_DECLARE(apr_status_t) apr_threadkey_private_create(apr_threadkey_t **key, void (*dest)(void *), @@ -266,7 +264,6 @@ APR_DECLARE(apr_status_t) apr_threadkey_private_create(apr_threadkey_t **key, * 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 - * @deffunc apr_status_t apr_threadkey_private_get(void **new_mem, apr_threadkey_t *key) */ APR_DECLARE(apr_status_t) apr_threadkey_private_get(void **new_mem, apr_threadkey_t *key); @@ -275,7 +272,6 @@ APR_DECLARE(apr_status_t) apr_threadkey_private_get(void **new_mem, * 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 - * @deffunc apr_status_t apr_threadkey_private_set(void *priv, apr_threadkey_t *key) */ APR_DECLARE(apr_status_t) apr_threadkey_private_set(void *priv, apr_threadkey_t *key); @@ -283,7 +279,6 @@ APR_DECLARE(apr_status_t) apr_threadkey_private_set(void *priv, /** * Free the thread private memory * @param key The handle for the desired thread private memory - * @deffunc apr_status_t apr_threadkey_private_delete(apr_threadkey_t *key) */ APR_DECLARE(apr_status_t) apr_threadkey_private_delete(apr_threadkey_t *key); @@ -292,7 +287,6 @@ APR_DECLARE(apr_status_t) apr_threadkey_private_delete(apr_threadkey_t *key); * @param data The user data associated with the threadkey. * @param key The key associated with the data * @param threadkey The currently open threadkey. - * @deffunc apr_status_t apr_threadkey_data_get(void **data, const char *key, apr_threadkey_t *threadkey) */ APR_DECLARE(apr_status_t) apr_threadkey_data_get(void **data, const char *key, apr_threadkey_t *threadkey); @@ -303,7 +297,6 @@ APR_DECLARE(apr_status_t) apr_threadkey_data_get(void **data, const char *key, * @param key The key to associate with the data. * @param cleanup The cleanup routine to use when the file is destroyed. * @param threadkey The currently open threadkey. - * @deffunc apr_status_t apr_threadkey_data_set(void *data, const char *key, apr_status_t (*cleanup) (void *), apr_threadkey_t *threadkey) */ APR_DECLARE(apr_status_t) apr_threadkey_data_set(void *data, const char *key, apr_status_t (*cleanup) (void *), @@ -321,7 +314,6 @@ 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 cont The pool to use - * @deffunc apr_status_t apr_procattr_create(apr_procattr_t **new_attr, apr_pool_t *cont) */ APR_DECLARE(apr_status_t) apr_procattr_create(apr_procattr_t **new_attr, apr_pool_t *cont); @@ -333,7 +325,6 @@ APR_DECLARE(apr_status_t) apr_procattr_create(apr_procattr_t **new_attr, * @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? - * @deffunc apr_status_t apr_procattr_io_set(apr_procattr_t *attr, apr_int32_t in, apr_int32_t out, apr_int32_t err) */ APR_DECLARE(apr_status_t) apr_procattr_io_set(apr_procattr_t *attr, apr_int32_t in, apr_int32_t out, @@ -344,13 +335,12 @@ APR_DECLARE(apr_status_t) apr_procattr_io_set(apr_procattr_t *attr, * @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. - * @deffunc apr_status_t apr_procattr_child_in_set(struct apr_procattr_t *attr, apr_file_t *child_in, apr_file_t *parent_in) - * @tip 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 - * extra function calls by not creating your own pipe since this - * creates one in the process space for you. + * @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 + * extra function calls by not creating your own pipe since this + * creates one in the process space for you. */ APR_DECLARE(apr_status_t) apr_procattr_child_in_set(struct apr_procattr_t *attr, apr_file_t *child_in, @@ -361,11 +351,10 @@ APR_DECLARE(apr_status_t) apr_procattr_child_in_set(struct apr_procattr_t *attr, * @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. - * @deffunc apr_status_t apr_procattr_child_out_set(struct apr_procattr_t *attr, apr_file_t *child_out, apr_file_t *parent_out) - * @tip 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. + * @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. */ APR_DECLARE(apr_status_t) apr_procattr_child_out_set(struct apr_procattr_t *attr, apr_file_t *child_out, @@ -376,11 +365,10 @@ APR_DECLARE(apr_status_t) apr_procattr_child_out_set(struct apr_procattr_t *attr * @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. - * @deffunc apr_status_t apr_procattr_child_err_set(struct apr_procattr_t *attr, apr_file_t *child_err, apr_file_t *parent_err) - * @tip 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. + * @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. */ APR_DECLARE(apr_status_t) apr_procattr_child_err_set(struct apr_procattr_t *attr, apr_file_t *child_err, @@ -392,7 +380,6 @@ APR_DECLARE(apr_status_t) apr_procattr_child_err_set(struct apr_procattr_t *attr * @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. - * @deffunc apr_status_t apr_procattr_dir_set(apr_procattr_t *attr, const char *dir) */ APR_DECLARE(apr_status_t) apr_procattr_dir_set(apr_procattr_t *attr, const char *dir); @@ -405,7 +392,6 @@ APR_DECLARE(apr_status_t) apr_procattr_dir_set(apr_procattr_t *attr, * APR_SHELLCMD -- Shell script * APR_PROGRAM -- Executable program (default) * </PRE> - * @deffunc apr_status_t apr_procattr_cmdtype_set(apr_procattr_t *attr, apr_cmdtype_e cmd) */ APR_DECLARE(apr_status_t) apr_procattr_cmdtype_set(apr_procattr_t *attr, apr_cmdtype_e cmd); @@ -414,7 +400,6 @@ APR_DECLARE(apr_status_t) apr_procattr_cmdtype_set(apr_procattr_t *attr, * Determine if the chlid should start in detached state. * @param attr The procattr we care about. * @param detach Should the child start in detached state? Default is no. - * @deffunc apr_status_t apr_procattr_detach_set(apr_procattr_t *attr, apr_int32_t detach) */ APR_DECLARE(apr_status_t) apr_procattr_detach_set(apr_procattr_t *attr, apr_int32_t detach); @@ -430,7 +415,6 @@ APR_DECLARE(apr_status_t) apr_procattr_detach_set(apr_procattr_t *attr, * APR_LIMIT_NPROC * </PRE> * @param limit Value to set the limit to. - * @deffunc apr_status_t apr_procattr_limit_set(apr_procattr_t *attr, apr_int32_t what, apr_int32_t what, struct rlimit *limit) */ APR_DECLARE(apr_status_t) apr_procattr_limit_set(apr_procattr_t *attr, apr_int32_t what, @@ -443,7 +427,6 @@ APR_DECLARE(apr_status_t) apr_procattr_limit_set(apr_procattr_t *attr, * a standard unix fork. * @param proc The resulting process handle. * @param cont The pool to use. - * @deffunc apr_status_t apr_proc_fork(apr_proc_t *proc, apr_pool_t *cont) */ APR_DECLARE(apr_status_t) apr_proc_fork(apr_proc_t *proc, apr_pool_t *cont); #endif @@ -459,7 +442,6 @@ APR_DECLARE(apr_status_t) apr_proc_fork(apr_proc_t *proc, apr_pool_t *cont); * @param attr the procattr we should use to determine how to create the new * process * @param cont The pool to use. - * @deffunc 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, apr_pool_t *cont) */ APR_DECLARE(apr_status_t) apr_proc_create(apr_proc_t *new_proc, const char *progname, @@ -477,8 +459,7 @@ APR_DECLARE(apr_status_t) apr_proc_create(apr_proc_t *new_proc, * APR_NOWAIT -- return immediately regardless of if the * child is dead or not. * </PRE> - * @deffunc apr_status_t apr_proc_wait(apr_proc_t *proc, apr_wait_how_e waithow) - * @tip The childs status is in the return code to this process. It is one of: + * @remark The childs status is in the return code to this process. It is one of: * <PRE> * APR_CHILD_DONE -- child is no longer running. * APR_CHILD_NOTDONE -- child is still running. @@ -502,7 +483,6 @@ APR_DECLARE(apr_status_t) apr_proc_wait(apr_proc_t *proc, * child is dead or not. * </PRE> * @param p Pool to allocate child information out of. - * @deffunc apr_status_t apr_proc_wait_all_procs(apr_proc_t *proc, apr_wait_t *status, apr_wait_how_e waithow, apr_pool_t *p) */ APR_DECLARE(apr_status_t) apr_proc_wait_all_procs(apr_proc_t *proc, apr_wait_t *status, @@ -527,7 +507,6 @@ apr_status_t apr_proc_detach(void); * then the maintenance is invoked with reason * OC_REASON_UNWRITABLE. * @param p The pool to use for allocating memory. - * @deffunc void apr_proc_other_child_register(apr_proc_t *pid, void (*maintenance) (int reason, void *, int status), void *data, apr_file_t *write_fd, apr_pool_t *p) */ APR_DECLARE(void) apr_proc_other_child_register(apr_proc_t *pid, void (*maintenance) (int reason, @@ -540,11 +519,10 @@ APR_DECLARE(void) apr_proc_other_child_register(apr_proc_t *pid, * Stop watching the specified process. * @param data The data to pass to the maintenance function. This is * used to find the process to unregister. - * @deffunc void apr_proc_other_child_unregister(void *data) - * @tip 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 - * function. + * @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 + * function. */ APR_DECLARE(void) apr_proc_other_child_unregister(void *data); @@ -553,14 +531,12 @@ APR_DECLARE(void) apr_proc_other_child_unregister(void *data); * function. * @param pid The process to check. * @param status The status to pass to the maintenance function. - * @deffunc apr_status_t apr_proc_other_child_read(apr_proc_t *pid, int status); */ APR_DECLARE(apr_status_t) apr_proc_other_child_read(apr_proc_t *pid, int status); /** * Loop through all registered other_children and call the appropriate * maintenance function when necessary. - * @deffunc void apr_proc_other_child_check(); */ APR_DECLARE(void) apr_proc_other_child_check(void); @@ -570,7 +546,6 @@ APR_DECLARE(void) apr_proc_other_child_check(void); * Terminate a process. * @param proc The process to terminate. * @param sig How to kill the process. - * @deffunc apr_status_t apr_proc_kill(apr_proc_t *proc, int sig) */ APR_DECLARE(apr_status_t) apr_proc_kill(apr_proc_t *proc, int sig); @@ -586,7 +561,6 @@ APR_DECLARE(apr_status_t) apr_proc_kill(apr_proc_t *proc, int sig); * just_wait -- wait forever for the process to complete * kill_only_once -- send SIGTERM and then wait * </PRE> - * @deffunc void apr_pool_note_subprocess(struct apr_pool_t *a, apr_proc_t *pid, enum kill_conditions how) */ APR_DECLARE(void) apr_pool_note_subprocess(apr_pool_t *a, apr_proc_t *pid, enum kill_conditions how); @@ -597,8 +571,7 @@ APR_DECLARE(void) apr_pool_note_subprocess(apr_pool_t *a, apr_proc_t *pid, /** * Setup the process for a single thread to be used for all signal handling. - * @warn This must be called before any threads are created - * @deffunc apr_status_t apr_setup_signal_thread(void) + * @warning This must be called before any threads are created */ APR_DECLARE(apr_status_t) apr_setup_signal_thread(void); @@ -616,12 +589,11 @@ APR_DECLARE(apr_status_t) apr_signal_thread(int(*signal_handler)(int signum)); /** * Get the child-pool used by the thread from the thread info. * @return apr_pool_t the pool - * @deffunc apr_pool_t apr_thread_pool_get(apr_thread_t *i) */ APR_POOL_DECLARE_ACCESSOR(thread); #endif /* APR_HAS_THREADS */ - +/** @} */ #ifdef __cplusplus } #endif diff --git a/include/arch/netware/pre_nw.h b/include/arch/netware/pre_nw.h index 6a3d99c45..c75da3a5c 100644 --- a/include/arch/netware/pre_nw.h +++ b/include/arch/netware/pre_nw.h @@ -21,9 +21,11 @@ /* if we have wchar_t enabled in C++, predefine this type to avoid a conflict in Novell's header files */ +#ifndef DOXYGEN #if (__option(cplusplus) && __option(wchar_type)) #define _WCHAR_T #endif +#endif /* C9X defintion used by MSL C++ library */ #define DECIMAL_DIG 17 |