From: Daniel Earl Poirier <poirier@apache.org>
Date: Tue, 3 Nov 2009 14:59:24 +0000 (+0000)
Subject: Fix remaining doxygen warnings.  "make dox" is now clean with doxygen
X-Git-Tag: 2.3.3~60
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e30af9ed74d2700516e092bf509612e55f977f03;p=apache

Fix remaining doxygen warnings.  "make dox" is now clean with doxygen
version 1.5.8.

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


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@832442 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/doxygen.conf b/docs/doxygen.conf
index 802a0765e8..95e11bc2ae 100644
--- a/docs/doxygen.conf
+++ b/docs/doxygen.conf
@@ -24,6 +24,7 @@ PREDEFINED="APR_DECLARE(x)=x" \
        "APR_DECLARE_NONSTD(x)=x" \
        "AP_DECLARE_HOOK(ret,name,args)=ret name args;" \
        "APR_DECLARE_OPTIONAL_FN(ret,name,args)=ret name args;" \
+       "APR_DECLARE_EXTERNAL_HOOK(ns,link,ret,name,args)= ret ns##_hook_##name args;" \
        "AP_DECLARE(x)=x" \
        "AP_DECLARE_NONSTD(x)=x" \
        AP_CORE_DECLARE(x)=x \
diff --git a/include/http_config.h b/include/http_config.h
index f72b59c516..4daf3d8c6e 100644
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -335,7 +335,8 @@ struct module_struct {
     void *dynamic_load_handle;
 
     /** A pointer to the next module in the list
-     *  @var module_struct *next */
+     *  @var module_struct *next
+     */
     struct module_struct *next;
 
     /** Magic Cookie to identify a module structure;  It's mainly 
@@ -731,28 +732,28 @@ typedef struct {
 
 /**
  * The topmost module in the list
- * @defvar module *ap_top_module
+ * @var module *ap_top_module
  */
 AP_DECLARE_DATA extern module *ap_top_module;
 
 /**
  * Array of all statically linked modules
- * @defvar module *ap_prelinked_modules[]
+ * @var module *ap_prelinked_modules[]
  */
 AP_DECLARE_DATA extern module *ap_prelinked_modules[];
 /**
  * Array of all statically linked modulenames (symbols)
- * @defvar ap_module_symbol_t ap_prelinked_modulenames[]
+ * @var ap_module_symbol_t ap_prelinked_module_symbols[]
  */
 AP_DECLARE_DATA extern ap_module_symbol_t ap_prelinked_module_symbols[];
 /**
  * Array of all preloaded modules
- * @defvar module *ap_preloaded_modules[]
+ * @var module *ap_preloaded_modules[]
  */
 AP_DECLARE_DATA extern module *ap_preloaded_modules[];
 /**
  * Array of all loaded modules
- * @defvar module **ap_loaded_modules
+ * @var module **ap_loaded_modules
  */
 AP_DECLARE_DATA extern module **ap_loaded_modules;
 
diff --git a/include/util_cfgtree.h b/include/util_cfgtree.h
index 911130b913..4da4c7dd1d 100644
--- a/include/util_cfgtree.h
+++ b/include/util_cfgtree.h
@@ -68,7 +68,6 @@ struct ap_directive_t {
 
 /**
  * The root of the configuration tree
- * @var ap_directive_t *conftree
  */
 AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
 
diff --git a/modules/core/mod_watchdog.h b/modules/core/mod_watchdog.h
index 9de553432d..c02ee28464 100644
--- a/modules/core/mod_watchdog.h
+++ b/modules/core/mod_watchdog.h
@@ -23,7 +23,7 @@
  *
  * @defgroup MOD_WATCHDOG watchdog
  * @ingroup  APACHE_MODS
- * @{
+ * \@{
  */
 
 #include "httpd.h"
@@ -162,10 +162,10 @@ APR_DECLARE_OPTIONAL_FN(apr_status_t, ap_watchdog_set_callback_interval,
 
 /**
  * Watchdog require hook.
+ * @param s The server record 
  * @param name Watchdog name.
  * @param parent Non-zero to indicate the parent process watchdog mode.
  * @param singleton Non-zero to indicate the singleton watchdog mode.
- * @param pool The pool used to create the watchdog.
  * @return OK to enable notifications from this watchdog, DECLINED otherwise.
  * @remark This is called in post config phase for all watchdog instances
  *         that have no callbacks registered. Modules using this hook
@@ -180,6 +180,7 @@ APR_DECLARE_EXTERNAL_HOOK(ap, AP_WD, int, watchdog_need, (server_rec *s,
 /**
  * Watchdog initialize hook.
  * It is called after the watchdog thread is initialized.
+ * @param s The server record 
  * @param name Watchdog name.
  * @param pool The pool used to create the watchdog.
  */
@@ -191,6 +192,7 @@ APR_DECLARE_EXTERNAL_HOOK(ap, AP_WD, int, watchdog_init, (
 /**
  * Watchdog terminate hook.
  * It is called when the watchdog thread is terminated.
+ * @param s The server record 
  * @param name Watchdog name.
  * @param pool The pool used to create the watchdog.
  */
@@ -202,6 +204,7 @@ APR_DECLARE_EXTERNAL_HOOK(ap, AP_WD, int, watchdog_exit, (
 /**
  * Fixed interval watchdog hook.
  * It is called regularly on @p AP_WD_TM_INTERVAL interval.
+ * @param s The server record 
  * @param name Watchdog name.
  * @param pool Temporary pool destroyed after the call.
  */
@@ -215,4 +218,4 @@ APR_DECLARE_EXTERNAL_HOOK(ap, AP_WD, int, watchdog_step, (
 #endif
 
 #endif /* MOD_WATCHDOG_H */
-/** @} */
+/** \@} */
diff --git a/modules/generators/mod_cgi.h b/modules/generators/mod_cgi.h
index f34a31b6b8..c5d989177b 100644
--- a/modules/generators/mod_cgi.h
+++ b/modules/generators/mod_cgi.h
@@ -51,8 +51,6 @@ typedef struct {
  * @param argv Pointer to the arguments to pass (may be overridden)
  * @param r The current request
  * @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 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