diff --git a/docs/doxygen.conf b/docs/doxygen.conf
index 614940f4c6..802a0765e8 100644
--- a/docs/doxygen.conf
+++ b/docs/doxygen.conf
@@ -50,10 +50,13 @@ PREDEFINED="APR_DECLARE(x)=x" \
APR_HAS_USER \
APR_HAS_LARGE_FILES \
APR_HAS_XTHREAD_FILES \
- DOXYGEN= \
- APU_DECLARE_DATA= \
- __pre_nw__= \
- "APU_DECLARE(x)=x"
+ DOXYGEN= \
+ APU_DECLARE_DATA= \
+ __pre_nw__= \
+ "APU_DECLARE(x)=x" \
+ "CACHE_DECLARE(x)=x" \
+ "PROXY_DECLARE(x)=x"
+
OPTIMIZE_OUTPUT_FOR_C=YES
diff --git a/include/ap_mmn.h b/include/ap_mmn.h
index 54067e81df..0156ffc779 100644
--- a/include/ap_mmn.h
+++ b/include/ap_mmn.h
@@ -215,20 +215,22 @@
/**
* Determine if the server's current MODULE_MAGIC_NUMBER is at least a
* specified value.
- *
+ *
* Useful for testing for features.
* For example, suppose you wish to use the apr_table_overlap
* function. You can do this:
*
+ * \code
* #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
* ... use apr_table_overlap()
* #else
* ... alternative code which doesn't use apr_table_overlap()
* #endif
- *
+ * \endcode
+ *
* @param major The major 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) \
((major) < MODULE_MAGIC_NUMBER_MAJOR \
diff --git a/include/ap_mpm.h b/include/ap_mpm.h
index 3a0da9de5d..69586ca111 100644
--- a/include/ap_mpm.h
+++ b/include/ap_mpm.h
@@ -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 newproc The resulting process handle.
* @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.
* @param env The new environment apr_table_t for the new process. This
* should be a list of NULL-terminated strings.
diff --git a/include/ap_regex.h b/include/ap_regex.h
index 340a27b1d5..2dbfcb35cd 100644
--- a/include/ap_regex.h
+++ b/include/ap_regex.h
@@ -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 pmatch Provide information regarding the location of any matches
* @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,
apr_size_t nmatch, ap_regmatch_t *pmatch, int eflags);
diff --git a/include/ap_regkey.h b/include/ap_regkey.h
index 84e3246a29..5c3b11da7b 100644
--- a/include/ap_regkey.h
+++ b/include/ap_regkey.h
@@ -91,7 +91,7 @@ AP_DECLARE(apr_status_t) ap_regkey_close(ap_regkey_t *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
*
* AP_REGKEY_CLASSES_ROOT
* 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.
* @param result The raw bytes value 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 valuename The named value to retrieve (pass "" for the default)
* @param pool The pool used to store the result
diff --git a/include/ap_slotmem.h b/include/ap_slotmem.h
index e43f4af00e..3d4f0620a9 100644
--- a/include/ap_slotmem.h
+++ b/include/ap_slotmem.h
@@ -20,7 +20,7 @@
/* Memory handler for a shared memory divided in slot.
*/
/**
- * @file slotmem.h
+ * @file ap_slotmem.h
* @brief Memory Slot Extension Storage Module for Apache
*
* @defgroup MEM mem
diff --git a/include/http_config.h b/include/http_config.h
index a140fb7cb8..f72b59c516 100644
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -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
* 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
* @param m The module to get the data for.
* @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
* 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
* @param m The module to set the data for.
* @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 arg The argument to the directive
* @return The cmd->help value as the error string
- * @tip This allows simple declarations such as;
- *
+ * @note This allows simple declarations such as:
+ * @code
* AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
* "The Foo directive is no longer supported, use Bar"),
- *
+ * @endcode
*/
AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd,
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);
/**
* 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
*/
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
- * @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);
/**
@@ -862,15 +862,17 @@ AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
/**
* parse an htaccess file
- * @param resulting htaccess_result
+ * @param result htaccess_result
* @param r The request currently being served
* @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 access_name The list of possible names for .htaccess files
* int The status of the current request
*/
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,
const char *path,
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 conftree The root node of the created config tree
* @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,
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
* @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
*/
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 plog The logging streams pool
* @param ptemp The temporary pool
+ * @param s the server to operate upon
* @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,
diff --git a/include/http_log.h b/include/http_log.h
index d406b811a8..d8d2b02be3 100644
--- a/include/http_log.h
+++ b/include/http_log.h
@@ -272,7 +272,7 @@ typedef struct piped_log piped_log;
* @param p The pool to allocate out of
* @param program The program to run in the logging process
* @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
*/
AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program);
diff --git a/include/http_main.h b/include/http_main.h
index dc0a0de61b..d32fae93d6 100644
--- a/include/http_main.h
+++ b/include/http_main.h
@@ -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 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
}
diff --git a/include/http_request.h b/include/http_request.h
index de87d99742..0c9b138d80 100644
--- a/include/http_request.h
+++ b/include/http_request.h
@@ -313,18 +313,18 @@ AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...);
* the response to the client
* @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) */
void ap_process_request_after_handler(request_rec *r);
- /**
+/**
* 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,
* asynchronous write completion
* @param r The current request
*/
-void ap_process_async_request(request_rec *);
+void ap_process_async_request(request_rec *r);
/**
* Kill the current request
diff --git a/include/httpd.h b/include/httpd.h
index 3a664a363d..d0ff3b08c9 100644
--- a/include/httpd.h
+++ b/include/httpd.h
@@ -1518,7 +1518,7 @@ AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partia
* Escape an html string
* @param p The pool to allocate from
* @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
*/
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);
/**
- * Given a string, replace any bare " with \" .
+ * Given a string, replace any bare " with \\" .
* @param p The pool to allocate memory from
- * @param instring The string to search for "
+ * @param instring The string to search for "
* @return A copy of the string with escaped quotes
*/
AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
diff --git a/include/mod_core.h b/include/mod_core.h
index f7b363de1e..714064c7bb 100644
--- a/include/mod_core.h
+++ b/include/mod_core.h
@@ -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.
* @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.
* request method was not TRACE.
*/
diff --git a/include/mpm_common.h b/include/mpm_common.h
index 8b7077a224..e5fe358853 100644
--- a/include/mpm_common.h
+++ b/include/mpm_common.h
@@ -86,10 +86,11 @@ extern "C" {
* @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
* on its own before signalling it.
- * @tip This function requires that a hook is implemented by the MPM:
+ * @note This function requires that a hook is implemented by the MPM:
* mpm_note_child_killed -- Note the child died in the scoreboard
*
- * @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
* 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
* which have exited. This includes processes registered as "other_children".
- * @tip This function requires that a hook is implemented by the MPM:
+ *
+ * @note This function requires that a hook is implemented by the MPM:
* mpm_note_child_killed -- Note the child died in the scoreboard
*
- * @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
* 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.
* @param pid The process id of an MPM child process which should be
* 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
* 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
* macro SCOREBOARD_MAINTENANCE_INTERVAL.
* @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 p The pool to allocate out of
* @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
* parent signalling it.
* @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
* @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
* processes that it is time to die gracefully.
* @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);
@@ -214,20 +222,22 @@ AP_DECLARE(apr_status_t) ap_mpm_pod_check(ap_pod_t *pod);
/**
* 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);
/**
* Write data to the pipe-of-death, signalling that one child process
* 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);
/**
* Write data to the pipe-of-death, signalling that all child process
* 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
*/
AP_DECLARE(void) ap_mpm_pod_killpg(ap_pod_t *pod, int num);
diff --git a/include/util_filter.h b/include/util_filter.h
index cbd390f6cf..8c169de6cd 100644
--- a/include/util_filter.h
+++ b/include/util_filter.h
@@ -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
*
* @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 c The connection to add the filter for
* @note If adding a connection-level output filter (i.e. where the type
diff --git a/include/util_script.h b/include/util_script.h
index d7e7eae080..fe638ee07b 100644
--- a/include/util_script.h
+++ b/include/util_script.h
@@ -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.
* @param termch Pointer to the last character 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
- * @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,
char *buffer,
@@ -134,7 +135,6 @@ AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
act like gets()
* @param getsfunc_data The place to read from
* @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,
int (*getsfunc) (char *, int, void *),
diff --git a/modules/cache/cache_hash.h b/modules/cache/cache_hash.h
index 13a5eb4c31..37ae3e65c3 100644
--- a/modules/cache/cache_hash.h
+++ b/modules/cache/cache_hash.h
@@ -98,11 +98,9 @@ void* cache_hash_get(cache_hash_t *ht, const void *key,
/**
* Start iterating over the entries in a hash table.
* @param ht The hash table
- * @example
- */
-/**
- *
- *
+ *
+ * Here is an example of using this:
+ * @code
* int sum_values(cache_hash_t *ht)
* {
* cache_hash_index_t *hi;
@@ -114,12 +112,12 @@ void* cache_hash_get(cache_hash_t *ht, const void *key,
* }
* return sum;
* }
- *
+ * @endcode
+ *
* There is no restriction on adding or deleting hash entries during an
* iteration (although the results may be unpredictable unless all you do
* is delete the current entry) and multiple iterations can be in
* progress at the same time.
- *
*/
cache_hash_index_t* cache_hash_first(cache_hash_t *ht);
diff --git a/modules/cache/cache_pqueue.h b/modules/cache/cache_pqueue.h
index 13238c03d7..469648644d 100644
--- a/modules/cache/cache_pqueue.h
+++ b/modules/cache/cache_pqueue.h
@@ -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 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_get_priority pri,
@@ -108,15 +108,14 @@ void cache_pq_change_priority(cache_pqueue_t *q,
/**
* pop the highest-ranking item from the queue.
- * @param p the queue
- * @param d where to copy the entry to
+ * @param q the queue
* @return NULL on error, otherwise the entry
*/
void *cache_pq_pop(cache_pqueue_t *q);
/**
* remove an item from the queue.
- * @param p the queue
+ * @param q the queue
* @param d the entry
* @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.
* @param q the queue
- * @param d the entry
* @return NULL on error, otherwise the entry
*/
void *cache_pq_peek(cache_pqueue_t *q);
@@ -136,7 +134,7 @@ void *cache_pq_peek(cache_pqueue_t *q);
* DEBUG function only
* @param q the queue
* @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,
FILE *out,
@@ -148,7 +146,7 @@ void cache_pq_print(cache_pqueue_t *q,
* debug function only
* @param q the queue
* @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,
FILE *out,
diff --git a/modules/core/mod_watchdog.h b/modules/core/mod_watchdog.h
index 540048161e..9de553432d 100644
--- a/modules/core/mod_watchdog.h
+++ b/modules/core/mod_watchdog.h
@@ -111,8 +111,8 @@ typedef struct ap_watchdog_t ap_watchdog_t;
/**
* Callback function used for watchdog.
- * @param state Watchdog state function. See AP_WATCHDOG_STATE_ .
- * @param data is what was passed to @ap_watchdog_register_callback function.
+ * @param state Watchdog state function. See @p AP_WATCHDOG_STATE_ .
+ * @param data is what was passed to @p ap_watchdog_register_callback function.
* @param pool Temporary callback pool destroyed after the call.
* @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 parent Non-zero to get the parent process 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
- * @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
* and function will create a new watchdog instance.
* 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.
- * @param watchdog Watchdog to use
+ * @param w Watchdog to use
* @param interval New interval on which the callback function will execute.
* @param callback The function to call on watchdog event.
* @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.
- * 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 pool Temporary pool destroyed after the call.
*/
diff --git a/modules/generators/mod_cgi.h b/modules/generators/mod_cgi.h
index 2192dd18ae..f34a31b6b8 100644
--- a/modules/generators/mod_cgi.h
+++ b/modules/generators/mod_cgi.h
@@ -53,9 +53,8 @@ typedef struct {
* @param p The pool to allocate correct cmd/argv elements within.
* @param process_cgi Set true if processing r->filename and r->args
* as a CGI invocation, otherwise false
- * @param type Set to APR_SHELLCMD or APR_PROGRAM on entry, may be
- * changed to invoke the program with alternate semantics.
- * @param detach Should the child start in detached state? Default is no.
+ * @param e_info pass e_info.cmd_type (Set to APR_SHELLCMD or APR_PROGRAM on entry)
+ and e_info.detached (Should the child start in detached state?)
* @remark This callback may be registered by the os-specific module
* to correct the command and arguments for apr_proc_create invocation
* on a given os. mod_cgi will call the function if registered.
diff --git a/modules/proxy/ajp.h b/modules/proxy/ajp.h
index cad2e27bcd..0674cde5b9 100644
--- a/modules/proxy/ajp.h
+++ b/modules/proxy/ajp.h
@@ -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
*
- * @param msg AJP Message to get value from
- * @param rvalue Pointer where value will be returned
- * @param rvalueLen Pointer where Byte array len will be returned
- * @return APR_SUCCESS or error
+ * @param msg AJP Message to get value from
+ * @param rvalue Pointer where value will be returned
+ * @param rvalue_len Pointer where Byte array len will be returned
+ * @return APR_SUCCESS or error
*/
apr_status_t ajp_msg_get_bytes(ajp_msg_t *msg, apr_byte_t **rvalue,
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) |
* +-----------------------+
*
- * @param smsg AJP message to put serialized message
+ * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error
*/
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) |
* +-----------------------+
*
- * @param smsg AJP message to put serialized message
+ * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error
*/
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
*
- * @param soct backend socket
- * @param smsg AJP message to put serialized message
+ * @param sock backend socket
+ * @param msg AJP message to put serialized message
* @return APR_SUCCESS or error
*/
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
*
* @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
*/
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 r current request
* @param buffsize max size of the AJP packet.
- * @uri uri requested uri
+ * @param uri requested uri
* @return APR_SUCCESS or error
*/
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
* @param r current request
+ * @param conf proxy config
* @param msg AJP message
* @return APR_SUCCESS or error
*/
diff --git a/modules/proxy/mod_proxy.h b/modules/proxy/mod_proxy.h
index 5762bf14c8..aebfb12a04 100644
--- a/modules/proxy/mod_proxy.h
+++ b/modules/proxy/mod_proxy.h
@@ -593,7 +593,7 @@ PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
* Add the worker to the balancer
* @param pool memory pool for adding worker
* @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.
*/
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
- * @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
*/
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,
char *server_portstr,
int server_portstr_size);
+
/**
* Mark a worker for retry
* @param proxy_function calling proxy scheme (http, ajp, ...)
- * @param conf current proxy server configuration
* @param worker worker used for retrying
* @param s current server record
* @return OK if marked for retry, DECLINED otherwise
diff --git a/modules/ssl/ssl_private.h b/modules/ssl/ssl_private.h
index e76885d302..69ad3db6a2 100644
--- a/modules/ssl/ssl_private.h
+++ b/modules/ssl/ssl_private.h
@@ -53,22 +53,22 @@
#define MOD_SSL_VERSION AP_SERVER_BASEREVISION
-/** mod_ssl headers */
+/* mod_ssl headers */
#include "ssl_toolkit_compat.h"
#include "ssl_expr.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 :-(
*/
#if APR_HAVE_SYS_TIME_H
#include
#endif
#if APR_HAVE_UNISTD_H
-#include /** needed for STDIN_FILENO et.al., at least on FreeBSD */
+#include /* needed for STDIN_FILENO et.al., at least on FreeBSD */
#endif
-/**
+/*
* Provide reasonable default for some defines
*/
#ifndef FALSE
@@ -509,7 +509,7 @@ struct SSLSrvConfigRec {
/**
* Define the mod_ssl per-directory configuration structure
- * (i.e. the local configuration for all
+ * (i.e. the local configuration for all <Directory>
* and .htaccess contexts)
*/
typedef struct {