From: Rainer Jung <rjung@apache.org>
Date: Tue, 31 Jan 2012 11:58:02 +0000 (+0000)
Subject: include/: Various doxy markup tweaks.
X-Git-Tag: 2.4.1~87
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0f0c027ee807c77df61075da998c745daedd770a;p=apache

include/: Various doxy markup tweaks.

Backport of r1211364 from trunk.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1238409 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/include/ap_expr.h b/include/ap_expr.h
index 6d6506035a..f0463bbf86 100644
--- a/include/ap_expr.h
+++ b/include/ap_expr.h
@@ -18,7 +18,7 @@
  * @file ap_expr.h
  * @brief Expression parser
  *
- * @defgroup AP_EXPR ap_expr
+ * @defgroup AP_EXPR Expression parser
  * @ingroup  APACHE_CORE
  * @{
  */
diff --git a/include/ap_socache.h b/include/ap_socache.h
index c258dc5675..7e2c659d67 100644
--- a/include/ap_socache.h
+++ b/include/ap_socache.h
@@ -87,10 +87,10 @@ typedef apr_status_t (ap_socache_iterator_t)(ap_socache_instance_t *instance,
  * with the ap_provider.h interface using the AP_SOCACHE_PROVIDER_*
  * constants. */
 typedef struct ap_socache_provider_t {
-    /** Canonical provider name: */
+    /** Canonical provider name. */
     const char *name;
 
-    /** Bitmask of AP_SOCACHE_FLAG_* flags: */
+    /** Bitmask of AP_SOCACHE_FLAG_* flags. */
     unsigned int flags;
 
     /**
@@ -99,7 +99,7 @@ typedef struct ap_socache_provider_t {
      * passed as the first argument to subsequent invocations.
      *
      * @param instance Output parameter to which instance object is written.
-     * @param arg Used-specified configuration string.  May be NULL to
+     * @param arg User-specified configuration string.  May be NULL to
      *        force use of defaults.
      * @param tmp Pool to be used for any temporary allocations
      * @param p Pool to be use for any allocations lasting as long as
@@ -109,13 +109,14 @@ typedef struct ap_socache_provider_t {
     const char *(*create)(ap_socache_instance_t **instance, const char *arg,
                           apr_pool_t *tmp, apr_pool_t *p);
 
-    /* Initialize the cache.  The cname must be of maximum length 16
+    /**
+     * Initialize the cache.  The cname must be of maximum length 16
      * characters, and uniquely identifies the consumer of the cache
      * within the server; using the module name is recommended, e.g.
      * "mod_ssl-sess".  This string may be used within a filesystem
      * path so use of only alphanumeric [a-z0-9_-] characters is
      * recommended.  If hints is non-NULL, it gives a set of hints for
-     * the provider.  Return APR error code.
+     * the provider.  Returns APR error code.
      *
      * @param instance The cache instance
      * @param cname A unique string identifying the consumer of this API
@@ -155,6 +156,7 @@ typedef struct ap_socache_provider_t {
 
     /**
      * Retrieve a cached object.
+     * 
      * @param instance The cache instance
      * @param s Associated server structure (for logging purposes)
      * @param id Unique ID for the object; binary blob
@@ -171,7 +173,9 @@ typedef struct ap_socache_provider_t {
                              unsigned char *data, unsigned int *datalen,
                              apr_pool_t *pool);
 
-    /* Remove an object from the cache
+    /**
+     * Remove an object from the cache
+     *
      * @param instance The cache instance
      * @param s Associated server structure (for logging purposes)
      * @param id Unique ID for the object; binary blob
@@ -182,7 +186,8 @@ typedef struct ap_socache_provider_t {
                            const unsigned char *id, unsigned int idlen,
                            apr_pool_t *pool);
 
-    /** Dump the status of a cache instance for mod_status.  Will use
+    /** 
+     * Dump the status of a cache instance for mod_status.  Will use
      * the ap_r* interfaces to produce appropriate status output.
      * XXX: ap_r* are deprecated, bad dogfood
      *
diff --git a/include/httpd.h b/include/httpd.h
index a55c5117df..dcfc4f175c 100644
--- a/include/httpd.h
+++ b/include/httpd.h
@@ -18,15 +18,15 @@
  * @file httpd.h
  * @brief HTTP Daemon routines
  *
- * @defgroup APACHE Apache
+ * @defgroup APACHE Apache HTTP Server
  *
  * Top level group of which all other groups are a member
  * @{
  *
- * @defgroup APACHE_MODS Apache Modules
- *           Top level group for Apache Modules
+ * @defgroup APACHE_MODS Loadable modules
+ *           Top level group for modules
  * @defgroup APACHE_OS Operating System Specific
- * @defgroup APACHE_CORE Apache Core
+ * @defgroup APACHE_CORE Core routines
  * @{
  * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
  * @{
diff --git a/include/mpm_common.h b/include/mpm_common.h
index e6700264ec..df33d79e41 100644
--- a/include/mpm_common.h
+++ b/include/mpm_common.h
@@ -92,9 +92,11 @@ typedef void ap_reclaim_callback_fn_t(int childnum, pid_t pid,
 /**
  * Make sure all child processes that have been spawned by the parent process
  * have died.  This includes process registered as "other_children".
+ *
  * @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.
+ * @param mpm_callback Callback invoked for each dead child process
  *
  * @note The MPM child processes which are reclaimed are those listed
  * in the scoreboard as well as those currently registered via
@@ -107,6 +109,8 @@ 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".
  *
+ * @param mpm_callback Callback invoked for each dead child process
+
  * @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().