1
0
mirror of https://github.com/apache/httpd.git synced 2025-08-07 04:02:58 +03:00

Fix a lot of doxygen warnings. Thanks to Brad Hards for the patch.

I added a few more fixes, and there are still more that might
need a doxygen expert.

PR: 48061
Submitted by: Brad Hards
Reviewed by: poirier


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@830527 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Earl Poirier
2009-10-28 13:25:49 +00:00
parent bdb4326fa5
commit 04fd4abf90
22 changed files with 100 additions and 83 deletions

View File

@@ -50,10 +50,13 @@ PREDEFINED="APR_DECLARE(x)=x" \
APR_HAS_USER \ APR_HAS_USER \
APR_HAS_LARGE_FILES \ APR_HAS_LARGE_FILES \
APR_HAS_XTHREAD_FILES \ APR_HAS_XTHREAD_FILES \
DOXYGEN= \ DOXYGEN= \
APU_DECLARE_DATA= \ APU_DECLARE_DATA= \
__pre_nw__= \ __pre_nw__= \
"APU_DECLARE(x)=x" "APU_DECLARE(x)=x" \
"CACHE_DECLARE(x)=x" \
"PROXY_DECLARE(x)=x"
OPTIMIZE_OUTPUT_FOR_C=YES OPTIMIZE_OUTPUT_FOR_C=YES

View File

