From cvs-return-40604-apmail-httpd-cvs-archive=httpd.apache.org@httpd.apache.org Wed Dec 7 10:06:44 2011 Return-Path: X-Original-To: apmail-httpd-cvs-archive@www.apache.org Delivered-To: apmail-httpd-cvs-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 607DE79C2 for ; Wed, 7 Dec 2011 10:06:44 +0000 (UTC) Received: (qmail 26876 invoked by uid 500); 7 Dec 2011 10:06:44 -0000 Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org Received: (qmail 26808 invoked by uid 500); 7 Dec 2011 10:06:44 -0000 Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@httpd.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@httpd.apache.org Received: (qmail 26801 invoked by uid 99); 7 Dec 2011 10:06:44 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Dec 2011 10:06:44 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Dec 2011 10:06:42 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id A20842388860; Wed, 7 Dec 2011 10:06:21 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1211364 - in /httpd/httpd/trunk/include: ap_expr.h ap_socache.h httpd.h mpm_common.h Date: Wed, 07 Dec 2011 10:06:21 -0000 To: cvs@httpd.apache.org From: jorton@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20111207100621.A20842388860@eris.apache.org> Author: jorton Date: Wed Dec 7 10:06:21 2011 New Revision: 1211364 URL: http://svn.apache.org/viewvc?rev=1211364&view=rev Log: * include/: Various doxy markup tweaks. Modified: httpd/httpd/trunk/include/ap_expr.h httpd/httpd/trunk/include/ap_socache.h httpd/httpd/trunk/include/httpd.h httpd/httpd/trunk/include/mpm_common.h Modified: httpd/httpd/trunk/include/ap_expr.h URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/ap_expr.h?rev=1211364&r1=1211363&r2=1211364&view=diff ============================================================================== --- httpd/httpd/trunk/include/ap_expr.h (original) +++ httpd/httpd/trunk/include/ap_expr.h Wed Dec 7 10:06:21 2011 @@ -18,7 +18,7 @@ * @file ap_expr.h * @brief Expression parser * - * @defgroup AP_EXPR ap_expr + * @defgroup AP_EXPR Expression parser * @ingroup APACHE_CORE * @{ */ Modified: httpd/httpd/trunk/include/ap_socache.h URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/ap_socache.h?rev=1211364&r1=1211363&r2=1211364&view=diff ============================================================================== --- httpd/httpd/trunk/include/ap_socache.h (original) +++ httpd/httpd/trunk/include/ap_socache.h Wed Dec 7 10:06:21 2011 @@ -87,10 +87,10 @@ typedef apr_status_t (ap_socache_iterato * 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 * Modified: httpd/httpd/trunk/include/httpd.h URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/httpd.h?rev=1211364&r1=1211363&r2=1211364&view=diff ============================================================================== --- httpd/httpd/trunk/include/httpd.h (original) +++ httpd/httpd/trunk/include/httpd.h Wed Dec 7 10:06:21 2011 @@ -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 * @{ Modified: httpd/httpd/trunk/include/mpm_common.h URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/mpm_common.h?rev=1211364&r1=1211363&r2=1211364&view=diff ============================================================================== --- httpd/httpd/trunk/include/mpm_common.h (original) +++ httpd/httpd/trunk/include/mpm_common.h Wed Dec 7 10:06:21 2011 @@ -92,9 +92,11 @@ typedef void ap_reclaim_callback_fn_t(in /** * 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 term * 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().