Return-Path: Delivered-To: apmail-httpd-cvs-archive@www.apache.org Received: (qmail 5515 invoked from network); 29 Sep 2005 20:47:02 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 29 Sep 2005 20:47:02 -0000 Received: (qmail 93661 invoked by uid 500); 29 Sep 2005 20:46:59 -0000 Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org Received: (qmail 93424 invoked by uid 500); 29 Sep 2005 20:46:58 -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 93333 invoked by uid 99); 29 Sep 2005 20:46:56 -0000 X-ASF-Spam-Status: No, hits=-9.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Thu, 29 Sep 2005 13:46:54 -0700 Received: (qmail 5186 invoked by uid 65534); 29 Sep 2005 20:46:34 -0000 Message-ID: <20050929204634.5185.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r292540 [1/3] - in /httpd/httpd: branches/2.2.x/ branches/2.2.x/include/ branches/2.2.x/modules/aaa/ branches/2.2.x/modules/arch/win32/ branches/2.2.x/modules/cache/ branches/2.2.x/modules/dav/fs/ branches/2.2.x/modules/dav/lock/ branches/2... Date: Thu, 29 Sep 2005 20:45:57 -0000 To: cvs@httpd.apache.org From: colm@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: colm Date: Thu Sep 29 13:44:53 2005 New Revision: 292540 URL: http://svn.apache.org/viewcvs?rev=292540&view=rev Log: Backport the Doxygen changes to the 2.2.x branch. No functional changes, however backporting these doxygen fixes makes it significantly easier to diff trunk and the 2.2.x branch, to sort out what's what. And we might as well release with nicer doxygen markup. Submitted by: Neale Ranns Reviewed by: Ian Holsman Modified: httpd/httpd/branches/2.2.x/CHANGES httpd/httpd/branches/2.2.x/include/ap_compat.h httpd/httpd/branches/2.2.x/include/ap_config.h httpd/httpd/branches/2.2.x/include/ap_config_layout.h.in httpd/httpd/branches/2.2.x/include/ap_listen.h httpd/httpd/branches/2.2.x/include/ap_mmn.h httpd/httpd/branches/2.2.x/include/ap_mpm.h httpd/httpd/branches/2.2.x/include/ap_provider.h httpd/httpd/branches/2.2.x/include/ap_regex.h httpd/httpd/branches/2.2.x/include/ap_regkey.h httpd/httpd/branches/2.2.x/include/ap_release.h httpd/httpd/branches/2.2.x/include/http_config.h httpd/httpd/branches/2.2.x/include/http_connection.h httpd/httpd/branches/2.2.x/include/http_core.h httpd/httpd/branches/2.2.x/include/http_log.h httpd/httpd/branches/2.2.x/include/http_main.h httpd/httpd/branches/2.2.x/include/http_protocol.h httpd/httpd/branches/2.2.x/include/http_request.h httpd/httpd/branches/2.2.x/include/http_vhost.h httpd/httpd/branches/2.2.x/include/httpd.h httpd/httpd/branches/2.2.x/include/mpm_common.h httpd/httpd/branches/2.2.x/include/scoreboard.h httpd/httpd/branches/2.2.x/include/util_cfgtree.h httpd/httpd/branches/2.2.x/include/util_charset.h httpd/httpd/branches/2.2.x/include/util_ebcdic.h httpd/httpd/branches/2.2.x/include/util_filter.h httpd/httpd/branches/2.2.x/include/util_ldap.h httpd/httpd/branches/2.2.x/include/util_md5.h httpd/httpd/branches/2.2.x/include/util_script.h httpd/httpd/branches/2.2.x/include/util_time.h httpd/httpd/branches/2.2.x/include/util_xml.h httpd/httpd/branches/2.2.x/modules/aaa/mod_auth.h httpd/httpd/branches/2.2.x/modules/arch/win32/mod_isapi.h httpd/httpd/branches/2.2.x/modules/cache/cache_cache.h httpd/httpd/branches/2.2.x/modules/cache/cache_hash.h httpd/httpd/branches/2.2.x/modules/cache/cache_pqueue.h httpd/httpd/branches/2.2.x/modules/cache/mod_cache.h httpd/httpd/branches/2.2.x/modules/dav/fs/repos.h httpd/httpd/branches/2.2.x/modules/dav/lock/locks.h httpd/httpd/branches/2.2.x/modules/dav/main/mod_dav.h httpd/httpd/branches/2.2.x/modules/experimental/mod_dbd.h httpd/httpd/branches/2.2.x/modules/experimental/mod_filter.c httpd/httpd/branches/2.2.x/modules/filters/mod_include.h httpd/httpd/branches/2.2.x/modules/generators/mod_cgi.h httpd/httpd/branches/2.2.x/modules/generators/mod_status.h httpd/httpd/branches/2.2.x/modules/generators/mod_suexec.h httpd/httpd/branches/2.2.x/modules/http/mod_core.h httpd/httpd/branches/2.2.x/modules/ldap/util_ldap_cache.h httpd/httpd/branches/2.2.x/modules/loggers/mod_log_config.h httpd/httpd/branches/2.2.x/modules/mappers/mod_rewrite.h httpd/httpd/branches/2.2.x/modules/mappers/mod_so.h httpd/httpd/branches/2.2.x/modules/ssl/mod_ssl.h httpd/httpd/branches/2.2.x/modules/ssl/ssl_expr.h httpd/httpd/branches/2.2.x/modules/ssl/ssl_private.h httpd/httpd/branches/2.2.x/modules/ssl/ssl_toolkit_compat.h httpd/httpd/branches/2.2.x/modules/ssl/ssl_util_ssl.h httpd/httpd/branches/2.2.x/os/beos/beosd.h httpd/httpd/branches/2.2.x/os/beos/os.h httpd/httpd/branches/2.2.x/os/bs2000/ebcdic.h httpd/httpd/branches/2.2.x/os/bs2000/os.h httpd/httpd/branches/2.2.x/os/netware/os.h httpd/httpd/branches/2.2.x/os/netware/pre_nw.h httpd/httpd/branches/2.2.x/os/os2/os.h httpd/httpd/branches/2.2.x/os/tpf/ebcdic.h httpd/httpd/branches/2.2.x/os/tpf/os.h httpd/httpd/branches/2.2.x/os/unix/os.h httpd/httpd/branches/2.2.x/os/unix/unixd.h httpd/httpd/branches/2.2.x/os/win32/os.h httpd/httpd/branches/2.2.x/server/core_filters.c httpd/httpd/branches/2.2.x/server/main.c httpd/httpd/branches/2.2.x/server/mpm/beos/beos.h httpd/httpd/branches/2.2.x/server/mpm/beos/mpm.h httpd/httpd/branches/2.2.x/server/mpm/beos/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/experimental/event/fdqueue.h httpd/httpd/branches/2.2.x/server/mpm/experimental/event/mpm.h httpd/httpd/branches/2.2.x/server/mpm/experimental/event/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/experimental/event/pod.h httpd/httpd/branches/2.2.x/server/mpm/experimental/leader/mpm.h httpd/httpd/branches/2.2.x/server/mpm/experimental/leader/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/experimental/perchild/mpm.h httpd/httpd/branches/2.2.x/server/mpm/experimental/perchild/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/experimental/threadpool/mpm.h httpd/httpd/branches/2.2.x/server/mpm/experimental/threadpool/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/experimental/threadpool/pod.h httpd/httpd/branches/2.2.x/server/mpm/mpmt_os2/mpm.h httpd/httpd/branches/2.2.x/server/mpm/mpmt_os2/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/netware/mpm.h httpd/httpd/branches/2.2.x/server/mpm/netware/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/prefork/mpm.h httpd/httpd/branches/2.2.x/server/mpm/prefork/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/winnt/Win9xConHook.h httpd/httpd/branches/2.2.x/server/mpm/winnt/mpm.h httpd/httpd/branches/2.2.x/server/mpm/winnt/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/winnt/mpm_winnt.h httpd/httpd/branches/2.2.x/server/mpm/worker/fdqueue.h httpd/httpd/branches/2.2.x/server/mpm/worker/mpm.h httpd/httpd/branches/2.2.x/server/mpm/worker/mpm_default.h httpd/httpd/branches/2.2.x/server/mpm/worker/pod.h httpd/httpd/branches/2.2.x/server/request.c httpd/httpd/branches/2.2.x/server/vhost.c httpd/httpd/branches/2.2.x/support/suexec.h httpd/httpd/branches/2.2.x/support/win32/ApacheMonitor.h httpd/httpd/trunk/CHANGES Modified: httpd/httpd/branches/2.2.x/CHANGES URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/CHANGES?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/CHANGES [utf-8] (original) +++ httpd/httpd/branches/2.2.x/CHANGES [utf-8] Thu Sep 29 13:44:53 2005 @@ -1,6 +1,8 @@ -*- coding: utf-8 -*- Changes with Apache 2.1.9 + *) Doxygen fixup [Neale Ranns neale ranns.org, Ian Holsman] + *) mod_cache/mod_dir: Correct a subrequest lookup bug which was preventing mod_dir from serving indexes correctly with mod_cache enabled. [Colm MacCarthaigh] Modified: httpd/httpd/branches/2.2.x/include/ap_compat.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_compat.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_compat.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_compat.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,11 @@ * limitations under the License. */ +/** + * @file ap_compat.h + * @brief Redefine Apache 1.3 symbols + */ + #ifndef AP_COMPAT_H #define AP_COMPAT_H Modified: httpd/httpd/branches/2.2.x/include/ap_config.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_config.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_config.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_config.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,11 @@ * limitations under the License. */ +/** + * @file ap_config.h + * @brief Symbol export macros and hook functions + */ + #ifndef AP_CONFIG_H #define AP_CONFIG_H @@ -21,13 +26,11 @@ #include "apr_hooks.h" #include "apr_optional_hooks.h" -/** - * @file ap_config.h - * @brief Symbol export macros and hook functions - */ - /* Although this file doesn't declare any hooks, declare the hook group here */ -/** @defgroup hooks Apache Hooks */ +/** + * @defgroup hooks Apache Hooks + * @ingroup APACHE_CORE + */ #ifdef DOXYGEN /* define these just so doxygen documents them */ Modified: httpd/httpd/branches/2.2.x/include/ap_config_layout.h.in URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_config_layout.h.in?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_config_layout.h.in (original) +++ httpd/httpd/branches/2.2.x/include/ap_config_layout.h.in Thu Sep 29 13:44:53 2005 @@ -14,6 +14,11 @@ * limitations under the License. */ +/** + * @file ap_config_layout.h + * @brief Apache Config Layout + */ + #ifndef AP_CONFIG_LAYOUT_H #define AP_CONFIG_LAYOUT_H Modified: httpd/httpd/branches/2.2.x/include/ap_listen.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_listen.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_listen.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_listen.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file ap_listen.h + * @brief Apache Listeners Library + * + * @defgroup APACHE_CORE_LISTEN Apache Listeners Library + * @ingroup APACHE_CORE + * @{ + */ + #ifndef AP_LISTEN_H #define AP_LISTEN_H @@ -21,15 +30,13 @@ #include "httpd.h" #include "http_config.h" -/** - * @package Apache Listeners Library - */ - typedef struct ap_listen_rec ap_listen_rec; typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans); /** - * Apache's listeners record. These are used in the Multi-Processing Modules + * @brief Apache's listeners record. + * + * These are used in the Multi-Processing Modules * to setup all of the sockets for the MPM to listen to and accept on. */ struct ap_listen_rec { @@ -109,3 +116,4 @@ RSRC_CONF, "Receive buffer size in bytes") #endif +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/ap_mmn.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_mmn.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_mmn.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_mmn.h Thu Sep 29 13:44:53 2005 @@ -14,13 +14,18 @@ * limitations under the License. */ -#ifndef APACHE_AP_MMN_H -#define APACHE_AP_MMN_H - /** - * @package Module Magic Number + * @file ap_mpm.h + * @brief Module Magic Number + * + * @defgroup APACHE_CORE_MMN Module Magic Number + * @ingroup APACHE_CORE + * @{ */ +#ifndef APACHE_AP_MMN_H +#define APACHE_AP_MMN_H + /* * MODULE_MAGIC_NUMBER_MAJOR * Major API changes that could cause compatibility problems for older modules @@ -137,3 +142,4 @@ #define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using #endif /* !APACHE_AP_MMN_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/ap_mpm.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_mpm.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_mpm.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_mpm.h Thu Sep 29 13:44:53 2005 @@ -14,15 +14,20 @@ * limitations under the License. */ +/** + * @file ap_mmn.h + * @brief Apache Multi-Processing Module library + * + * @defgroup APACHE_CORE_MPM Multi-Processing Module library + * @ingroup APACHE_CORE + * @{ + */ + #ifndef AP_MPM_H #define AP_MPM_H #include "apr_thread_proc.h" -/** - * @package Multi-Processing Module library - */ - /* The MPM, "multi-processing model" provides an abstraction of the interface with the OS for distributing incoming connections to @@ -175,3 +180,4 @@ #endif /*AP_ENABLE_EXCEPTION_HOOK*/ #endif +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/ap_provider.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_provider.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_provider.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_provider.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file ap_provider.h + * @brief Apache Provider API + * + * @defgroup APACHE_CORE_PROVIDER Provider API + * @ingroup APACHE_CORE + * @{ + */ + #ifndef AP_PROVIDER_H #define AP_PROVIDER_H @@ -25,10 +34,6 @@ /** - * @package Provider API - */ - -/** * This function is used to register a provider with the global * provider pool. * @param pool The pool to create any storage from @@ -70,3 +75,4 @@ const char *provider_version); #endif +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/ap_regex.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_regex.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_regex.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_regex.h Thu Sep 29 13:44:53 2005 @@ -47,6 +47,11 @@ ----------------------------------------------------------------------------- */ +/** + * @file ap_regex.h + * @brief Apache Regex defines + */ + #ifndef AP_REGEX_H #define AP_REGEX_H Modified: httpd/httpd/branches/2.2.x/include/ap_regkey.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_regkey.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_regkey.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_regkey.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,11 @@ * limitations under the License. */ +/** + * @file ap_regkey.h + * @brief APR-style Win32 Registry Manipulation + */ + #ifndef AP_REGKEY_H #define AP_REGKEY_H @@ -32,11 +37,6 @@ /* Used to recover AP_REGKEY_* constants */ AP_DECLARE(const ap_regkey_t *) ap_regkey_const(int i); - -/** - * @file ap_regkey.h - * @brief APR-style Win32 Registry Manipulation - */ /** * Win32 Only: Constants for ap_regkey_open() Modified: httpd/httpd/branches/2.2.x/include/ap_release.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/ap_release.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/ap_release.h (original) +++ httpd/httpd/branches/2.2.x/include/ap_release.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,11 @@ * limitations under the License. */ +/** + * @file ap_release.h + * @brief Version Release defines + */ + #ifndef AP_RELEASE_H #define AP_RELEASE_H Modified: httpd/httpd/branches/2.2.x/include/http_config.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_config.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_config.h (original) +++ httpd/httpd/branches/2.2.x/include/http_config.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_config.h + * @brief Apache Configuration + * + * @defgroup APACHE_CORE_CONFIG Configuration + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_CONFIG_H #define APACHE_HTTP_CONFIG_H @@ -24,11 +33,6 @@ extern "C" { #endif -/** - * @file http_config.h - * @brief Apache Configuration - */ - /* * The central data structures around here... */ @@ -694,7 +698,7 @@ ap_conf_vector_t *section_vector); /** - * @defgroup ap_check_cmd_context ap_check_cmd_context + * @defgroup ap_check_cmd_context Check command context * @{ */ /** @@ -721,7 +725,7 @@ #ifdef CORE_PRIVATE /** - * This structure is used to assign symbol names to module pointers + * @brief This structure is used to assign symbol names to module pointers */ typedef struct { const char *name; @@ -1049,3 +1053,4 @@ #endif #endif /* !APACHE_HTTP_CONFIG_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_connection.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_connection.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_connection.h (original) +++ httpd/httpd/branches/2.2.x/include/http_connection.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_connection.h + * @brief Apache connection library + * + * @defgroup APACHE_CORE_CONNECTION Connection Library + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_CONNECTION_H #define APACHE_HTTP_CONNECTION_H @@ -24,10 +33,11 @@ #ifdef __cplusplus extern "C" { #endif - /** - * @package Apache connection library + * @file http_connection.h + * @brief Apache connection library */ + #ifdef CORE_PRIVATE /** * This is the protocol module driver. This calls all of the @@ -36,10 +46,13 @@ * @param csd The mechanism on which this connection is to be read. * Most times this will be a socket, but it is up to the module * that accepts the request to determine the exact type. - * @deffunc void ap_process_connection(conn_rec *c, void *csd) */ AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c, void *csd); +/** + * Flushes all remain data in the client send buffer + * @param c The connection to flush + */ AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c); /** @@ -70,10 +83,12 @@ * if it encounters a fatal error condition. * * @param p The pool from which to allocate the connection record + * @param server The server record to create the connection too. * @param csd The socket that has been accepted * @param conn_id A unique identifier for this connection. The ID only * needs to be unique at that time, not forever. * @param sbh A handle to scoreboard information for this connection. + * @param alloc The bucket allocator to use for all bucket/brigade creations * @return An allocated connection record or NULL. */ AP_DECLARE_HOOK(conn_rec *, create_connection, @@ -89,7 +104,6 @@ * Most times this will be a socket, but it is up to the module * that accepts the request to determine the exact type. * @return OK or DECLINED - * @deffunc int ap_run_pre_connection(conn_rec *c, void *csd) */ AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c, void *csd)) @@ -100,12 +114,10 @@ * to handle the request is the last module run. * @param c The connection on which the request has been received. * @return OK or DECLINED - * @deffunc int ap_run_process_connection(conn_rec *c) */ AP_DECLARE_HOOK(int,process_connection,(conn_rec *c)) -/* End Of Connection (EOC) bucket */ - +/** End Of Connection (EOC) bucket */ AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eoc; /** @@ -119,7 +131,6 @@ * Make the bucket passed in an End Of Connection (EOC) bucket * @param b The bucket to make into an EOC bucket * @return The new bucket, or NULL if allocation failed - * @deffunc apr_bucket *ap_bucket_eoc_make(apr_bucket *b) */ AP_DECLARE(apr_bucket *) ap_bucket_eoc_make(apr_bucket *b); @@ -128,7 +139,6 @@ * that the connection will be closed. * @param list The freelist from which this bucket should be allocated * @return The new bucket, or NULL if allocation failed - * @deffunc apr_bucket *ap_bucket_eoc_create(apr_bucket_alloc_t *list) */ AP_DECLARE(apr_bucket *) ap_bucket_eoc_create(apr_bucket_alloc_t *list); @@ -137,3 +147,4 @@ #endif #endif /* !APACHE_HTTP_REQUEST_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_core.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_core.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_core.h (original) +++ httpd/httpd/branches/2.2.x/include/http_core.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_core.h + * @brief CORE HTTP Daemon + * + * @defgroup APACHE_CORE_HTTPD Core HTTP Daemon + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_CORE_H #define APACHE_HTTP_CORE_H @@ -32,10 +41,6 @@ extern "C" { #endif -/** - * @package CORE HTTP Daemon - */ - /* **************************************************************** * * The most basic server code is encapsulated in a single module @@ -48,61 +53,88 @@ * of one of them (allow_options). */ +/** + * @defgroup APACHE_CORE_HTTPD_ACESSORS Acessors + * + * @brief File/Directory Accessor directives + * + * @{ + */ + +/** No directives */ #define OPT_NONE 0 +/** Indexes directive */ #define OPT_INDEXES 1 +/** Includes directive */ #define OPT_INCLUDES 2 +/** FollowSymLinks directive */ #define OPT_SYM_LINKS 4 +/** ExecCGI directive */ #define OPT_EXECCGI 8 +/** directive unset */ #define OPT_UNSET 16 +/** IncludesNOEXEC directive */ #define OPT_INCNOEXEC 32 +/** SymLinksIfOwnerMatch directive */ #define OPT_SYM_OWNER 64 +/** MultiViews directive */ #define OPT_MULTI 128 +/** All directives */ #define OPT_ALL (OPT_INDEXES|OPT_INCLUDES|OPT_SYM_LINKS|OPT_EXECCGI) +/** @} */ -/* options for get_remote_host() */ -/* REMOTE_HOST returns the hostname, or NULL if the hostname +/** + * @defgroup get_remote_host Remote Host Resolution + * @ingroup APACHE_CORE_HTTPD + * @{ + */ +/** REMOTE_HOST returns the hostname, or NULL if the hostname * lookup fails. It will force a DNS lookup according to the * HostnameLookups setting. */ #define REMOTE_HOST (0) -/* REMOTE_NAME returns the hostname, or the dotted quad if the +/** REMOTE_NAME returns the hostname, or the dotted quad if the * hostname lookup fails. It will force a DNS lookup according * to the HostnameLookups setting. */ #define REMOTE_NAME (1) -/* REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is +/** REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is * never forced. */ #define REMOTE_NOLOOKUP (2) -/* REMOTE_DOUBLE_REV will always force a DNS lookup, and also force +/** REMOTE_DOUBLE_REV will always force a DNS lookup, and also force * a double reverse lookup, regardless of the HostnameLookups * setting. The result is the (double reverse checked) hostname, * or NULL if any of the lookups fail. */ #define REMOTE_DOUBLE_REV (3) +/** @} // get_remote_host */ + +/** all of the requirements must be met */ #define SATISFY_ALL 0 +/** any of the requirements must be met */ #define SATISFY_ANY 1 +/** There are no applicable satisfy lines */ #define SATISFY_NOSPEC 2 -/* Make sure we don't write less than 8000 bytes at any one time. +/** Make sure we don't write less than 8000 bytes at any one time. */ #define AP_MIN_BYTES_TO_WRITE 8000 -/* default maximum of internal redirects */ +/** default maximum of internal redirects */ # define AP_DEFAULT_MAX_INTERNAL_REDIRECTS 10 -/* default maximum subrequest nesting level */ +/** default maximum subrequest nesting level */ # define AP_DEFAULT_MAX_SUBREQ_DEPTH 10 /** * Retrieve the value of Options for this request * @param r The current request * @return the Options bitmask - * @deffunc int ap_allow_options(request_rec *r) */ AP_DECLARE(int) ap_allow_options(request_rec *r); @@ -110,7 +142,6 @@ * Retrieve the value of the AllowOverride for this request * @param r The current request * @return the overrides bitmask - * @deffunc int ap_allow_overrides(request_rec *r) */ AP_DECLARE(int) ap_allow_overrides(request_rec *r); @@ -118,7 +149,6 @@ * Retrieve the value of the DefaultType directive, or text/plain if not set * @param r The current request * @return The default type - * @deffunc const char *ap_default_type(request_rec *r) */ AP_DECLARE(const char *) ap_default_type(request_rec *r); @@ -128,12 +158,12 @@ * @warning Don't use this! If your request went through a Userdir, or * something like that, it'll screw you. But it's back-compatible... * @return The document root - * @deffunc const char *ap_document_root(request_rec *r) */ AP_DECLARE(const char *) ap_document_root(request_rec *r); /** * Lookup the remote client's DNS name or IP address + * @ingroup get_remote_host * @param conn The current connection * @param dir_config The directory config vector from the request * @param type The type of lookup to perform. One of: @@ -154,7 +184,6 @@ * @param str_is_ip unless NULL is passed, this will be set to non-zero on output when an IP address * string is returned * @return The remote hostname - * @deffunc const char *ap_get_remote_host(conn_rec *conn, void *dir_config, int type, int *str_is_ip) */ AP_DECLARE(const char *) ap_get_remote_host(conn_rec *conn, void *dir_config, int type, int *str_is_ip); @@ -163,7 +192,6 @@ * determined * @param r The current request * @return The user logged in to the client machine - * @deffunc const char *ap_get_remote_logname(request_rec *r) */ AP_DECLARE(const char *) ap_get_remote_logname(request_rec *r); @@ -176,7 +204,6 @@ * @param uri The path to the requested file * @param r The current request * @return A fully qualified URL - * @deffunc char *ap_construct_url(apr_pool_t *p, const char *uri, request_rec *r) */ AP_DECLARE(char *) ap_construct_url(apr_pool_t *p, const char *uri, request_rec *r); @@ -184,15 +211,13 @@ * Get the current server name from the request * @param r The current request * @return the server name - * @deffunc const char *ap_get_server_name(request_rec *r) */ AP_DECLARE(const char *) ap_get_server_name(request_rec *r); /** * Get the current server port - * @param The current request + * @param r The current request * @return The server's port - * @deffunc apr_port_t ap_get_server_port(const request_rec *r) */ AP_DECLARE(apr_port_t) ap_get_server_port(const request_rec *r); @@ -200,7 +225,6 @@ * Return the limit on bytes in request msg body * @param r The current request * @return the maximum number of bytes in the request msg body - * @deffunc apr_off_t ap_get_limit_req_body(const request_rec *r) */ AP_DECLARE(apr_off_t) ap_get_limit_req_body(const request_rec *r); @@ -208,7 +232,6 @@ * Return the limit on bytes in XML request msg body * @param r The current request * @return the maximum number of bytes in XML request msg body - * @deffunc size_t ap_get_limit_xml_body(const request_rec *r) */ AP_DECLARE(size_t) ap_get_limit_xml_body(const request_rec *r); @@ -225,7 +248,6 @@ * Check if the current request is beyond the configured max. number of redirects or subrequests * @param r The current request * @return true (is exceeded) or false - * @deffunc int ap_is_recursion_limit_exceeded(const request_rec *r) */ AP_DECLARE(int) ap_is_recursion_limit_exceeded(const request_rec *r); @@ -233,7 +255,6 @@ * Check for a definition from the server command line * @param name The define to check for * @return 1 if defined, 0 otherwise - * @deffunc int ap_exists_config_define(const char *name) */ AP_DECLARE(int) ap_exists_config_define(const char *name); /* FIXME! See STATUS about how */ @@ -245,9 +266,13 @@ * to maintain common state for all of them in the core, and make it * available to the other modules through interfaces. */ + +/** @see require_line */ typedef struct require_line require_line; -/** A structure to keep track of authorization requirements */ +/** + * @brief A structure to keep track of authorization requirements +*/ struct require_line { /** Where the require line is in the config file. */ apr_int64_t method_mask; @@ -259,7 +284,6 @@ * Return the type of authorization required for this request * @param r The current request * @return The authorization required - * @deffunc const char *ap_auth_type(request_rec *r) */ AP_DECLARE(const char *) ap_auth_type(request_rec *r); @@ -267,7 +291,6 @@ * Return the current Authorization realm * @param r The current request * @return The current authorization realm - * @deffunc const char *ap_auth_name(request_rec *r) */ AP_DECLARE(const char *) ap_auth_name(request_rec *r); @@ -280,7 +303,6 @@ * SATISFY_ALL -- all of the requirements must be met. * SATISFY_NOSPEC -- There are no applicable satisfy lines * - * @deffunc int ap_satisfies(request_rec *r) */ AP_DECLARE(int) ap_satisfies(request_rec *r); @@ -288,35 +310,34 @@ * Retrieve information about all of the requires directives for this request * @param r The current request * @return An array of all requires directives for this request - * @deffunc const apr_array_header_t *ap_requires(request_rec *r) */ AP_DECLARE(const apr_array_header_t *) ap_requires(request_rec *r); #ifdef CORE_PRIVATE -/* +/** * Core is also unlike other modules in being implemented in more than * one file... so, data structures are declared here, even though most of * the code that cares really is in http_core.c. Also, another accessor. */ - AP_DECLARE_DATA extern module core_module; -/* Per-request configuration */ - +/** + * @brief Per-request configuration +*/ typedef struct { - /* bucket brigade used by getline for look-ahead and + /** bucket brigade used by getline for look-ahead and * ap_get_client_block for holding left-over request body */ struct apr_bucket_brigade *bb; - /* an array of per-request working data elements, accessed + /** an array of per-request working data elements, accessed * by ID using ap_get_request_note() * (Use ap_register_request_note() during initialization * to add elements) */ void **notes; - /* There is a script processor installed on the output filter chain, + /** There is a script processor installed on the output filter chain, * so it needs the default_handler to deliver a (script) file into * the chain so it can process it. Normally, default_handler only * serves files on a GET request (assuming the file is actual content), @@ -326,13 +347,13 @@ */ int deliver_script; - /* Custom response strings registered via ap_custom_response(), + /** Custom response strings registered via ap_custom_response(), * or NULL; check per-dir config if nothing found here */ char **response_code_strings; /* from ap_custom_response(), not from * ErrorDocument */ - /* Should addition of charset= be suppressed for this request? + /** Should addition of charset= be suppressed for this request? */ int suppress_charset; } core_request_config; @@ -371,7 +392,6 @@ */ AP_DECLARE(void **) ap_get_request_note(request_rec *r, apr_size_t note_num); -/* Per-directory configuration */ typedef unsigned char allow_options_t; typedef unsigned char overrides_t; @@ -392,6 +412,9 @@ #define ETAG_BACKWARD (ETAG_MTIME | ETAG_INODE | ETAG_SIZE) #define ETAG_ALL (ETAG_MTIME | ETAG_INODE | ETAG_SIZE) +/** + * @brief Server Signature Enumeration + */ typedef enum { srv_sig_unset, srv_sig_off, @@ -399,13 +422,16 @@ srv_sig_withmail } server_signature_e; +/** + * @brief Per-directory configuration + */ typedef struct { - /* path of the directory/regex/etc. see also d_is_fnmatch/absolute below */ + /** path of the directory/regex/etc. see also d_is_fnmatch/absolute below */ char *d; - /* the number of slashes in d */ + /** the number of slashes in d */ unsigned d_components; - /* If (opts & OPT_UNSET) then no absolute assignment to options has + /** If (opts & OPT_UNSET) then no absolute assignment to options has * been made. * invariant: (opts_add & opts_remove) == 0 * Which said another way means that the last relative (options + or -) @@ -659,3 +685,4 @@ #endif #endif /* !APACHE_HTTP_CORE_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_log.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_log.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_log.h (original) +++ httpd/httpd/branches/2.2.x/include/http_log.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_log.h + * @brief Apache Logging library + * + * @defgroup APACHE_CORE_LOG Logging library + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_LOG_H #define APACHE_HTTP_LOG_H @@ -23,10 +32,6 @@ #include "apr_thread_proc.h" -/** - * @package Apache logging library - */ - #ifdef HAVE_SYSLOG #include @@ -110,7 +115,7 @@ * @param plog The pool to allocate the logs from * @param ptemp Pool used for temporary allocations * @param s_main The main server - * @tip ap_open_logs isn't expected to be used by modules, it is + * @note ap_open_logs isn't expected to be used by modules, it is * an internal core function */ int ap_open_logs(apr_pool_t *pconf, apr_pool_t *plog, @@ -123,7 +128,7 @@ * processes. * @param p Not used * @param s Not used - * @tip ap_logs_child_init is not for use by modules; it is an + * @note ap_logs_child_init is not for use by modules; it is an * internal core function */ void ap_logs_child_init(apr_pool_t *p, server_rec *s); @@ -151,8 +156,8 @@ * @param s The server on which we are logging * @param fmt The format string * @param ... The arguments to use to fill out fmt. - * @tip Use APLOG_MARK to fill out file and line - * @tip If a request_rec is available, use that with ap_log_rerror() + * @note Use APLOG_MARK to fill out file and line + * @note If a request_rec is available, use that with ap_log_rerror() * in preference to calling this function. Otherwise, if a conn_rec is * available, use that with ap_log_cerror() in preference to calling * this function. @@ -162,7 +167,6 @@ * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * untrusted data. - * @deffunc void ap_log_error(const char *file, int line, int level, apr_status_t status, const server_rec *s, const char *fmt, ...) */ AP_DECLARE(void) ap_log_error(const char *file, int line, int level, apr_status_t status, const server_rec *s, @@ -180,14 +184,13 @@ * @param p The pool which we are logging for * @param fmt The format string * @param ... The arguments to use to fill out fmt. - * @tip Use APLOG_MARK to fill out file and line + * @note Use APLOG_MARK to fill out file and line * @warning It is VERY IMPORTANT that you not include any raw data from * the network, such as the request-URI or request header fields, within * the format string. Doing so makes the server vulnerable to a * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * untrusted data. - * @deffunc void ap_log_perror(const char *file, int line, int level, apr_status_t status, apr_pool_t *p, const char *fmt, ...) */ AP_DECLARE(void) ap_log_perror(const char *file, int line, int level, apr_status_t status, apr_pool_t *p, @@ -205,14 +208,13 @@ * @param r The request which we are logging for * @param fmt The format string * @param ... The arguments to use to fill out fmt. - * @tip Use APLOG_MARK to fill out file and line + * @note Use APLOG_MARK to fill out file and line * @warning It is VERY IMPORTANT that you not include any raw data from * the network, such as the request-URI or request header fields, within * the format string. Doing so makes the server vulnerable to a * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * untrusted data. - * @deffunc void ap_log_rerror(const char *file, int line, int level, apr_status_t status, const request_rec *r, const char *fmt, ...) */ AP_DECLARE(void) ap_log_rerror(const char *file, int line, int level, apr_status_t status, const request_rec *r, @@ -230,8 +232,8 @@ * @param c The connection which we are logging for * @param fmt The format string * @param ... The arguments to use to fill out fmt. - * @tip Use APLOG_MARK to fill out file and line - * @tip If a request_rec is available, use that with ap_log_rerror() + * @note Use APLOG_MARK to fill out file and line + * @note If a request_rec is available, use that with ap_log_rerror() * in preference to calling this function. * @warning It is VERY IMPORTANT that you not include any raw data from * the network, such as the request-URI or request header fields, within @@ -239,7 +241,6 @@ * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * untrusted data. - * @deffunc void ap_log_cerror(const char *file, int line, int level, apr_status_t status, const conn_rec *c, const char *fmt, ...) */ AP_DECLARE(void) ap_log_cerror(const char *file, int line, int level, apr_status_t status, const conn_rec *c, @@ -249,7 +250,6 @@ /** * Convert stderr to the error log * @param s The current server - * @deffunc void ap_error_log2stderr(server_rec *s) */ AP_DECLARE(void) ap_error_log2stderr(server_rec *s); @@ -268,11 +268,14 @@ */ AP_DECLARE(apr_status_t) ap_read_pid(apr_pool_t *p, const char *filename, pid_t *mypid); +/** @see piped_log */ typedef struct piped_log piped_log; /** - * The piped logging structure. Piped logs are used to move functionality - * out of the main server. For example, log rotation is done with piped logs. + * @brief The piped logging structure. + * + * Piped logs are used to move functionality out of the main server. + * For example, log rotation is done with piped logs. */ struct piped_log { /** The pool to use for the piped log */ @@ -294,14 +297,12 @@ * @param p The pool to allocate out of * @param program The program to run in the logging process * @return The piped log structure - * @deffunc piped_log *ap_open_piped_log(apr_pool_t *p, const char *program) */ AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program); /** * Close the piped log and kill the logging process * @param pl The piped log structure - * @deffunc void ap_close_piped_log(piped_log *pl) */ AP_DECLARE(void) ap_close_piped_log(piped_log *pl); @@ -309,7 +310,6 @@ * A macro to access the read side of the piped log pipe * @param pl The piped log structure * @return The native file descriptor - * @deffunc ap_piped_log_read_fd(pl) */ #define ap_piped_log_read_fd(pl) ((pl)->fds[0]) @@ -317,10 +317,21 @@ * A macro to access the write side of the piped log pipe * @param pl The piped log structure * @return The native file descriptor - * @deffunc ap_piped_log_read_fd(pl) */ #define ap_piped_log_write_fd(pl) ((pl)->fds[1]) +/** + * hook method to log error messages + * @ingroup hooks + * @param file The file in which this function is called + * @param line The line number on which this function is called + * @param level The level of this error message + * @param status The status code from the previous command + * @param s The server which we are logging for + * @param r The request which we are logging for + * @param pool Memory pool to allocate from + * @param errstr message to log + */ AP_DECLARE_HOOK(void, error_log, (const char *file, int line, int level, apr_status_t status, const server_rec *s, const request_rec *r, apr_pool_t *pool, @@ -331,3 +342,4 @@ #endif #endif /* !APACHE_HTTP_LOG_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_main.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_main.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_main.h (original) +++ httpd/httpd/branches/2.2.x/include/http_main.h Thu Sep 29 13:44:53 2005 @@ -14,12 +14,21 @@ * limitations under the License. */ +/** + * @file http_main.h + * @brief Command line options + * + * @defgroup APACHE_CORE_MAIN Command line options + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_MAIN_H #define APACHE_HTTP_MAIN_H #include "apr_optional.h" -/* AP_SERVER_BASEARGS is the command argument list parsed by http_main.c +/** AP_SERVER_BASEARGS is the command argument list parsed by http_main.c * in apr_getopt() format. Use this for default'ing args that the MPM * can safely ignore and pass on from its rewrite_args() handler. */ @@ -29,10 +38,6 @@ extern "C" { #endif -/** - * @package Command line options - */ - /** The name of the Apache executable */ AP_DECLARE_DATA extern const char *ap_server_argv0; /** The global server's ServerRoot */ @@ -49,6 +54,13 @@ * effect the server based on command line options */ AP_DECLARE_DATA extern apr_array_header_t *ap_server_config_defines; +/** + * An optional function to send signal to server on presence of '-k' + * command line argument. + * Called if MPM defines AP_MPM_WANT_SIGNAL_SERVER + * @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 *)); #ifdef __cplusplus @@ -56,3 +68,4 @@ #endif #endif /* !APACHE_HTTP_MAIN_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_protocol.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_protocol.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_protocol.h (original) +++ httpd/httpd/branches/2.2.x/include/http_protocol.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_protocol.h + * @brief HTTP protocol handling + * + * @defgroup APACHE_CORE_PROTO HTTP Protocol Handling + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_PROTOCOL_H #define APACHE_HTTP_PROTOCOL_H @@ -29,17 +38,13 @@ #endif /** - * @package HTTP protocol handling - */ - -/** * This hook allows modules to insert filters for the current error response * @param r the current request * @ingroup hooks */ AP_DECLARE_HOOK(void,insert_error_filter,(request_rec *r)) -/* This is an optimization. We keep a record of the filter_rec that +/** This is an optimization. We keep a record of the filter_rec that * stores the old_write filter, so that we can avoid strcmp's later. */ AP_DECLARE_DATA extern ap_filter_rec_t *ap_old_write_func; @@ -77,7 +82,6 @@ * Called at completion of sending the response. It sends the terminating * protocol information. * @param r The current request - * @deffunc void ap_finalize_request_protocol(request_rec *r) */ AP_DECLARE(void) ap_finalize_request_protocol(request_rec *r); @@ -89,7 +93,6 @@ * to handle some other error. In that case, we print the default * report for the first thing that went wrong, and more briefly report * on the problem with the ErrorDocument. - * @deffunc void ap_send_error_response(request_rec *r, int recursive_error) */ AP_DECLARE(void) ap_send_error_response(request_rec *r, int recursive_error); @@ -104,7 +107,6 @@ * Set the content length for this request * @param r The current request * @param length The new content length - * @deffunc void ap_set_content_length(request_rec *r, apr_off_t length) */ AP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t length); @@ -112,7 +114,6 @@ * Set the keepalive status for this request * @param r The current request * @return 1 if keepalive can be set, 0 otherwise - * @deffunc int ap_set_keepalive(request_rec *r) */ AP_DECLARE(int) ap_set_keepalive(request_rec *r); @@ -122,7 +123,6 @@ * @param r The current request * @param mtime The last modified time * @return the latest rational time. - * @deffunc apr_time_t ap_rationalize_mtime(request_rec *r, apr_time_t mtime) */ AP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime); @@ -134,8 +134,8 @@ * - then, if there are no parameters on type, add the default charset * - return type * @param r The current request + * @param type The content type * @return The content-type - * @deffunc const char *ap_make_content_type(request_rec *r, const char *type); */ AP_DECLARE(const char *) ap_make_content_type(request_rec *r, const char *type); @@ -143,8 +143,7 @@ #ifdef CORE_PRIVATE /** * Precompile metadata structures used by ap_make_content_type() - * @param r The pool to use for allocations - * @deffunc void ap_setup_make_content_type(apr_pool_t *pool) + * @param pool The pool to use for allocations */ AP_DECLARE(void) ap_setup_make_content_type(apr_pool_t *pool); #endif /* CORE_PRIVATE */ @@ -156,21 +155,18 @@ * @param force_weak Force the entity tag to be weak - it could be modified * again in as short an interval. * @return The entity tag - * @deffunc char *ap_make_etag(request_rec *r, int force_weak) */ AP_DECLARE(char *) ap_make_etag(request_rec *r, int force_weak); /** * Set the E-tag outgoing header - * @param The current request - * @deffunc void ap_set_etag(request_rec *r) + * @param r The current request */ AP_DECLARE(void) ap_set_etag(request_rec *r); /** * Set the last modified time for the file being sent * @param r The current request - * @deffunc void ap_set_last_modified(request_rec *r) */ AP_DECLARE(void) ap_set_last_modified(request_rec *r); @@ -181,7 +177,6 @@ * @param r The current request * @return OK if the response fulfills the condition GET rules, some * other status code otherwise - * @deffunc int ap_meets_conditions(request_rec *r) */ AP_DECLARE(int) ap_meets_conditions(request_rec *r); @@ -204,7 +199,6 @@ * @param offset Offset into the file to start sending. * @param length Amount of data to send * @param nbytes Amount of data actually sent - * @deffunc apr_status_t ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset, apr_size_t length, apr_size_t *nbytes); */ AP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset, apr_size_t length, apr_size_t *nbytes); @@ -217,7 +211,6 @@ * @param offset The offset into the MMAP to start sending * @param length The amount of data to send * @return The number of bytes sent - * @deffunc size_t ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset, size_t length) */ AP_DECLARE(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset, size_t length); @@ -241,7 +234,7 @@ */ AP_DECLARE(void) ap_method_registry_init(apr_pool_t *p); -/* +/** * This is a convenience macro to ease with checking a mask * against a method name. */ @@ -256,9 +249,16 @@ * allocated. * @param nelts Number of preallocated extension slots * @return Pointer to the newly created structure. - * @deffunc ap_method_list_t ap_make_method_list(apr_pool_t *p, int nelts) */ AP_DECLARE(ap_method_list_t *) ap_make_method_list(apr_pool_t *p, int nelts); + + +/** + * Copy a method list + * + * @param dest List to copy to + * @param src List to copy from + */ AP_DECLARE(void) ap_copy_method_list(ap_method_list_t *dest, ap_method_list_t *src); @@ -269,7 +269,6 @@ * @param method String containing the name of the method to check. * @param l Pointer to a method list, such as cmd->methods_limited. * @return 1 if method is in the list, otherwise 0 - * @deffunc int ap_method_in_list(const char *method, ap_method_list_t *l) */ AP_DECLARE(int) ap_method_in_list(ap_method_list_t *l, const char *method); @@ -280,7 +279,6 @@ * @param method String containing the name of the method to check. * @param l Pointer to a method list, such as cmd->methods_limited. * @return None. - * @deffunc void ap_method_in_list(ap_method_list_t *l, const char *method) */ AP_DECLARE(void) ap_method_list_add(ap_method_list_t *l, const char *method); @@ -290,7 +288,6 @@ * @param l Pointer to a method list, such as cmd->methods_limited. * @param method String containing the name of the method to remove. * @return None. - * @deffunc void ap_method_list_remove(ap_method_list_t *l, const char *method) */ AP_DECLARE(void) ap_method_list_remove(ap_method_list_t *l, const char *method); @@ -300,7 +297,6 @@ * * @param l Pointer to a method list, such as cmd->methods_limited. * @return None. - * @deffunc void ap_clear_method_list(ap_method_list_t *l) */ AP_DECLARE(void) ap_clear_method_list(ap_method_list_t *l); @@ -308,7 +304,6 @@ * Set the content type for this request (r->content_type). * @param r The current request * @param ct The new content type - * @deffunc void ap_set_content_type(request_rec *r, const char* ct) * @warning This function must be called to set r->content_type in order * for the AddOutputFilterByType directive to work correctly. */ @@ -323,7 +318,6 @@ * @param c the character to output * @param r the current request * @return The number of bytes sent - * @deffunc int ap_rputc(int c, request_rec *r) */ AP_DECLARE(int) ap_rputc(int c, request_rec *r); @@ -332,7 +326,6 @@ * @param str The string to output * @param r The current request * @return The number of bytes sent - * @deffunc int ap_rputs(const char *str, request_rec *r) */ AP_DECLARE(int) ap_rputs(const char *str, request_rec *r); @@ -342,7 +335,6 @@ * @param nbyte The number of bytes to send from the buffer * @param r The current request * @return The number of bytes sent - * @deffunc int ap_rwrite(const void *buf, int nbyte, request_rec *r) */ AP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r); @@ -351,7 +343,6 @@ * @param r The current request * @param ... The strings to write * @return The number of bytes sent - * @deffunc int ap_rvputs(request_rec *r, ...) */ AP_DECLARE_NONSTD(int) ap_rvputs(request_rec *r,...); @@ -361,7 +352,6 @@ * @param fmt The format string * @param vlist The arguments to use to fill out the format string * @return The number of bytes sent - * @deffunc int ap_vrprintf(request_rec *r, const char *fmt, va_list vlist) */ AP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list vlist); @@ -371,15 +361,14 @@ * @param fmt The format string * @param ... The arguments to use to fill out the format string * @return The number of bytes sent - * @deffunc int ap_rprintf(request_rec *r, const char *fmt, ...) */ AP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt,...) __attribute__((format(printf,2,3))); + /** * Flush all of the data for the current request to the client * @param r The current request * @return The number of bytes sent - * @deffunc int ap_rflush(request_rec *r) */ AP_DECLARE(int) ap_rflush(request_rec *r); @@ -388,7 +377,6 @@ * (only use outside protocol.c is in getting them configured). * @param status HTTP status code * @return The index of the response - * @deffunc int ap_index_of_response(int status) */ AP_DECLARE(int) ap_index_of_response(int status); @@ -398,7 +386,6 @@ * passed, "500 Internal Server Error" will be returned. * @param status The HTTP status code * @return The Status-Line - * @deffunc const char *ap_get_status_line(int status) */ AP_DECLARE(const char *) ap_get_status_line(int status); @@ -414,7 +401,6 @@ * REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me. * * @return either OK or an error code - * @deffunc int ap_setup_client_block(request_rec *r, int read_policy) */ AP_DECLARE(int) ap_setup_client_block(request_rec *r, int read_policy); @@ -425,7 +411,6 @@ * @warning Never call this function more than once. * @param r The current request * @return 0 if there is no message to read, 1 otherwise - * @deffunc int ap_should_client_block(request_rec *r) */ AP_DECLARE(int) ap_should_client_block(request_rec *r); @@ -437,7 +422,6 @@ * @param bufsiz The size of the buffer * @return Number of bytes inserted into the buffer. When done reading, 0 * if EOF, or -1 if there was an error - * @deffunc long ap_get_client_block(request_rec *r, char *buffer, apr_size_t bufsiz) */ AP_DECLARE(long) ap_get_client_block(request_rec *r, char *buffer, apr_size_t bufsiz); @@ -450,17 +434,14 @@ * as the next request on a persistent connection. * @param r The current request * @return error status if request is malformed, OK otherwise - * @deffunc int ap_discard_request_body(request_rec *r) */ AP_DECLARE(int) ap_discard_request_body(request_rec *r); - /** * Setup the output headers so that the client knows how to authenticate * itself the next time, if an authentication request failed. This function * works for both basic and digest authentication * @param r The current request - * @deffunc void ap_note_auth_failure(request_rec *r) */ AP_DECLARE(void) ap_note_auth_failure(request_rec *r); @@ -469,7 +450,6 @@ * itself the next time, if an authentication request failed. This function * works only for basic authentication * @param r The current request - * @deffunc void ap_note_basic_auth_failure(request_rec *r) */ AP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r); @@ -478,7 +458,6 @@ * itself the next time, if an authentication request failed. This function * works only for digest authentication * @param r The current request - * @deffunc void ap_note_digest_auth_failure(request_rec *r) */ AP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r); @@ -493,20 +472,17 @@ * seemed to be in use, or DECLINED if there was authentication but * it wasn't Basic (in which case, the caller should presumably * decline as well). - * @deffunc int ap_get_basic_auth_pw(request_rec *r, const char **pw) */ AP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw); /** * parse_uri: break apart the uri - * @warning Side Effects: 
- *    - sets r->args to rest after '?' (or NULL if no '?')
- *    - sets r->uri to request uri (without r->args part)
- *    - sets r->hostname (if not set already) from request (scheme://host:port)
- *
+ * @warning Side Effects: + * @li sets r->args to rest after '?' (or NULL if no '?') + * @li sets r->uri to request uri (without r->args part) + * @li sets r->hostname (if not set already) from request (scheme://host:port) * @param r The current request * @param uri The uri to break apart - * @deffunc void ap_parse_uri(request_rec *r, const char *uri) */ AP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri); @@ -519,7 +495,6 @@ * @return The length of the line, if successful * n, if the line is too big to fit in the buffer * -1 for miscellaneous errors - * @deffunc int ap_method_number_of(const char *method) */ AP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold); @@ -554,6 +529,8 @@ #define ap_rgetline(s, n, read, r, fold, bb) \ ap_rgetline_core((s), (n), (read), (r), (fold), (bb)) #endif + +/** @see ap_rgetline */ AP_DECLARE(apr_status_t) ap_rgetline_core(char **s, apr_size_t n, apr_size_t *read, request_rec *r, int fold, @@ -588,7 +565,6 @@ * modules to make decisions based upon the input header fields * @param r The current request * @return OK or DECLINED - * @deffunc ap_run_post_read_request(request_rec *r) */ AP_DECLARE_HOOK(int,post_read_request,(request_rec *r)) @@ -597,7 +573,6 @@ * over and above the normal server things. * @param r The current request * @return OK, DECLINED, or HTTP_... - * @deffunc int ap_run_log_transaction(request_rec *r) */ AP_DECLARE_HOOK(int,log_transaction,(request_rec *r)) @@ -606,7 +581,6 @@ * allows Apache modules to easily extend the schemes that Apache understands * @param r The current request * @return The http scheme from the request - * @deffunc const char *ap_run_http_scheme(const request_rec *r) */ AP_DECLARE_HOOK(const char *,http_scheme,(const request_rec *r)) @@ -614,14 +588,16 @@ * Return the default port from the current request * @param r The current request * @return The current port - * @deffunc apr_port_t ap_run_default_port(const request_rec *r) */ AP_DECLARE_HOOK(apr_port_t,default_port,(const request_rec *r)) +/** @see ap_bucket_type_error */ typedef struct ap_bucket_error ap_bucket_error; /** - * A bucket referring to an HTTP error + * @struct ap_bucket_error + * @brief A bucket referring to an HTTP error + * * This bucket can be passed down the filter stack to indicate that an * HTTP error occurred while running a filter. In order for this bucket * to be used successfully, it MUST be sent as the first bucket in the @@ -636,6 +612,7 @@ const char *data; }; +/** @see ap_bucket_type_error */ AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_error; /** @@ -652,7 +629,6 @@ * @param buf An optional error string to put in the bucket. * @param p A pool to allocate out of. * @return The new bucket, or NULL if allocation failed - * @deffunc apr_bucket *ap_bucket_error_make(apr_bucket *b, int error, const char *buf, apr_pool_t *p) */ AP_DECLARE(apr_bucket *) ap_bucket_error_make(apr_bucket *b, int error, const char *buf, apr_pool_t *p); @@ -664,7 +640,6 @@ * @param p A pool to allocate the error string out of. * @param list The bucket allocator from which to allocate the bucket * @return The new bucket, or NULL if allocation failed - * @deffunc apr_bucket *ap_bucket_error_create(int error, const char *buf, apr_pool_t *p, apr_bucket_alloc_t *list) */ AP_DECLARE(apr_bucket *) ap_bucket_error_create(int error, const char *buf, apr_pool_t *p, @@ -676,11 +651,18 @@ apr_bucket_brigade *); AP_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(ap_filter_t *f, apr_bucket_brigade *b); -/* - * Setting up the protocol fields for subsidiary requests... - * Also, a wrapup function to keep the internal accounting straight. +/** + * Sett up the protocol fields for subsidiary requests + * @param rnew New Sub Request + * @param r current request */ AP_DECLARE(void) ap_set_sub_req_protocol(request_rec *rnew, const request_rec *r); + +/** + * A wrapup function to keep the internal accounting straight. + * Indicates that there is no more content coming. + * @param sub_r Subrequest that is now compete + */ AP_DECLARE(void) ap_finalize_sub_req_protocol(request_rec *sub_r); #ifdef __cplusplus @@ -688,3 +670,4 @@ #endif #endif /* !APACHE_HTTP_PROTOCOL_H */ +/** @} */ Modified: httpd/httpd/branches/2.2.x/include/http_request.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_request.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_request.h (original) +++ httpd/httpd/branches/2.2.x/include/http_request.h Thu Sep 29 13:44:53 2005 @@ -14,25 +14,11 @@ * limitations under the License. */ -#ifndef APACHE_HTTP_REQUEST_H -#define APACHE_HTTP_REQUEST_H - -#include "apr_hooks.h" -#include "util_filter.h" - -#ifdef __cplusplus -extern "C" { -#endif - -#define AP_SUBREQ_NO_ARGS 0 -#define AP_SUBREQ_MERGE_ARGS 1 - /** * @file http_request.h * @brief Apache Request library - */ - -/* http_request.c is the code which handles the main line of request + * + * request.c is the code which handles the main line of request * processing, once a request has been read in (finding the right per- * directory configuration, building it if necessary, and calling all * the module dispatch functions in the right order). @@ -52,6 +38,19 @@ * about which was allocated in its apr_pool_t elsewhere before doing this. */ +#ifndef APACHE_HTTP_REQUEST_H +#define APACHE_HTTP_REQUEST_H + +#include "apr_hooks.h" +#include "util_filter.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define AP_SUBREQ_NO_ARGS 0 +#define AP_SUBREQ_MERGE_ARGS 1 + /** * An internal handler used by the ap_process_request, all subrequest mechanisms * and the redirect mechanism. @@ -68,7 +67,6 @@ * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record - * @deffunc request_rec * ap_sub_req_lookup_uri(const char *new_uri, const request_rec *r) */ AP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_uri, const request_rec *r, @@ -82,7 +80,6 @@ * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record - * @deffunc request_rec * ap_sub_req_lookup_file(const char *new_file, const request_rec *r) */ AP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file, const request_rec *r, @@ -100,8 +97,7 @@ * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record - * @deffunc request_rec * ap_sub_req_lookup_dirent(apr_finfo_t *finfo, int subtype, const request_rec *r) - * @tip The apr_dir_read flags value APR_FINFO_MIN|APR_FINFO_NAME flag is the + * @note The apr_dir_read flags value APR_FINFO_MIN|APR_FINFO_NAME flag is the * minimum recommended query if the results will be passed to apr_dir_read. * The file info passed must include the name, and must have the same relative * directory as the current request. @@ -119,7 +115,6 @@ * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record - * @deffunc request_rec * ap_sub_req_method_uri(const char *method, const char *new_uri, const request_rec *r) */ AP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method, const char *new_uri, @@ -130,7 +125,7 @@ * has to be inserted at the end of a sub-requests filter stack. * @param f The current filter * @param bb The brigade to filter - * @deffunc apr_status_t ap_sub_req_output_filter(ap_filter_t *f, apr_bucket_brigade *bb) + * @return status code */ AP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f, apr_bucket_brigade *bb); @@ -139,14 +134,12 @@ * Run the handler for the subrequest * @param r The subrequest to run * @return The return code for the subrequest - * @deffunc int ap_run_sub_req(request_rec *r) */ AP_DECLARE(int) ap_run_sub_req(request_rec *r); /** * Free the memory associated with a subrequest * @param r The subrequest to finish - * @deffunc void ap_destroy_sub_req(request_rec *r) */ AP_DECLARE(void) ap_destroy_sub_req(request_rec *r); @@ -160,7 +153,6 @@ * Redirect the current request to some other uri * @param new_uri The URI to replace the current request with * @param r The current request - * @deffunc void ap_internal_redirect(const char *new_uri, request_rec *r) */ AP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r); @@ -170,7 +162,6 @@ * an internal redirect. * @param new_uri The URI to replace the current request with. * @param r The current request - * @deffunc void ap_internal_redirect_handler(const char *new_uri, request_rec *r) */ AP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r); @@ -178,8 +169,7 @@ * Redirect the current request to a sub_req, merging the pools * @param sub_req A subrequest created from this request * @param r The current request - * @deffunc void ap_internal_fast_redirect(request_rec *sub_req, request_rec *r) - * @tip the sub_req's pool will be merged into r's pool, be very careful + * @note the sub_req's pool will be merged into r's pool, be very careful * not to destroy this subrequest, it will be destroyed with the main request! */ AP_DECLARE(void) ap_internal_fast_redirect(request_rec *sub_req, request_rec *r); @@ -189,7 +179,6 @@ * is required for the current request * @param r The current request * @return 1 if authentication is required, 0 otherwise - * @deffunc int ap_some_auth_required(request_rec *r) */ AP_DECLARE(int) ap_some_auth_required(request_rec *r); @@ -197,7 +186,6 @@ * Determine if the current request is the main request or a subrequest * @param r The current request * @return 1 if this is the main request, 0 otherwise - * @deffunc int ap_is_initial_req(request_rec *r) */ AP_DECLARE(int) ap_is_initial_req(request_rec *r); @@ -205,8 +193,7 @@ * Function to set the r->mtime field to the specified value if it's later * than what's already there. * @param r The current request - * @param dependency_time Time to set the mtime to - * @deffunc void ap_update_mtime(request_rec *r, apr_time_t dependency_mtime) + * @param dependency_mtime Time to set the mtime to */ AP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime); @@ -224,7 +211,6 @@ * @param ... A NULL-terminated list of strings, each identifying a * method name to add. * @return None. - * @deffunc void ap_allow_methods(request_rec *r, int reset, ...) */ AP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...); @@ -243,7 +229,6 @@ * defined in httpd.h, terminated with a value of -1 * (e.g., "M_GET, M_POST, M_OPTIONS, -1") * @return None. - * @deffunc void ap_allow_standard_methods(request_rec *r, int reset, ...) */ AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...); @@ -251,13 +236,16 @@ #define REPLACE_ALLOW 1 #ifdef CORE_PRIVATE -/* Function called by main.c to handle first-level request */ +/** + * Function called by main.c to handle first-level request + * @param r The current request + */ void ap_process_request(request_rec *); + /** * Kill the current request * @param type Why the request is dieing * @param r The current request - * @deffunc void ap_die(int type, request_rec *r) */ AP_DECLARE(void) ap_die(int type, request_rec *r); #endif @@ -284,7 +272,7 @@ /** * This hook allow modules to set the per_dir_config based on their own - * context (such as sections) and responds to contextless requests + * context (such as "" sections) and responds to contextless requests * such as TRACE that need no security or filesystem mapping. * based on the filesystem. * @param r The current request Modified: httpd/httpd/branches/2.2.x/include/http_vhost.h URL: http://svn.apache.org/viewcvs/httpd/httpd/branches/2.2.x/include/http_vhost.h?rev=292540&r1=292539&r2=292540&view=diff ============================================================================== --- httpd/httpd/branches/2.2.x/include/http_vhost.h (original) +++ httpd/httpd/branches/2.2.x/include/http_vhost.h Thu Sep 29 13:44:53 2005 @@ -14,6 +14,15 @@ * limitations under the License. */ +/** + * @file http_vhost.h + * @brief Virtual Host package + * + * @defgroup APACHE_CORE_VHOST Virtual Host Package + * @ingroup APACHE_CORE + * @{ + */ + #ifndef APACHE_HTTP_VHOST_H #define APACHE_HTTP_VHOST_H @@ -22,10 +31,6 @@ #endif /** - * @package Virtual Host package - */ - -/** * called before any config is read * @param p Pool to allocate out of */ @@ -36,19 +41,23 @@ * the run-time vhost lookups * @param p The pool to allocate out of * @param main_server The start of the virtual host list - * @deffunc ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server) */ AP_DECLARE(void) ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server); /** - * handle addresses in statement + * handle addresses in "" statement * @param p The pool to allocate out of * @param hostname The hostname in the VirtualHost statement * @param s The list of Virtual Hosts. */ const char *ap_parse_vhost_addrs(apr_pool_t *p, const char *hostname, server_rec *s); -/* handle NameVirtualHost directive */ +/** + * handle NameVirtualHost directive + * @param cmd Command Parameters structure + * @param dummy NOT USED + * @param arg a host of the form "
[:port]" + */ const char *ap_set_name_virtual_host (cmd_parms *cmd, void *dummy, const char *arg); @@ -97,7 +106,6 @@ * @param port The port from the headers * @return return 1 if the host:port matches any of the aliases of r->server, * return 0 otherwise - * @deffunc int ap_matches_request_vhost(request_rec *r, const char *host, apr_port_t port) */ AP_DECLARE(int) ap_matches_request_vhost(request_rec *r, const char *host, apr_port_t port); @@ -107,3 +115,4 @@ #endif #endif /* !APACHE_HTTP_VHOST_H */ +/** @} */