@@ -215,20 +215,22 @@
/** /**
* Determine if the server's current MODULE_MAGIC_NUMBER is at least a * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
* specified value. * specified value.
* <pre> *
* Useful for testing for features. * Useful for testing for features.
* For example, suppose you wish to use the apr_table_overlap * For example, suppose you wish to use the apr_table_overlap
* function. You can do this: * function. You can do this:
* *
* \code
* #if AP_MODULE_MAGIC_AT_LEAST(19980812,2) * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
* ... use apr_table_overlap() * ... use apr_table_overlap()
* #else * #else
* ... alternative code which doesn't use apr_table_overlap() * ... alternative code which doesn't use apr_table_overlap()
* #endif * #endif
* </pre> * \endcode
*
* @param major The major module magic number * @param major The major module magic number
* @param minor The minor module magic number * @param minor The minor module magic number
* @fn AP_MODULE_MAGIC_AT_LEAST(int major, int minor) * @def AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
*/ */
#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \ #define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
((major) < MODULE_MAGIC_NUMBER_MAJOR \ ((major) < MODULE_MAGIC_NUMBER_MAJOR \

View File

@@ -95,7 +95,7 @@ AP_DECLARE_HOOK(int, mpm, (apr_pool_t *pconf, apr_pool_t *plog, server_rec *serv
* @param r The request_rec of the current request * @param r The request_rec of the current request
* @param newproc The resulting process handle. * @param newproc The resulting process handle.
* @param progname The program to run * @param progname The program to run
* @param const_args the arguments to pass to the new program. The first * @param args the arguments to pass to the new program. The first
* one should be the program name. * one should be the program name.
* @param env The new environment apr_table_t for the new process. This * @param env The new environment apr_table_t for the new process. This
* should be a list of NULL-terminated strings. * should be a list of NULL-terminated strings.

View File

@@ -112,7 +112,7 @@ AP_DECLARE(int) ap_regcomp(ap_regex_t *preg, const char *regex, int cflags);
* @param nmatch Provide information regarding the location of any matches * @param nmatch Provide information regarding the location of any matches
* @param pmatch Provide information regarding the location of any matches * @param pmatch Provide information regarding the location of any matches
* @param eflags Bitwise OR of any of AP_REG_* flags * @param eflags Bitwise OR of any of AP_REG_* flags
* @return 0 for successful match, #REG_NOMATCH otherwise * @return 0 for successful match, \p REG_NOMATCH otherwise
*/ */
AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string, AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string,
apr_size_t nmatch, ap_regmatch_t *pmatch, int eflags); apr_size_t nmatch, ap_regmatch_t *pmatch, int eflags);

View File

@@ -91,7 +91,7 @@ AP_DECLARE(apr_status_t) ap_regkey_close(ap_regkey_t *key);
/** /**
* Win32 Only: Remove the given registry key. * Win32 Only: Remove the given registry key.
* @param parentkey The open registry key of the parent, or one of * @param parent The open registry key of the parent, or one of
* <PRE> * <PRE>
* AP_REGKEY_CLASSES_ROOT * AP_REGKEY_CLASSES_ROOT
* AP_REGKEY_CURRENT_CONFIG * AP_REGKEY_CURRENT_CONFIG
@@ -145,6 +145,7 @@ AP_DECLARE(apr_status_t) ap_regkey_value_set(ap_regkey_t *key,
* Win32 Only: Retrieve a raw byte value from an open key. * Win32 Only: Retrieve a raw byte value from an open key.
* @param result The raw bytes value retrieved * @param result The raw bytes value retrieved
* @param resultsize Pointer to a variable to store the number raw bytes retrieved * @param resultsize Pointer to a variable to store the number raw bytes retrieved
* @param resulttype Pointer to a variable to store the registry type of the value retrieved
* @param key The registry key to retrieve the value from * @param key The registry key to retrieve the value from
* @param valuename The named value to retrieve (pass "" for the default) * @param valuename The named value to retrieve (pass "" for the default)
* @param pool The pool used to store the result * @param pool The pool used to store the result

View File

@@ -20,7 +20,7 @@
/* Memory handler for a shared memory divided in slot. /* Memory handler for a shared memory divided in slot.
*/ */
/** /**
* @file slotmem.h * @file ap_slotmem.h
* @brief Memory Slot Extension Storage Module for Apache * @brief Memory Slot Extension Storage Module for Apache
* *
* @defgroup MEM mem * @defgroup MEM mem

View File

@@ -438,7 +438,7 @@ typedef struct ap_conf_vector_t ap_conf_vector_t;
/** /**
* Generic accessors for other modules to get at their own module-specific * Generic accessors for other modules to get at their own module-specific
* data * data
* @param conf_vector The vector in which the modules configuration is stored. * @param cv The vector in which the modules configuration is stored.
* usually r->per_dir_config or s->module_config * usually r->per_dir_config or s->module_config
* @param m The module to get the data for. * @param m The module to get the data for.
* @return The module-specific data * @return The module-specific data
@@ -449,7 +449,7 @@ AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
/** /**
* Generic accessors for other modules to set at their own module-specific * Generic accessors for other modules to set at their own module-specific
* data * data
* @param conf_vector The vector in which the modules configuration is stored. * @param cv The vector in which the modules configuration is stored.
* usually r->per_dir_config or s->module_config * usually r->per_dir_config or s->module_config
* @param m The module to set the data for. * @param m The module to set the data for.
* @param val The module-specific data to set * @param val The module-specific data to set
@@ -538,11 +538,11 @@ AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd,
* @param struct_ptr pointer into a given type * @param struct_ptr pointer into a given type
* @param arg The argument to the directive * @param arg The argument to the directive
* @return The cmd->help value as the error string * @return The cmd->help value as the error string
* @tip This allows simple declarations such as; * @note This allows simple declarations such as:
* <pre> * @code
* AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL, * AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
* "The Foo directive is no longer supported, use Bar"), * "The Foo directive is no longer supported, use Bar"),
* </pre> * @endcode
*/ */
AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd, AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd,
void *struct_ptr, void *struct_ptr,
@@ -575,13 +575,13 @@ AP_DECLARE(const char *) ap_add_module(module *m, apr_pool_t *p);
AP_DECLARE(void) ap_remove_module(module *m); AP_DECLARE(void) ap_remove_module(module *m);
/** /**
* Add a module to the chained modules list and the list of loaded modules * Add a module to the chained modules list and the list of loaded modules
* @param m The module structure of the module to add * @param mod The module structure of the module to add
* @param p The pool with the same lifetime as the module * @param p The pool with the same lifetime as the module
*/ */
AP_DECLARE(const char *) ap_add_loaded_module(module *mod, apr_pool_t *p); AP_DECLARE(const char *) ap_add_loaded_module(module *mod, apr_pool_t *p);
/** /**
* Remove a module fromthe chained modules list and the list of loaded modules * Remove a module fromthe chained modules list and the list of loaded modules
* @param m the module structure of the module to remove * @param mod the module structure of the module to remove
*/ */
AP_DECLARE(void) ap_remove_loaded_module(module *mod); AP_DECLARE(void) ap_remove_loaded_module(module *mod);
/** /**
@@ -862,15 +862,17 @@ AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
/** /**
* parse an htaccess file * parse an htaccess file
* @param resulting htaccess_result * @param result htaccess_result
* @param r The request currently being served * @param r The request currently being served
* @param override Which overrides are active * @param override Which overrides are active
* @param override_opts Which allow-override-opts bits are set
* @param path The path to the htaccess file * @param path The path to the htaccess file
* @param access_name The list of possible names for .htaccess files * @param access_name The list of possible names for .htaccess files
* int The status of the current request * int The status of the current request
*/ */
AP_CORE_DECLARE(int) ap_parse_htaccess(ap_conf_vector_t **result, AP_CORE_DECLARE(int) ap_parse_htaccess(ap_conf_vector_t **result,
request_rec *r, int override, request_rec *r,
int override,
int override_opts, int override_opts,
const char *path, const char *path,
const char *access_name); const char *access_name);
@@ -894,7 +896,7 @@ AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p,
* @param fname The name of the config file * @param fname The name of the config file
* @param conftree The root node of the created config tree * @param conftree The root node of the created config tree
* @param p Pool for general allocation * @param p Pool for general allocation
* @param ptem Pool for temporary allocation * @param ptemp Pool for temporary allocation
*/ */
AP_DECLARE(const char *) ap_process_resource_config(server_rec *s, AP_DECLARE(const char *) ap_process_resource_config(server_rec *s,
const char *fname, const char *fname,
@@ -918,7 +920,7 @@ AP_DECLARE(int) ap_process_config_tree(server_rec *s,
/** /**
* Store data which will be retained across unload/load of modules * Store data which will be retained across unload/load of modules
* @param key The unique key associated with this module's retained data * @param key The unique key associated with this module's retained data
* @param Size in bytes of the retained data (to be allocated) * @param size in bytes of the retained data (to be allocated)
* @return Address of new retained data structure, initially cleared * @return Address of new retained data structure, initially cleared
*/ */
AP_DECLARE(void *) ap_retained_data_create(const char *key, apr_size_t size); AP_DECLARE(void *) ap_retained_data_create(const char *key, apr_size_t size);
@@ -999,6 +1001,7 @@ AP_DECLARE_HOOK(int,pre_config,(apr_pool_t *pconf,apr_pool_t *plog,
* @param pconf The config pool * @param pconf The config pool
* @param plog The logging streams pool * @param plog The logging streams pool
* @param ptemp The temporary pool * @param ptemp The temporary pool
* @param s the server to operate upon
* @return OK or DECLINED on success anything else is a error * @return OK or DECLINED on success anything else is a error
*/ */
AP_DECLARE_HOOK(int,check_config,(apr_pool_t *pconf, apr_pool_t *plog, AP_DECLARE_HOOK(int,check_config,(apr_pool_t *pconf, apr_pool_t *plog,

View File

@@ -272,7 +272,7 @@ typedef struct piped_log piped_log;
* @param p The pool to allocate out of * @param p The pool to allocate out of
* @param program The program to run in the logging process * @param program The program to run in the logging process
* @return The piped log structure * @return The piped log structure
* @tip The log program is invoked as APR_PROGRAM_ENV, * @note The log program is invoked as @p APR_PROGRAM_ENV,
* @see ap_open_piped_log_ex to modify this behavior * @see ap_open_piped_log_ex to modify this behavior
*/ */
AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program); AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program);

View File

@@ -65,7 +65,7 @@ AP_DECLARE_DATA extern apr_array_header_t *ap_server_config_defines;
* @param status The exit status after sending signal * @param status The exit status after sending signal
* @param pool Memory pool to allocate from * @param pool Memory pool to allocate from
*/ */
APR_DECLARE_OPTIONAL_FN(int, ap_signal_server, (int *, apr_pool_t *)); APR_DECLARE_OPTIONAL_FN(int, ap_signal_server, (int *status, apr_pool_t *pool));
#ifdef __cplusplus #ifdef __cplusplus
} }

View File

@@ -313,18 +313,18 @@ AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...);
* the response to the client * the response to the client
* @param r The current request * @param r The current request
*/ */
void ap_process_request(request_rec *); void ap_process_request(request_rec *r);
/* For post-processing after a handler has finished with a request. (Commonly used after it was suspended) */ /* For post-processing after a handler has finished with a request. (Commonly used after it was suspended) */
void ap_process_request_after_handler(request_rec *r); void ap_process_request_after_handler(request_rec *r);
/** /**
* Process a top-level request from a client, allowing some or all of * Process a top-level request from a client, allowing some or all of
* the response to remain buffered in the core output filter for later, * the response to remain buffered in the core output filter for later,
* asynchronous write completion * asynchronous write completion
* @param r The current request * @param r The current request
*/ */
void ap_process_async_request(request_rec *); void ap_process_async_request(request_rec *r);
/** /**
* Kill the current request * Kill the current request

View File

@@ -1518,7 +1518,7 @@ AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partia
* Escape an html string * Escape an html string
* @param p The pool to allocate from * @param p The pool to allocate from
* @param s The html to escape * @param s The html to escape
* @param toasc Whether to escape all non-ASCII chars to &#nnn; * @param toasc Whether to escape all non-ASCII chars to \&\#nnn;
* @return The escaped string * @return The escaped string
*/ */
AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc); AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc);
@@ -1741,9 +1741,9 @@ AP_DECLARE(int) ap_ind(const char *str, char c); /* Sigh... */
AP_DECLARE(int) ap_rind(const char *str, char c); AP_DECLARE(int) ap_rind(const char *str, char c);
/** /**
* Given a string, replace any bare " with \" . * Given a string, replace any bare &quot; with \\&quot; .
* @param p The pool to allocate memory from * @param p The pool to allocate memory from
* @param instring The string to search for " * @param instring The string to search for &quot;
* @return A copy of the string with escaped quotes * @return A copy of the string with escaped quotes
*/ */
AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring); AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);

View File

@@ -75,7 +75,7 @@ AP_DECLARE(void) ap_basic_http_header(request_rec *r, apr_bucket_brigade *bb);
/** /**
* Send an appropriate response to an http TRACE request. * Send an appropriate response to an http TRACE request.
* @param r The current request * @param r The current request
* @tip returns DONE or the HTTP status error if it handles the TRACE, * @note returns DONE or the HTTP status error if it handles the TRACE,
* or DECLINED if the request was not for TRACE. * or DECLINED if the request was not for TRACE.
* request method was not TRACE. * request method was not TRACE.
*/ */

View File

@@ -86,10 +86,11 @@ extern "C" {
* @param terminate Either 1 or 0. If 1, send the child processes SIGTERM * @param terminate Either 1 or 0. If 1, send the child processes SIGTERM
* each time through the loop. If 0, give the process time to die * each time through the loop. If 0, give the process time to die
* on its own before signalling it. * on its own before signalling it.
* @tip This function requires that a hook is implemented by the MPM: <pre> * @note This function requires that a hook is implemented by the MPM: <pre>
* mpm_note_child_killed -- Note the child died in the scoreboard * mpm_note_child_killed -- Note the child died in the scoreboard
* </pre> * </pre>
* @tip The MPM child processes which are reclaimed are those listed *
* @note The MPM child processes which are reclaimed are those listed
* in the scoreboard as well as those currently registered via * in the scoreboard as well as those currently registered via
* ap_register_extra_mpm_process(). * ap_register_extra_mpm_process().
*/ */
@@ -98,10 +99,12 @@ void ap_reclaim_child_processes(int terminate);
/** /**
* Catch any child processes that have been spawned by the parent process * Catch any child processes that have been spawned by the parent process
* which have exited. This includes processes registered as "other_children". * which have exited. This includes processes registered as "other_children".
* @tip This function requires that a hook is implemented by the MPM: <pre> *
* @note This function requires that a hook is implemented by the MPM: <pre>
* mpm_note_child_killed -- Note the child died in the scoreboard * mpm_note_child_killed -- Note the child died in the scoreboard
* </pre> * </pre>
* @tip The MPM child processes which are relieved are those listed *
* @note The MPM child processes which are relieved are those listed
* in the scoreboard as well as those currently registered via * in the scoreboard as well as those currently registered via
* ap_register_extra_mpm_process(). * ap_register_extra_mpm_process().
*/ */
@@ -112,7 +115,8 @@ void ap_relieve_child_processes(void);
* an MPM child process which has no entry in the scoreboard. * an MPM child process which has no entry in the scoreboard.
* @param pid The process id of an MPM child process which should be * @param pid The process id of an MPM child process which should be
* reclaimed when ap_reclaim_child_processes() is called. * reclaimed when ap_reclaim_child_processes() is called.
* @tip If an extra MPM child process terminates prior to calling *
* @note If an extra MPM child process terminates prior to calling
* ap_reclaim_child_processes(), remove it from the list of such processes * ap_reclaim_child_processes(), remove it from the list of such processes
* by calling ap_unregister_extra_mpm_process(). * by calling ap_unregister_extra_mpm_process().
*/ */
@@ -143,6 +147,8 @@ apr_status_t ap_mpm_safe_kill(pid_t pid, int sig);
* this process sleeps for the amount of time specified by the MPM defined * this process sleeps for the amount of time specified by the MPM defined
* macro SCOREBOARD_MAINTENANCE_INTERVAL. * macro SCOREBOARD_MAINTENANCE_INTERVAL.
* @param status The return code if a process has died * @param status The return code if a process has died
* @param exitcode The returned exit status of the child, if a child process
* dies, or the signal that caused the child to die.
* @param ret The process id of the process that died * @param ret The process id of the process that died
* @param p The pool to allocate out of * @param p The pool to allocate out of
* @param s The server_rec to pass * @param s The server_rec to pass
@@ -154,6 +160,7 @@ void ap_wait_or_timeout(apr_exit_why_e *status, int *exitcode, apr_proc_t *ret,
* Log why a child died to the error log, if the child died without the * Log why a child died to the error log, if the child died without the
* parent signalling it. * parent signalling it.
* @param pid The child that has died * @param pid The child that has died
* @param why The return code of the child process
* @param status The status returned from ap_wait_or_timeout * @param status The status returned from ap_wait_or_timeout
* @return 0 on success, APEXIT_CHILDFATAL if MPM should terminate * @return 0 on success, APEXIT_CHILDFATAL if MPM should terminate
*/ */
@@ -204,6 +211,7 @@ struct ap_pod_t {
* Open the pipe-of-death. The pipe of death is used to tell all child * Open the pipe-of-death. The pipe of death is used to tell all child
* processes that it is time to die gracefully. * processes that it is time to die gracefully.
* @param p The pool to use for allocating the pipe * @param p The pool to use for allocating the pipe
* @param pod the pipe-of-death that is created.
*/ */
AP_DECLARE(apr_status_t) ap_mpm_pod_open(apr_pool_t *p, ap_pod_t **pod); AP_DECLARE(apr_status_t) ap_mpm_pod_open(apr_pool_t *p, ap_pod_t **pod);
@@ -214,20 +222,22 @@ AP_DECLARE(apr_status_t) ap_mpm_pod_check(ap_pod_t *pod);
/** /**
* Close the pipe-of-death * Close the pipe-of-death
*
* @param pod the pipe-of-death to close.
*/ */
AP_DECLARE(apr_status_t) ap_mpm_pod_close(ap_pod_t *pod); AP_DECLARE(apr_status_t) ap_mpm_pod_close(ap_pod_t *pod);
/** /**
* Write data to the pipe-of-death, signalling that one child process * Write data to the pipe-of-death, signalling that one child process
* should die. * should die.
* @param p The pool to use when allocating any required structures. * @param pod the pipe-of-death to write to.
*/ */
AP_DECLARE(apr_status_t) ap_mpm_pod_signal(ap_pod_t *pod); AP_DECLARE(apr_status_t) ap_mpm_pod_signal(ap_pod_t *pod);
/** /**
* Write data to the pipe-of-death, signalling that all child process * Write data to the pipe-of-death, signalling that all child process
* should die. * should die.
* @param p The pool to use when allocating any required structures. * @param pod The pipe-of-death to write to.
* @param num The number of child processes to kill * @param num The number of child processes to kill
*/ */
AP_DECLARE(void) ap_mpm_pod_killpg(ap_pod_t *pod, int num); AP_DECLARE(void) ap_mpm_pod_killpg(ap_pod_t *pod, int num);

View File

@@ -424,6 +424,7 @@ AP_DECLARE(ap_filter_t *) ap_add_output_filter(const char *name, void *ctx,
* (as returned by ap_register_output_filter()) rather than a filter name * (as returned by ap_register_output_filter()) rather than a filter name
* *
* @param f The filter handle to add * @param f The filter handle to add
* @param ctx Context data to set in the filter
* @param r The request to add this filter for (or NULL if it isn't associated with a request) * @param r The request to add this filter for (or NULL if it isn't associated with a request)
* @param c The connection to add the filter for * @param c The connection to add the filter for
* @note If adding a connection-level output filter (i.e. where the type * @note If adding a connection-level output filter (i.e. where the type

View File

@@ -113,10 +113,11 @@ AP_DECLARE(int) ap_scan_script_header_err_brigade(request_rec *r,
* error, the string that cause the error is stored here. * error, the string that cause the error is stored here.
* @param termch Pointer to the last character parsed. * @param termch Pointer to the last character parsed.
* @param termarg Pointer to an int to capture the last argument parsed. * @param termarg Pointer to an int to capture the last argument parsed.
* @param args String arguments to parse consecutively for headers, *
* a NULL argument terminates the list. * The varargs are string arguments to parse consecutively for headers,
* with a NULL argument to terminate the list.
*
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise * @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
* @fn int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
*/ */
AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r, AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
char *buffer, char *buffer,
@@ -134,7 +135,6 @@ AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
act like gets() act like gets()
* @param getsfunc_data The place to read from * @param getsfunc_data The place to read from
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise * @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
* @fn int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
*/ */
AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer, AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
int (*getsfunc) (char *, int, void *), int (*getsfunc) (char *, int, void *),

View File

@@ -98,11 +98,9 @@ void* cache_hash_get(cache_hash_t *ht, const void *key,
/** /**
* Start iterating over the entries in a hash table. * Start iterating over the entries in a hash table.
* @param ht The hash table * @param ht The hash table
* @example *
*/ * Here is an example of using this:
/** * @code
* <PRE>
*
* int sum_values(cache_hash_t *ht) * int sum_values(cache_hash_t *ht)
* { * {
* cache_hash_index_t *hi; * cache_hash_index_t *hi;
@@ -114,12 +112,12 @@ void* cache_hash_get(cache_hash_t *ht, const void *key,
* } * }
* return sum; * return sum;
* } * }
* * @endcode
*
* There is no restriction on adding or deleting hash entries during an * There is no restriction on adding or deleting hash entries during an
* iteration (although the results may be unpredictable unless all you do * iteration (although the results may be unpredictable unless all you do
* is delete the current entry) and multiple iterations can be in * is delete the current entry) and multiple iterations can be in
* progress at the same time. * progress at the same time.
* </PRE>
*/ */
cache_hash_index_t* cache_hash_first(cache_hash_t *ht); cache_hash_index_t* cache_hash_first(cache_hash_t *ht);

View File

@@ -70,7 +70,7 @@ typedef void (*cache_pqueue_print_entry)(FILE *out, void *a);
* @param get the callback function to get the current element's position * @param get the callback function to get the current element's position
* @param set the callback function to set the current element's position * @param set the callback function to set the current element's position
* *
* @Return the handle or NULL for insufficent memory * @return the handle or NULL for insufficent memory
*/ */
cache_pqueue_t *cache_pq_init(apr_ssize_t n, cache_pqueue_t *cache_pq_init(apr_ssize_t n,
cache_pqueue_get_priority pri, cache_pqueue_get_priority pri,
@@ -108,15 +108,14 @@ void cache_pq_change_priority(cache_pqueue_t *q,
/** /**
* pop the highest-ranking item from the queue. * pop the highest-ranking item from the queue.
* @param p the queue * @param q the queue
* @param d where to copy the entry to
* @return NULL on error, otherwise the entry * @return NULL on error, otherwise the entry
*/ */
void *cache_pq_pop(cache_pqueue_t *q); void *cache_pq_pop(cache_pqueue_t *q);
/** /**
* remove an item from the queue. * remove an item from the queue.
* @param p the queue * @param q the queue
* @param d the entry * @param d the entry
* @return APR_SUCCESS on success * @return APR_SUCCESS on success
*/ */
@@ -125,7 +124,6 @@ apr_status_t cache_pq_remove(cache_pqueue_t *q, void *d);
/** /**
* access highest-ranking item without removing it. * access highest-ranking item without removing it.
* @param q the queue * @param q the queue
* @param d the entry
* @return NULL on error, otherwise the entry * @return NULL on error, otherwise the entry
*/ */
void *cache_pq_peek(cache_pqueue_t *q); void *cache_pq_peek(cache_pqueue_t *q);
@@ -136,7 +134,7 @@ void *cache_pq_peek(cache_pqueue_t *q);
* DEBUG function only * DEBUG function only
* @param q the queue * @param q the queue
* @param out the output handle * @param out the output handle
* @param the callback function to print the entry * @param print the callback function to print the entry
*/ */
void cache_pq_print(cache_pqueue_t *q, void cache_pq_print(cache_pqueue_t *q,
FILE *out, FILE *out,
@@ -148,7 +146,7 @@ void cache_pq_print(cache_pqueue_t *q,
* debug function only * debug function only
* @param q the queue * @param q the queue
* @param out the output handle * @param out the output handle
* @param the callback function to print the entry * @param print the callback function to print the entry
*/ */
void cache_pq_dump(cache_pqueue_t *q, void cache_pq_dump(cache_pqueue_t *q,
FILE *out, FILE *out,

View File

@@ -111,8 +111,8 @@ typedef struct ap_watchdog_t ap_watchdog_t;
/** /**
* Callback function used for watchdog. * Callback function used for watchdog.
* @param state Watchdog state function. See AP_WATCHDOG_STATE_ . * @param state Watchdog state function. See @p AP_WATCHDOG_STATE_ .
* @param data is what was passed to @ap_watchdog_register_callback function. * @param data is what was passed to @p ap_watchdog_register_callback function.
* @param pool Temporary callback pool destroyed after the call. * @param pool Temporary callback pool destroyed after the call.
* @return APR_SUCCESS to continue calling this callback. * @return APR_SUCCESS to continue calling this callback.
*/ */
@@ -125,9 +125,9 @@ typedef apr_status_t ap_watchdog_callback_fn_t(int state, void *data,
* @param name Watchdog name. * @param name Watchdog name.
* @param parent Non-zero to get the parent process watchdog instance. * @param parent Non-zero to get the parent process watchdog instance.
* @param singleton Non-zero to get the singleton watchdog instance. * @param singleton Non-zero to get the singleton watchdog instance.
* @param pool The pool use. * @param p The pool to use.
* @return APR_SUCCESS if all went well * @return APR_SUCCESS if all went well
* @remark Use @AP_WATCHDOG_DEFAULT to get default watchdog instance. * @remark Use @p AP_WATCHDOG_DEFAULT to get default watchdog instance.
* If separate watchdog thread is needed provide unique name * If separate watchdog thread is needed provide unique name
* and function will create a new watchdog instance. * and function will create a new watchdog instance.
* Note that default client process watchdog works in singleton mode. * Note that default client process watchdog works in singleton mode.
@@ -150,7 +150,7 @@ APR_DECLARE_OPTIONAL_FN(apr_status_t, ap_watchdog_register_callback,
/** /**
* Update registered watchdog callback interval. * Update registered watchdog callback interval.
* @param watchdog Watchdog to use * @param w Watchdog to use
* @param interval New interval on which the callback function will execute. * @param interval New interval on which the callback function will execute.
* @param callback The function to call on watchdog event. * @param callback The function to call on watchdog event.
* @param data The data to pass to the callback function. * @param data The data to pass to the callback function.
@@ -201,7 +201,7 @@ APR_DECLARE_EXTERNAL_HOOK(ap, AP_WD, int, watchdog_exit, (
/** /**
* Fixed interval watchdog hook. * Fixed interval watchdog hook.
* It is called regulary on @AP_WD_TM_INTERVAL interval. * It is called regularly on @p AP_WD_TM_INTERVAL interval.
* @param name Watchdog name. * @param name Watchdog name.
* @param pool Temporary pool destroyed after the call. * @param pool Temporary pool destroyed after the call.
*/ */

View File

@@ -53,9 +53,8 @@ typedef struct {
* @param p The pool to allocate correct cmd/argv elements within. * @param p The pool to allocate correct cmd/argv elements within.
* @param process_cgi Set true if processing r->filename and r->args * @param process_cgi Set true if processing r->filename and r->args
* as a CGI invocation, otherwise false * as a CGI invocation, otherwise false
* @param type Set to APR_SHELLCMD or APR_PROGRAM on entry, may be * @param e_info pass e_info.cmd_type (Set to APR_SHELLCMD or APR_PROGRAM on entry)
* changed to invoke the program with alternate semantics. and e_info.detached (Should the child start in detached state?)
* @param detach Should the child start in detached state? Default is no.
* @remark This callback may be registered by the os-specific module * @remark This callback may be registered by the os-specific module
* to correct the command and arguments for apr_proc_create invocation * to correct the command and arguments for apr_proc_create invocation
* on a given os. mod_cgi will call the function if registered. * on a given os. mod_cgi will call the function if registered.

View File

@@ -315,10 +315,10 @@ apr_status_t ajp_msg_get_string(ajp_msg_t *msg, const char **rvalue);
/** /**
* Get a Byte array from AJP Message * Get a Byte array from AJP Message
* *
* @param msg AJP Message to get value from * @param msg AJP Message to get value from
* @param rvalue Pointer where value will be returned * @param rvalue Pointer where value will be returned
* @param rvalueLen Pointer where Byte array len will be returned * @param rvalue_len Pointer where Byte array len will be returned
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_msg_get_bytes(ajp_msg_t *msg, apr_byte_t **rvalue, apr_status_t ajp_msg_get_bytes(ajp_msg_t *msg, apr_byte_t **rvalue,
apr_size_t *rvalue_len); apr_size_t *rvalue_len);
@@ -349,7 +349,7 @@ apr_status_t ajp_msg_copy(ajp_msg_t *smsg, ajp_msg_t *dmsg);
* | PING CMD (1 byte) | * | PING CMD (1 byte) |
* +-----------------------+ * +-----------------------+
* *
* @param smsg AJP message to put serialized message * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_msg_serialize_ping(ajp_msg_t *msg); apr_status_t ajp_msg_serialize_ping(ajp_msg_t *msg);
@@ -361,7 +361,7 @@ apr_status_t ajp_msg_serialize_ping(ajp_msg_t *msg);
* | CPING CMD (1 byte) | * | CPING CMD (1 byte) |
* +-----------------------+ * +-----------------------+
* *
* @param smsg AJP message to put serialized message * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_msg_serialize_cping(ajp_msg_t *msg); apr_status_t ajp_msg_serialize_cping(ajp_msg_t *msg);
@@ -379,8 +379,8 @@ char * ajp_msg_dump(apr_pool_t *pool, ajp_msg_t *msg, char *err);
/** /**
* Send an AJP message to backend * Send an AJP message to backend
* *
* @param soct backend socket * @param sock backend socket
* @param smsg AJP message to put serialized message * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_ilink_send(apr_socket_t *sock, ajp_msg_t *msg); apr_status_t ajp_ilink_send(apr_socket_t *sock, ajp_msg_t *msg);
@@ -389,7 +389,7 @@ apr_status_t ajp_ilink_send(apr_socket_t *sock, ajp_msg_t *msg);
* Receive an AJP message from backend * Receive an AJP message from backend
* *
* @param sock backend socket * @param sock backend socket
* @param smsg AJP message to put serialized message * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_ilink_receive(apr_socket_t *sock, ajp_msg_t *msg); apr_status_t ajp_ilink_receive(apr_socket_t *sock, ajp_msg_t *msg);
@@ -399,7 +399,7 @@ apr_status_t ajp_ilink_receive(apr_socket_t *sock, ajp_msg_t *msg);
* @param sock backend socket * @param sock backend socket
* @param r current request * @param r current request
* @param buffsize max size of the AJP packet. * @param buffsize max size of the AJP packet.
* @uri uri requested uri * @param uri requested uri
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */
apr_status_t ajp_send_header(apr_socket_t *sock, request_rec *r, apr_status_t ajp_send_header(apr_socket_t *sock, request_rec *r,
@@ -451,6 +451,7 @@ int ajp_parse_type(request_rec *r, ajp_msg_t *msg);
/** /**
* Parse the header message from container * Parse the header message from container
* @param r current request * @param r current request
* @param conf proxy config
* @param msg AJP message * @param msg AJP message
* @return APR_SUCCESS or error * @return APR_SUCCESS or error
*/ */

View File

@@ -593,7 +593,7 @@ PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
* Add the worker to the balancer * Add the worker to the balancer
* @param pool memory pool for adding worker * @param pool memory pool for adding worker
* @param balancer balancer to add to * @param balancer balancer to add to
* @param balancer worker to add * @param worker worker to add
* @note Single worker can be added to multiple balancers. * @note Single worker can be added to multiple balancers.
*/ */
PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool, PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool,
@@ -632,7 +632,8 @@ PROXY_DECLARE(int) ap_proxy_post_request(proxy_worker *worker,
/** /**
* Request status function * Request status function
* @param status status of proxy request * @param status status of proxy request (result)
* @param r the request to obtain the status for
* @return OK or DECLINED * @return OK or DECLINED
*/ */
PROXY_DECLARE(int) ap_proxy_request_status(int *status, request_rec *r); PROXY_DECLARE(int) ap_proxy_request_status(int *status, request_rec *r);
@@ -662,10 +663,10 @@ PROXY_DECLARE(int) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r,
apr_port_t proxyport, apr_port_t proxyport,
char *server_portstr, char *server_portstr,
int server_portstr_size); int server_portstr_size);
/** /**
* Mark a worker for retry * Mark a worker for retry
* @param proxy_function calling proxy scheme (http, ajp, ...) * @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conf current proxy server configuration
* @param worker worker used for retrying * @param worker worker used for retrying
* @param s current server record * @param s current server record
* @return OK if marked for retry, DECLINED otherwise * @return OK if marked for retry, DECLINED otherwise

View File

@@ -53,22 +53,22 @@
#define MOD_SSL_VERSION AP_SERVER_BASEREVISION #define MOD_SSL_VERSION AP_SERVER_BASEREVISION
/** mod_ssl headers */ /* mod_ssl headers */
#include "ssl_toolkit_compat.h" #include "ssl_toolkit_compat.h"
#include "ssl_expr.h" #include "ssl_expr.h"
#include "ssl_util_ssl.h" #include "ssl_util_ssl.h"
/** The #ifdef macros are only defined AFTER including the above /* The #ifdef macros are only defined AFTER including the above
* therefore we cannot include these system files at the top :-( * therefore we cannot include these system files at the top :-(
*/ */
#if APR_HAVE_SYS_TIME_H #if APR_HAVE_SYS_TIME_H
#include <sys/time.h> #include <sys/time.h>
#endif #endif
#if APR_HAVE_UNISTD_H #if APR_HAVE_UNISTD_H
#include <unistd.h> /** needed for STDIN_FILENO et.al., at least on FreeBSD */ #include <unistd.h> /* needed for STDIN_FILENO et.al., at least on FreeBSD */
#endif #endif
/** /*
* Provide reasonable default for some defines * Provide reasonable default for some defines
*/ */
#ifndef FALSE #ifndef FALSE
@@ -509,7 +509,7 @@ struct SSLSrvConfigRec {
/** /**
* Define the mod_ssl per-directory configuration structure * Define the mod_ssl per-directory configuration structure
* (i.e. the local configuration for all <Directory> * (i.e. the local configuration for all &lt;Directory>
* and .htaccess contexts) * and .htaccess contexts)
*/ */
typedef struct { typedef struct {