* 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;
/**
* 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
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
/**
* 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
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
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
*
* @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
* @{
/**
* 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
* 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().