You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ia...@apache.org on 2005/08/29 01:05:15 UTC
svn commit: r263931 [2/3] - in /httpd/httpd/trunk: ./ docs/ include/
modules/aaa/ modules/arch/win32/ modules/cache/ modules/dav/fs/
modules/dav/lock/ modules/dav/main/ modules/experimental/ modules/filters/
modules/generators/ modules/http/ modules/ld...
Modified: httpd/httpd/trunk/include/httpd.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/httpd.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/httpd.h (original)
+++ httpd/httpd/trunk/include/httpd.h Sun Aug 28 16:03:59 2005
@@ -14,14 +14,27 @@
* limitations under the License.
*/
-#ifndef APACHE_HTTPD_H
-#define APACHE_HTTPD_H
-
/**
* @file httpd.h
* @brief HTTP Daemon routines
+ *
+ * @defgroup APACHE Apache
+ *
+ * Top level group of which all other groups are a member
+ * @{
+ *
+ * @defgroup APACHE_MODS Apache Modules
+ * Top level group for Apache Modules
+ * @defgroup APACHE_OS Operating System Specific
+ * @defgroup APACHE_CORE Apache Core
+ * @{
+ * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
+ * @{
*/
+#ifndef APACHE_HTTPD_H
+#define APACHE_HTTPD_H
+
/* XXX - We need to push more stuff to other .h files, or even .c files, to
* make this file smaller
*/
@@ -59,23 +72,24 @@
/* ----------------------------- config dir ------------------------------ */
-/* Define this to be the default server home dir. Most things later in this
+/** Define this to be the default server home dir. Most things later in this
* file with a relative pathname will have this added.
*/
#ifndef HTTPD_ROOT
#ifdef OS2
-/* Set default for OS/2 file system */
+/** Set default for OS/2 file system */
#define HTTPD_ROOT "/os2httpd"
#elif defined(WIN32)
-/* Set default for Windows file system */
+/** Set default for Windows file system */
#define HTTPD_ROOT "/apache"
#elif defined (BEOS)
-/* Set the default for BeOS */
+/** Set the default for BeOS */
#define HTTPD_ROOT "/boot/home/apache"
#elif defined (NETWARE)
-/* Set the default for NetWare */
+/** Set the default for NetWare */
#define HTTPD_ROOT "/apache"
#else
+/** Set for all other OSs */
#define HTTPD_ROOT "/usr/local/apache"
#endif
#endif /* HTTPD_ROOT */
@@ -88,7 +102,8 @@
*
*/
-/* Default location of documents. Can be overridden by the DocumentRoot
+/**
+ * Default location of documents. Can be overridden by the DocumentRoot
* directive.
*/
#ifndef DOCUMENT_LOCATION
@@ -96,19 +111,20 @@
/* Set default for OS/2 file system */
#define DOCUMENT_LOCATION HTTPD_ROOT "/docs"
#else
+/* Set default for non OS/2 file system */
#define DOCUMENT_LOCATION HTTPD_ROOT "/htdocs"
#endif
#endif /* DOCUMENT_LOCATION */
-/* Maximum number of dynamically loaded modules */
+/** Maximum number of dynamically loaded modules */
#ifndef DYNAMIC_MODULE_LIMIT
#define DYNAMIC_MODULE_LIMIT 128
#endif
-/* Default administrator's address */
+/** Default administrator's address */
#define DEFAULT_ADMIN "[no address given]"
-/* The name of the log files */
+/** The name of the log files */
#ifndef DEFAULT_ERRORLOG
#if defined(OS2) || defined(WIN32)
#define DEFAULT_ERRORLOG "logs/error.log"
@@ -117,7 +133,7 @@
#endif
#endif /* DEFAULT_ERRORLOG */
-/* Define this to be what your per-directory security files are called */
+/** Define this to be what your per-directory security files are called */
#ifndef DEFAULT_ACCESS_FNAME
#ifdef OS2
/* Set default for OS/2 file system */
@@ -127,37 +143,38 @@
#endif
#endif /* DEFAULT_ACCESS_FNAME */
-/* The name of the server config file */
+/** The name of the server config file */
#ifndef SERVER_CONFIG_FILE
#define SERVER_CONFIG_FILE "conf/httpd.conf"
#endif
-/* The default path for CGI scripts if none is currently set */
+/** The default path for CGI scripts if none is currently set */
#ifndef DEFAULT_PATH
#define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
#endif
-/* The path to the suExec wrapper, can be overridden in Configuration */
+/** The path to the suExec wrapper, can be overridden in Configuration */
#ifndef SUEXEC_BIN
#define SUEXEC_BIN HTTPD_ROOT "/bin/suexec"
#endif
-/* The timeout for waiting for messages */
+/** The timeout for waiting for messages */
#ifndef DEFAULT_TIMEOUT
#define DEFAULT_TIMEOUT 300
#endif
-/* The timeout for waiting for keepalive timeout until next request */
+/** The timeout for waiting for keepalive timeout until next request */
#ifndef DEFAULT_KEEPALIVE_TIMEOUT
#define DEFAULT_KEEPALIVE_TIMEOUT 5
#endif
-/* The number of requests to entertain per connection */
+/** The number of requests to entertain per connection */
#ifndef DEFAULT_KEEPALIVE
#define DEFAULT_KEEPALIVE 100
#endif
-/* Limits on the size of various request items. These limits primarily
+/*
+ * Limits on the size of various request items. These limits primarily
* exist to prevent simple denial-of-service attacks on a server based
* on misuse of the protocol. The recommended values will depend on the
* nature of the server resources -- CGI scripts and database backends
@@ -173,16 +190,19 @@
* DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
* the server config directive LimitRequestFields.
*/
+
+/** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
#ifndef DEFAULT_LIMIT_REQUEST_LINE
#define DEFAULT_LIMIT_REQUEST_LINE 8190
-#endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
+#endif
+/** default limit on bytes in any one header field */
#ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
#define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
-#endif /* default limit on bytes in any one header field */
+#endif
+/** default limit on number of request header fields */
#ifndef DEFAULT_LIMIT_REQUEST_FIELDS
#define DEFAULT_LIMIT_REQUEST_FIELDS 100
-#endif /* default limit on number of request header fields */
-
+#endif
/**
* The default default character set name to add if AddDefaultCharset is
@@ -256,7 +276,6 @@
"xhtml1-frameset.dtd\">"
/** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
-
#define HTTP_VERSION(major,minor) (1000*(major)+(minor))
/** Major part of HTTP protocol */
#define HTTP_VERSION_MAJOR(number) ((number)/1000)
@@ -287,8 +306,10 @@
*/
#define ap_http_scheme(r) ap_run_http_scheme(r)
-/** The default string lengths */
+/** The default string length */
#define MAX_STRING_LEN HUGE_STRING_LEN
+
+/** The length of a Huge string */
#define HUGE_STRING_LEN 8192
/** The size of the server's internal read-write buffers */
@@ -364,14 +385,15 @@
/**
* @internal
- * modules should not used functions marked AP_CORE_DECLARE
+ * modules should not use functions marked AP_CORE_DECLARE
*/
#ifndef AP_CORE_DECLARE
# define AP_CORE_DECLARE AP_DECLARE
#endif
+
/**
* @internal
- * modules should not used functions marked AP_CORE_DECLARE_NONSTD
+ * modules should not use functions marked AP_CORE_DECLARE_NONSTD
*/
#ifndef AP_CORE_DECLARE_NONSTD
@@ -379,7 +401,7 @@
#endif
/**
- * The numeric version information is broken out into fields within this
+ * @brief The numeric version information is broken out into fields within this
* structure.
*/
typedef struct {
@@ -508,33 +530,37 @@
((x) == HTTP_SERVICE_UNAVAILABLE) || \
((x) == HTTP_NOT_IMPLEMENTED))
/** @} */
+
/**
* @defgroup Methods List of Methods recognized by the server
+ * @ingroup APACHE_CORE_DAEMON
* @{
- */
-/**
- * Methods recognized (but not necessarily handled) by the server.
+ *
+ * @brief Methods recognized (but not necessarily handled) by the server.
+ *
* These constants are used in bit shifting masks of size int, so it is
* unsafe to have more methods than bits in an int. HEAD == M_GET.
* This list must be tracked by the list in http_protocol.c in routine
* ap_method_name_of().
+ *
*/
-#define M_GET 0 /* RFC 2616: HTTP */
+
+#define M_GET 0 /** RFC 2616: HTTP */
#define M_PUT 1 /* : */
#define M_POST 2
#define M_DELETE 3
#define M_CONNECT 4
#define M_OPTIONS 5
-#define M_TRACE 6 /* RFC 2616: HTTP */
-#define M_PATCH 7 /* no rfc(!) ### remove this one? */
-#define M_PROPFIND 8 /* RFC 2518: WebDAV */
+#define M_TRACE 6 /** RFC 2616: HTTP */
+#define M_PATCH 7 /** no rfc(!) ### remove this one? */
+#define M_PROPFIND 8 /** RFC 2518: WebDAV */
#define M_PROPPATCH 9 /* : */
#define M_MKCOL 10
#define M_COPY 11
#define M_MOVE 12
#define M_LOCK 13
-#define M_UNLOCK 14 /* RFC 2518: WebDAV */
-#define M_VERSION_CONTROL 15 /* RFC 3253: WebDAV Versioning */
+#define M_UNLOCK 14 /** RFC 2518: WebDAV */
+#define M_VERSION_CONTROL 15 /** RFC 3253: WebDAV Versioning */
#define M_CHECKOUT 16 /* : */
#define M_UNCHECKOUT 17
#define M_CHECKIN 18
@@ -545,7 +571,7 @@
#define M_MKACTIVITY 23
#define M_BASELINE_CONTROL 24
#define M_MERGE 25
-#define M_INVALID 26 /* RFC 3253: WebDAV Versioning */
+#define M_INVALID 26 /** RFC 3253: WebDAV Versioning */
/**
* METHODS needs to be equal to the number of bits
@@ -560,18 +586,23 @@
/** @} */
+/** @see ap_method_list_t */
+typedef struct ap_method_list_t ap_method_list_t;
+
/**
- * Structure for handling HTTP methods. Methods known to the server are
- * accessed via a bitmask shortcut; extension methods are handled by
- * an array.
+ * @struct ap_method_list_t
+ * @brief Structure for handling HTTP methods.
+ *
+ * Methods known to the server are accessed via a bitmask shortcut;
+ * extension methods are handled by an array.
*/
-typedef struct ap_method_list_t ap_method_list_t;
struct ap_method_list_t {
- /* The bitmask used for known methods */
+ /** The bitmask used for known methods */
apr_int64_t method_mask;
- /* the array used for extension methods */
+ /** the array used for extension methods */
apr_array_header_t *method_list;
};
+
/**
* @defgroup module_magic Module Magic mime types
* @{
@@ -618,10 +649,11 @@
#define REQUEST_CHUNKED_ERROR 1
/** If chunked, remove the chunks for me. */
#define REQUEST_CHUNKED_DECHUNK 2
-/** @} */
+/** @} // values_request_rec_body */
/**
* @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info
+ * @ingroup APACHE_CORE_DAEMON
* @{
* Possible values for request_rec.used_path_info:
*/
@@ -632,7 +664,9 @@
#define AP_REQ_REJECT_PATH_INFO 1
/** Module may chose to use the given path_info */
#define AP_REQ_DEFAULT_PATH_INFO 2
-/** @} */
+
+/** @} // values_request_rec_used_path_info */
+
/*
* Things which may vary per file-lookup WITHIN a request ---
@@ -649,7 +683,7 @@
*/
/**
- * This represents the result of calling htaccess; these are cached for
+ * @brief This represents the result of calling htaccess; these are cached for
* each request.
*/
struct htaccess_result {
@@ -688,7 +722,9 @@
/* This comes after we have defined the request_rec type */
#include "apr_uri.h"
-/** A structure that represents one process */
+/**
+ * @brief A structure that represents one process
+ */
struct process_rec {
/** Global pool. Cleared upon normal exit */
apr_pool_t *pool;
@@ -702,7 +738,9 @@
const char *short_name;
};
-/** A structure that represents the current request */
+/**
+ * @brief A structure that represents the current request
+ */
struct request_rec {
/** The pool associated with the request */
apr_pool_t *pool;
@@ -953,13 +991,18 @@
/* @} */
+/**
+ * @brief Enumeration of connection keepalive options
+ */
typedef enum {
AP_CONN_UNKNOWN,
AP_CONN_CLOSE,
AP_CONN_KEEPALIVE
} ap_conn_keepalive_e;
-/** Structure to store things which are per connection */
+/**
+ * @brief Structure to store things which are per connection
+ */
struct conn_rec {
/** Pool associated with this connection */
apr_pool_t *pool;
@@ -1025,19 +1068,32 @@
int data_in_input_filters;
};
+/**
+ * Enumeration of connection states
+ */
typedef enum {
CONN_STATE_CHECK_REQUEST_LINE_READABLE,
CONN_STATE_READ_REQUEST_LINE,
CONN_STATE_LINGER,
} conn_state_e;
+/**
+ * @brief A structure to contain connection state information
+ */
struct conn_state_t {
- APR_RING_ENTRY(conn_state_t) timeout_list;
- apr_time_t expiration_time;
+ /** APR_RING of expiration timeouts */
+ APR_RING_ENTRY(conn_state_t) timeout_list;
+ /** the expiration time of the next keepalive timeout */
+ apr_time_t expiration_time;
+ /** Current state of the connection */
conn_state_e state;
+ /** connection record this struct refers to */
conn_rec *c;
+ /** memory pool to allocate from */
apr_pool_t *p;
+ /** bucket allocator */
apr_bucket_alloc_t *bucket_alloc;
+ /** poll file decriptor information */
apr_pollfd_t pfd;
};
@@ -1050,7 +1106,10 @@
#define DEFAULT_VHOST_ADDR 0xfffffffful
-/** A structure to be used for Per-vhost config */
+/**
+ * @struct server_addr_rec
+ * @brief A structure to be used for Per-vhost config
+ */
typedef struct server_addr_rec server_addr_rec;
struct server_addr_rec {
/** The next server in the list */
@@ -1059,11 +1118,13 @@
apr_sockaddr_t *host_addr;
/** The bound port, for this server */
apr_port_t host_port;
- /** The name given in <VirtualHost> */
+ /** The name given in "<VirtualHost>" */
char *virthost;
};
-/** A structure to store information for each virtual server */
+/**
+ * @brief A structure to store information for each virtual server
+ */
struct server_rec {
/** The process this server is running in */
process_rec *process;
@@ -1136,9 +1197,10 @@
typedef struct core_output_filter_ctx {
apr_bucket_brigade *b;
- apr_pool_t *deferred_write_pool; /* subpool of c->pool used for resources
- * which may outlive the request
- */
+ /** subpool of c->pool used for resources
+ * which may outlive the request
+ */
+ apr_pool_t *deferred_write_pool;
} core_output_filter_ctx_t;
typedef struct core_filter_ctx {
@@ -1188,6 +1250,7 @@
* @return A copy of the characters up to the first stop character
*/
AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
+
/**
* Get the characters until the first occurance of a specified character
* @param p The pool to allocate memory from
@@ -1206,18 +1269,19 @@
* @return The first word in the line
*/
AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
+
/**
* Get the first word from a given string. A word is defined as all characters
* up to the first whitespace.
* @param p The pool to allocate memory from
* @param line The string to traverse
* @return The first word in the line
- * @note The same as ap_getword_white(), except it doesn't use const char **.
+ * @note The same as ap_getword_white(), except it doesn't use const char**
*/
AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
/**
- * Get all characters from the first occurance of @a stop to the first '\0'
+ * Get all characters from the first occurance of @a stop to the first "\0"
* @param p The pool to allocate memory from
* @param line The line to traverse
* @param stop The character to start at
@@ -1226,8 +1290,9 @@
*/
AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
char stop);
+
/**
- * Get all characters from the first occurance of @a stop to the first '\0'
+ * Get all characters from the first occurance of @a stop to the first "\0"
* @param p The pool to allocate memory from
* @param line The line to traverse
* @param stop The character to start at
@@ -1244,6 +1309,7 @@
* @return A copy of the string
*/
AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
+
/**
* Get the second word in the string paying attention to quoting
* @param p The pool to allocate from
@@ -1340,12 +1406,14 @@
* @return 0 on success, non-zero otherwise
*/
AP_DECLARE(int) ap_unescape_url(char *url);
+
/**
* Unescape a URL, but leaving %2f (slashes) escaped
* @param url The url to unescape
* @return 0 on success, non-zero otherwise
*/
AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
+
/**
* Convert all double slashes to single slashes
* @param name The string to convert
@@ -1366,6 +1434,7 @@
* @return The converted URL
*/
AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
+
/**
* convert an OS path to a URL in an OS dependant way.
* @param p The pool to allocate from
@@ -1375,6 +1444,7 @@
* @return The converted URL
*/
AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
+
/** @see ap_os_escape_path */
#define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
@@ -1398,7 +1468,7 @@
* Escape a string for logging into the error log (without a pool)
* @param dest The buffer to write to
* @param source The string to escape
- * @param buflen The buffer size for the escaped string (including \0)
+ * @param buflen The buffer size for the escaped string (including "\0")
* @return The len of the escaped string (always < maxlen)
*/
AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
@@ -1414,6 +1484,7 @@
*/
AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
apr_port_t port, const request_rec *r);
+
/**
* Escape a shell command
* @param p The pool to allocate from
@@ -1436,7 +1507,7 @@
* @param d The location to copy to
* @param s The location to copy from
* @param n The number of directories to copy
- * @return value is the ever useful pointer to the trailing \0 of d
+ * @return value is the ever useful pointer to the trailing "\0" of d
* @note on platforms with drive letters, n = 0 returns the "/" root,
* whereas n = 1 returns the "d:/" root. On all other platforms, n = 0
* returns the empty string. */
@@ -1459,7 +1530,7 @@
* @param dir The directory name
* @param f The filename
* @return A copy of the full path
- * @tip Never consider using this function if you are dealing with filesystem
+ * @note Never consider using this function if you are dealing with filesystem
* names that need to remain canonical, unless you are merging an apr_dir_read
* path and returned filename. Otherwise, the result is not canonical.
*/
@@ -1469,7 +1540,7 @@
* Test if the given path has an an absolute path.
* @param p The pool to allocate from
* @param dir The directory name
- * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
+ * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
* multiple forms of absolute paths. This only reports if the path is absolute
* in a canonical sense.
*/
@@ -1491,6 +1562,7 @@
* @return 1 if the two strings match, 0 otherwise
*/
AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
+
/**
* Determine if a string matches a patterm containing the wildcards '?' or '*',
* ignoring case
@@ -1529,27 +1601,26 @@
/**
* Encode a string into memory allocated from a pool in base 64 format
* @param p The pool to allocate from
- * @param strin The plaintext string
+ * @param string The plaintext string
* @return The encoded string
*/
AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string);
-
/**
* Compile a regular expression to be used later
* @param p The pool to allocate from
* @param pattern the regular expression to compile
* @param cflags The bitwise or of one or more of the following:
- * @li #REG_EXTENDED - Use POSIX extended Regular Expressions
- * @li #REG_ICASE - Ignore case
- * @li #REG_NOSUB - Support for substring addressing of matches
+ * @li REG_EXTENDED - Use POSIX extended Regular Expressions
+ * @li REG_ICASE - Ignore case
+ * @li REG_NOSUB - Support for substring addressing of matches
* not required
- * @li #REG_NEWLINE - Match-any-character operators don't match new-line
+ * @li REG_NEWLINE - Match-any-character operators don't match new-line
* @return The compiled regular expression
*/
AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
int cflags);
-
+
/**
* Free the memory associated with a compiled regular expression
* @param p The pool the regex was allocated from
@@ -1647,7 +1718,9 @@
AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
__attribute__((noreturn));
-/** @internal */
+/**
+ * @internal Internal Assert function
+ */
#define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
/**
@@ -1657,7 +1730,6 @@
* Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
* is defined.
*/
-
#ifdef AP_DEBUG
#define AP_DEBUG_ASSERT(exp) ap_assert(exp)
#else
@@ -1665,7 +1737,7 @@
#endif
/**
- * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
+ * @defgroup stopsignal Flags which indicate places where the sever should stop for debugging.
* @{
* A set of flags which indicate places where the server should raise(SIGSTOP).
* This is useful for debugging, because you can then attach to that process
@@ -1756,3 +1828,8 @@
#endif
#endif /* !APACHE_HTTPD_H */
+
+/** @} //APACHE Daemon */
+/** @} //APACHE Core */
+/** @} //APACHE super group */
+
Modified: httpd/httpd/trunk/include/mpm_common.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/mpm_common.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/mpm_common.h (original)
+++ httpd/httpd/trunk/include/mpm_common.h Sun Aug 28 16:03:59 2005
@@ -25,6 +25,15 @@
* does not belong in src/os/unix
*/
+/**
+ * @file mpm_common.h
+ * @brief Multi-Processing Modules functions
+ *
+ * @defgroup APACHE_MPM Multi-Processing Modules
+ * @ingroup APACHE
+ * @{
+ */
+
#ifndef APACHE_MPM_COMMON_H
#define APACHE_MPM_COMMON_H
@@ -40,10 +49,6 @@
extern "C" {
#endif
-/**
- * @package Multi-Processing Modules functions
- */
-
/* The maximum length of the queue of pending connections, as defined
* by listen(2). Under some systems, it should be increased if you
* are experiencing a heavy TCP SYN flood attack.
@@ -348,3 +353,4 @@
#endif
#endif /* !APACHE_MPM_COMMON_H */
+/** @} */
Modified: httpd/httpd/trunk/include/scoreboard.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/scoreboard.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/scoreboard.h (original)
+++ httpd/httpd/trunk/include/scoreboard.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,11 @@
* limitations under the License.
*/
+/**
+ * @file scoreboard.h
+ * @brief Apache scoreboard library
+ */
+
#ifndef APACHE_SCOREBOARD_H
#define APACHE_SCOREBOARD_H
Modified: httpd/httpd/trunk/include/util_cfgtree.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_cfgtree.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_cfgtree.h (original)
+++ httpd/httpd/trunk/include/util_cfgtree.h Sun Aug 28 16:03:59 2005
@@ -14,19 +14,26 @@
* limitations under the License.
*/
+/**
+ * @file util_cfgtree.h
+ * @brief Config Tree Package
+ *
+ * @defgroup APACHE_CORE_CONFIG_TREE Config Tree Package
+ * @ingroup APACHE_CORE_CONFIG
+ * @{
+ */
+
#ifndef AP_CONFTREE_H
#define AP_CONFTREE_H
#include "ap_config.h"
-/**
- * @package Config Tree Package
- */
-
typedef struct ap_directive_t ap_directive_t;
/**
- * Structure used to build the config tree. The config tree only stores
+ * @brief Structure used to build the config tree.
+ *
+ * The config tree only stores
* the directives that will be active in the running server. Directives
* that contain other directions, such as <Directory ...> cause a sub-level
* to be created, where the included directives are stored. The closing
@@ -77,3 +84,4 @@
ap_directive_t *toadd, int child);
#endif
+/** @} */
Modified: httpd/httpd/trunk/include/util_charset.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_charset.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_charset.h (original)
+++ httpd/httpd/trunk/include/util_charset.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_charset.h
+ * @brief charset conversion
+ *
+ * @defgroup APACHE_CORE_CHARSET Charset Conversion
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef APACHE_UTIL_CHARSET_H
#define APACHE_UTIL_CHARSET_H
@@ -21,9 +30,6 @@
extern "C" {
#endif
-/**
- * @package charset conversion
- */
#include "apr.h"
#if APR_CHARSET_EBCDIC
@@ -46,3 +52,4 @@
#endif
#endif /* !APACHE_UTIL_CHARSET_H */
+/** @} */
Modified: httpd/httpd/trunk/include/util_ebcdic.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_ebcdic.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_ebcdic.h (original)
+++ httpd/httpd/trunk/include/util_ebcdic.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_ebcdic.h
+ * @brief Utilities for EBCDIC conversion
+ *
+ * @defgroup APACHE_CORE_EBCDIC Utilities for EBCDIC conversion
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef APACHE_UTIL_EBCDIC_H
#define APACHE_UTIL_EBCDIC_H
@@ -26,10 +35,6 @@
#include "httpd.h"
#include "util_charset.h"
-/**
- * @package Utilities for EBCDIC conversion
- */
-
#if APR_CHARSET_EBCDIC
/**
@@ -76,3 +81,4 @@
#endif
#endif /* !APACHE_UTIL_EBCDIC_H */
+/** @} */
Modified: httpd/httpd/trunk/include/util_filter.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_filter.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_filter.h (original)
+++ httpd/httpd/trunk/include/util_filter.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,11 @@
* limitations under the License.
*/
+/**
+ * @file util_filter.h
+ * @brief Apache filter library
+ */
+
#ifndef AP_FILTER_H
#define AP_FILTER_H
@@ -30,11 +35,6 @@
extern "C" {
#endif
-/**
- * @file util_filter.h
- * @brief Apache filter library
- */
-
/** Returned by the bottom-most filter if no data was written.
* @see ap_pass_brigade(). */
#define AP_NOBODY_WROTE -1
@@ -45,7 +45,7 @@
#define AP_FILTER_ERROR -3
/**
- * input filtering modes
+ * @brief input filtering modes
*/
typedef enum {
/** The filter should return at most readbytes data. */
@@ -72,7 +72,8 @@
} ap_input_mode_t;
/**
- * @defgroup filter FILTER CHAIN
+ * @defgroup APACHE_CORE_FILTER Filter Chain
+ * @ingroup APACHE_CORE
*
* Filters operate using a "chaining" mechanism. The filters are chained
* together into a sequence. When output is generated, it is passed through
@@ -201,7 +202,7 @@
typedef struct ap_filter_provider_t ap_filter_provider_t;
/**
- * This structure is used for recording information about the
+ * @brief This structure is used for recording information about the
* registered filters. It associates a name with the filter's callback
* and filter type.
*
@@ -248,7 +249,9 @@
};
/**
- * The representation of a filter chain. Each request has a list
+ * @brief The representation of a filter chain.
+ *
+ * Each request has a list
* of these structures which are called in turn to filter the data. Sub
* requests get an exact copy of the main requests filter chain.
*/
Modified: httpd/httpd/trunk/include/util_ldap.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_ldap.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_ldap.h (original)
+++ httpd/httpd/trunk/include/util_ldap.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,11 @@
* limitations under the License.
*/
+/**
+ * @file util_ldap.h
+ * @brief Apache LDAP library
+ */
+
#ifndef UTIL_LDAP_H
#define UTIL_LDAP_H
Modified: httpd/httpd/trunk/include/util_md5.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_md5.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_md5.h (original)
+++ httpd/httpd/trunk/include/util_md5.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_md5.h
+ * @brief Apache MD5 library
+ *
+ * @defgroup APACHE_CORE_MD5 MD5 Package Library
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef APACHE_UTIL_MD5_H
#define APACHE_UTIL_MD5_H
@@ -21,10 +30,6 @@
extern "C" {
#endif
-/**
- * @package Apache MD5 library
- */
-
#include "apr_md5.h"
/**
@@ -68,3 +73,4 @@
#endif
#endif /* !APACHE_UTIL_MD5_H */
+/** @} */
Modified: httpd/httpd/trunk/include/util_script.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_script.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_script.h (original)
+++ httpd/httpd/trunk/include/util_script.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_script.h
+ * @brief Apache script tools
+ *
+ * @defgroup APACHE_CORE_SCRIPT Script Tools
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef APACHE_UTIL_SCRIPT_H
#define APACHE_UTIL_SCRIPT_H
@@ -23,10 +32,6 @@
extern "C" {
#endif
-/**
- * @package Apache script tools
- */
-
#ifndef APACHE_ARG_MAX
#ifdef _POSIX_ARG_MAX
#define APACHE_ARG_MAX _POSIX_ARG_MAX
@@ -140,3 +145,4 @@
#endif
#endif /* !APACHE_UTIL_SCRIPT_H */
+/** @} */
Modified: httpd/httpd/trunk/include/util_time.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_time.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_time.h (original)
+++ httpd/httpd/trunk/include/util_time.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_time.h
+ * @brief Apache date-time handling functions
+ *
+ * @defgroup APACHE_CORE_TIME Date-time handling functions
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef APACHE_UTIL_TIME_H
#define APACHE_UTIL_TIME_H
@@ -25,10 +34,6 @@
extern "C" {
#endif
-/**
- * @package Apache date-time handling functions
- */
-
/* Maximum delta from the current time, in seconds, for a past time
* to qualify as "recent" for use in the ap_explode_recent_*() functions:
* (Must be a power of two minus one!)
@@ -83,3 +88,4 @@
#endif
#endif /* !APACHE_UTIL_TIME_H */
+/** @} */
Modified: httpd/httpd/trunk/include/util_xml.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/include/util_xml.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_xml.h (original)
+++ httpd/httpd/trunk/include/util_xml.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file util_xml.h
+ * @brief Apache XML library
+ *
+ * @defgroup APACHE_CORE_XML XML Library
+ * @ingroup APACHE_CORE
+ * @{
+ */
+
#ifndef UTIL_XML_H
#define UTIL_XML_H
@@ -26,10 +35,6 @@
#endif
/**
- * @package Apache XML library
- */
-
-/**
* Get XML post data and parse it
* @param r The current request
* @param pdoc The XML post data
@@ -44,3 +49,4 @@
#endif
#endif /* UTIL_XML_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/aaa/mod_auth.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/aaa/mod_auth.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/aaa/mod_auth.h (original)
+++ httpd/httpd/trunk/modules/aaa/mod_auth.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file mod_auth.h
+ * @brief uthentication Extension Module for Apache
+ *
+ * @defgroup MOD_AUTH mod_auth
+ * @ingroup APACHE_MODS
+ */
+
#ifndef APACHE_MOD_AUTH_H
#define APACHE_MOD_AUTH_H
Modified: httpd/httpd/trunk/modules/arch/win32/mod_isapi.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/arch/win32/mod_isapi.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/arch/win32/mod_isapi.h (original)
+++ httpd/httpd/trunk/modules/arch/win32/mod_isapi.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_isapi.h
+ * @brief ISAPI module extension to Apache
+ *
+ * @defgroup MOD_ISAPI mod_isapi
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_ISAPI_H
#define MOD_ISAPI_H
@@ -258,3 +267,5 @@
#endif
#endif /* !MOD_ISAPI_H */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/cache/cache_cache.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/cache/cache_cache.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/cache/cache_cache.h (original)
+++ httpd/httpd/trunk/modules/cache/cache_cache.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file cache_cache.h
+ * @brief Cache Cache Functions
+ *
+ * @defgroup Cache_cache Cache Functions
+ * @ingroup MOD_CACHE
+ * @{
+ */
+
#ifndef CACHE_CACHE_H
#define CACHE_CACHE_H
@@ -23,16 +32,6 @@
#include "mod_cache.h"
-/**
- * @file cache_hash.h
- * @brief Cache Cache Functions
- */
-
-/**
- * @defgroup Cache_cache Cache Functions
- * @ingroup CACHE
- * @{
- */
/** ADT for the cache */
typedef struct cache_cache_t cache_cache_t;
@@ -104,9 +103,9 @@
* @param entry the actual entry (from a find)
*/
CACHE_DECLARE(apr_status_t) cache_remove(cache_cache_t* c, void *entry);
-/** @} */
#ifdef __cplusplus
}
#endif
#endif /* !CACHE_CACHE_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/cache/cache_hash.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/cache/cache_hash.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/cache/cache_hash.h (original)
+++ httpd/httpd/trunk/modules/cache/cache_hash.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file cache_hash.h
+ * @brief Cache Hash Tables
+ *
+ * @defgroup Cache_Hash Hash Tables
+ * @ingroup MOD_CACHE
+ * @{
+ */
+
#ifndef CACHE_HASH_H
#define CACHE_HASH_H
@@ -22,17 +31,6 @@
#endif
#include "mod_cache.h"
-
-/**
- * @file cache_hash.h
- * @brief Cache Hash Tables
- */
-
-/**
- * @defgroup Cache_Hash Hash Tables
- * @ingroup CACHE
- * @{
- */
/**
* When passing a key to cache_hash_set or cache_hash_get, this value can be
Modified: httpd/httpd/trunk/modules/cache/cache_pqueue.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/cache/cache_pqueue.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/cache/cache_pqueue.h (original)
+++ httpd/httpd/trunk/modules/cache/cache_pqueue.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file cache_pqueue.h
+ * @brief Cache Priority Queue function declarations
+ *
+ * @defgroup MOD_CACHE_QUEUE Priority Queue
+ * @ingroup MOD_CACHE
+ * @{
+ */
+
#ifndef CACHE_PQUEUE_H
#define CACHE_PQUEUE_H
@@ -158,3 +167,4 @@
#endif
#endif /* !CACHE_PQUEUE_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/cache/mod_cache.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/cache/mod_cache.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/cache/mod_cache.h (original)
+++ httpd/httpd/trunk/modules/cache/mod_cache.h Sun Aug 28 16:03:59 2005
@@ -14,13 +14,18 @@
* limitations under the License.
*/
+/**
+ * @file mod_cache.h
+ * @brief Main include file for the Apache Transparent Cache
+ *
+ * @defgroup MOD_CACHE mod_cache
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_CACHE_H
#define MOD_CACHE_H
-/*
- * Main include file for the Apache Transparent Cache
- */
-
#define CORE_PRIVATE
#include "apr_hooks.h"
@@ -319,3 +324,4 @@
#endif /*MOD_CACHE_H*/
+/** @} */
Modified: httpd/httpd/trunk/modules/dav/fs/repos.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/dav/fs/repos.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/dav/fs/repos.h (original)
+++ httpd/httpd/trunk/modules/dav/fs/repos.h Sun Aug 28 16:03:59 2005
@@ -14,9 +14,13 @@
* limitations under the License.
*/
-/*
-** Declarations for the filesystem repository implementation
-*/
+/**
+ * @file repos.h
+ * @brief Declarations for the filesystem repository implementation
+ *
+ * @addtogroup MOD_DAV
+ * @{
+ */
#ifndef _DAV_FS_REPOS_H_
#define _DAV_FS_REPOS_H_
@@ -76,3 +80,5 @@
void dav_fs_register(apr_pool_t *p);
#endif /* _DAV_FS_REPOS_H_ */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/dav/lock/locks.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/dav/lock/locks.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/dav/lock/locks.h (original)
+++ httpd/httpd/trunk/modules/dav/lock/locks.h Sun Aug 28 16:03:59 2005
@@ -14,9 +14,13 @@
* limitations under the License.
*/
-/*
-** Declarations for the generic lock implementation
-*/
+/**
+ * @file locks.h
+ * @brief Declarations for the generic lock implementation
+ *
+ * @addtogroup MOD_DAV
+ * @{
+ */
#ifndef _DAV_LOCK_LOCKS_H_
#define _DAV_LOCK_LOCKS_H_
@@ -25,3 +29,5 @@
const char *dav_generic_get_lockdb_path(const request_rec *r);
#endif /* _DAV_LOCK_LOCKS_H_ */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/dav/main/mod_dav.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/dav/main/mod_dav.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/dav/main/mod_dav.h (original)
+++ httpd/httpd/trunk/modules/dav/main/mod_dav.h Sun Aug 28 16:03:59 2005
@@ -14,9 +14,14 @@
* limitations under the License.
*/
-/*
-** DAV extension module for Apache 2.0.*
-*/
+/**
+ * @file mod_dav.h
+ * @brief DAV extension module for Apache 2.0.*
+ *
+ * @defgroup MOD_DAV mod_dav
+ * @ingroup APACHE_MODS
+ * @{
+ */
#ifndef _MOD_DAV_H_
#define _MOD_DAV_H_
@@ -2418,3 +2423,5 @@
#endif
#endif /* _MOD_DAV_H_ */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/experimental/mod_dbd.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/experimental/mod_dbd.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/experimental/mod_dbd.h (original)
+++ httpd/httpd/trunk/modules/experimental/mod_dbd.h Sun Aug 28 16:03:59 2005
@@ -15,11 +15,20 @@
* limitations under the License.
*/
-/* Overview of what this is and does:
+/**
+ * @file mod_dbd.h
+ * @brief Database Acces Extension Module for Apache
+ *
+ * Overview of what this is and does:
* http://www.apache.org/~niq/dbd.html
* or
* http://apache.webthing.com/database/
+ *
+ * @defgroup MOD_DBD mod_dbd
+ * @ingroup APACHE_MODS
+ * @{
*/
+
#ifndef DBD_H
#define DBD_H
@@ -59,3 +68,5 @@
APR_DECLARE_OPTIONAL_FN(void, ap_dbd_prepare, (server_rec*, const char*, const char*));
#endif
+/** @} */
+
Modified: httpd/httpd/trunk/modules/experimental/mod_filter.c
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/experimental/mod_filter.c?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/experimental/mod_filter.c (original)
+++ httpd/httpd/trunk/modules/experimental/mod_filter.c Sun Aug 28 16:03:59 2005
@@ -42,8 +42,9 @@
module AP_MODULE_DECLARE_DATA filter_module;
/**
- * ap_filter_provider_t is a filter provider, as defined and implemented
- * by mod_filter. The struct is a linked list, with dispatch criteria
+ * @brief is a filter provider, as defined and implemented by mod_filter.
+ *
+ * The struct is a linked list, with dispatch criteria
* defined for each filter. The provider implementation itself is a
* (2.0-compatible) ap_filter_rec_t* frec.
*/
Modified: httpd/httpd/trunk/modules/filters/mod_include.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/filters/mod_include.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/filters/mod_include.h (original)
+++ httpd/httpd/trunk/modules/filters/mod_include.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_include.h
+ * @brief Server Side Include Filter Extension Module for Apache
+ *
+ * @defgroup MOD_INCLUDE mod_include
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef _MOD_INCLUDE_H
#define _MOD_INCLUDE_H 1
@@ -104,3 +113,4 @@
(char *tag, include_handler_fn_t *func));
#endif /* MOD_INCLUDE */
+/** @} */
Modified: httpd/httpd/trunk/modules/generators/mod_cgi.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/generators/mod_cgi.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/generators/mod_cgi.h (original)
+++ httpd/httpd/trunk/modules/generators/mod_cgi.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_cgi.h
+ * @brief CGI Script Execution Extension Module for Apache
+ *
+ * @defgroup MOD_CGI mod_cgi
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef _MOD_CGI_H
#define _MOD_CGI_H 1
@@ -57,3 +66,5 @@
cgi_exec_info_t *e_info));
#endif /* _MOD_CGI_H */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/generators/mod_status.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/generators/mod_status.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/generators/mod_status.h (original)
+++ httpd/httpd/trunk/modules/generators/mod_status.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_status.h
+ * @brief Status Report Extension Module to Apache
+ *
+ * @defgroup MOD_STATUS mod_status
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_STATUS_H
#define MOD_STATUS_H
@@ -52,3 +61,4 @@
APR_DECLARE_EXTERNAL_HOOK(ap, STATUS, int, status_hook,
(request_rec *r, int flags))
#endif
+/** @} */
Modified: httpd/httpd/trunk/modules/generators/mod_suexec.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/generators/mod_suexec.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/generators/mod_suexec.h (original)
+++ httpd/httpd/trunk/modules/generators/mod_suexec.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_suexec.h
+ * @brief SuExec Extension Module for Apache
+ *
+ * @defgroup MOD_SUEXEC mod_suexec
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#include "unixd.h"
typedef struct {
@@ -21,3 +30,4 @@
int active;
} suexec_config_t;
+/** @}*/
Modified: httpd/httpd/trunk/modules/http/mod_core.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/http/mod_core.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/http/mod_core.h (original)
+++ httpd/httpd/trunk/modules/http/mod_core.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,16 @@
* limitations under the License.
*/
+
+/**
+ * @file mod_core.h
+ * @brief mod_core private header file
+ *
+ * @defgroup MOD_CORE mod_core
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_CORE_H
#define MOD_CORE_H
@@ -28,10 +38,6 @@
extern "C" {
#endif
-/**
- * @package mod_core private header file
- */
-
/* Handles for core filters */
extern AP_DECLARE_DATA ap_filter_rec_t *ap_http_input_filter_handle;
extern AP_DECLARE_DATA ap_filter_rec_t *ap_http_header_filter_handle;
@@ -81,3 +87,4 @@
#endif
#endif /* !MOD_CORE_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/ldap/util_ldap_cache.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ldap/util_ldap_cache.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ldap/util_ldap_cache.h (original)
+++ httpd/httpd/trunk/modules/ldap/util_ldap_cache.h Sun Aug 28 16:03:59 2005
@@ -17,8 +17,9 @@
#ifndef APU_LDAP_CACHE_H
#define APU_LDAP_CACHE_H
-/*
- * This switches LDAP support on or off.
+/**
+ * @file util_ldap_cache.h
+ * @brief This switches LDAP support on or off.
*/
/* this whole thing disappears if LDAP is not enabled */
Modified: httpd/httpd/trunk/modules/loggers/mod_log_config.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/loggers/mod_log_config.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/loggers/mod_log_config.h (original)
+++ httpd/httpd/trunk/modules/loggers/mod_log_config.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_log_config.h
+ * @brief Logging Configuration Extension Module for Apache
+ *
+ * @defgroup MOD_LOG_CONFIG mod_log_config
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#include "apr_optional.h"
#include "httpd.h"
#include "scoreboard.h"
@@ -61,3 +70,5 @@
APR_DECLARE_OPTIONAL_FN(ap_log_writer*, ap_log_set_writer, (ap_log_writer* func));
#endif /* MOD_LOG_CONFIG */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/mappers/mod_rewrite.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/mappers/mod_rewrite.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/mappers/mod_rewrite.h (original)
+++ httpd/httpd/trunk/modules/mappers/mod_rewrite.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_rewrite.h
+ * @brief Rewrite Extension module for Apache
+ *
+ * @defgroup MOD_REWRITE mod_rewrite
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_REWRITE_H
#define MOD_REWRITE_H 1
@@ -28,3 +37,4 @@
(char *name, rewrite_mapfunc_t *func));
#endif /* MOD_REWRITE_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/mappers/mod_so.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/mappers/mod_so.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/mappers/mod_so.h (original)
+++ httpd/httpd/trunk/modules/mappers/mod_so.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file mod_so.h
+ * @brief Shared Object Loader Extension Module for Apache
+ *
+ * @defgroup MOD_SO mod_so
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef MOD_SO_H
#define MOD_SO_H 1
@@ -25,4 +34,5 @@
(server_rec *s, const char *modname));
#endif /* MOD_SO_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/proxy/ajp.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/proxy/ajp.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/proxy/ajp.h (original)
+++ httpd/httpd/trunk/modules/proxy/ajp.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file ajp.h
+ * @brief Apache Jserv Protocol
+ *
+ * @defgroup AJP_defines AJP definitions
+ * @ingroup MOD_PROXY
+ * @{
+ */
+
#ifndef AJP_H
#define AJP_H
@@ -126,10 +135,6 @@
};
/**
- * @defgroup AJP_defines AJP definitions
- * @{
- */
-/**
* Signature for the messages sent from Apache to tomcat
*/
#define AJP13_WS_HEADER 0x1234
@@ -161,6 +166,7 @@
/**
* @defgroup AJP_api AJP API functions
+ * @ingroup MOD_PROXY
* @{
*/
/**
Modified: httpd/httpd/trunk/modules/proxy/ajp_header.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/proxy/ajp_header.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/proxy/ajp_header.h (original)
+++ httpd/httpd/trunk/modules/proxy/ajp_header.h Sun Aug 28 16:03:59 2005
@@ -13,6 +13,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+/**
+ * @file ajp_header.h
+ * @brief AJP defines
+ *
+ * @addtogroup AJP_defines
+ * @{
+ */
+
#ifndef AJP_HEADER_H
#define AJP_HEADER_H
@@ -163,3 +172,4 @@
#define SC_RES_HEADERS_NUM 11
#endif /* AJP_HEADER_H */
+/** @} */
Modified: httpd/httpd/trunk/modules/proxy/mod_proxy.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/proxy/mod_proxy.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/proxy/mod_proxy.h (original)
+++ httpd/httpd/trunk/modules/proxy/mod_proxy.h Sun Aug 28 16:03:59 2005
@@ -17,8 +17,13 @@
#ifndef MOD_PROXY_H
#define MOD_PROXY_H
-/*
- * Main include file for the Apache proxy
+/**
+ * @file mod_proxy.h
+ * @brief Proxy Extension Module for Apache
+ *
+ * @defgroup MOD_PROXY mod_proxy
+ * @ingroup APACHE_MODS
+ * @{
*/
/*
@@ -696,3 +701,4 @@
extern int PROXY_DECLARE_DATA proxy_lb_workers;
#endif /*MOD_PROXY_H*/
+/** @} */
Modified: httpd/httpd/trunk/modules/ssl/mod_ssl.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ssl/mod_ssl.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ssl/mod_ssl.h (original)
+++ httpd/httpd/trunk/modules/ssl/mod_ssl.h Sun Aug 28 16:03:59 2005
@@ -14,20 +14,29 @@
* limitations under the License.
*/
+/**
+ * @file mod_ssl.h
+ * @brief SSL extension module for Apache
+ *
+ * @defgroup MOD_SSL mod_ssl
+ * @ingroup APACHE_MODS
+ * @{
+ */
+
#ifndef __MOD_SSL_H__
#define __MOD_SSL_H__
#include "httpd.h"
#include "apr_optional.h"
-/* The ssl_var_lookup() optional function retrieves SSL environment
+/** The ssl_var_lookup() optional function retrieves SSL environment
* variables. */
APR_DECLARE_OPTIONAL_FN(char *, ssl_var_lookup,
(apr_pool_t *, server_rec *,
conn_rec *, request_rec *,
char *));
-/* The ssl_ext_lookup() optional function retrieves the value of a SSL
+/** The ssl_ext_lookup() optional function retrieves the value of a SSL
* certificate X.509 extension. The client certificate is used if
* peer is non-zero; the server certificate is used otherwise. The
* oidnum parameter specifies the numeric OID (e.g. "1.2.3.4") of the
@@ -37,11 +46,11 @@
(apr_pool_t *p, conn_rec *c, int peer,
const char *oidnum));
-/* An optional function which returns non-zero if the given connection
+/** An optional function which returns non-zero if the given connection
* is using SSL/TLS. */
APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
-/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
+/** The ssl_proxy_enable() and ssl_engine_disable() optional functions
* are used by mod_proxy to enable use of SSL for outgoing
* connections. */
@@ -52,3 +61,4 @@
APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, ssl_extlist_by_oid, (request_rec *r, const char *oidstr));
#endif /* __MOD_SSL_H__ */
+/** @} */
Modified: httpd/httpd/trunk/modules/ssl/ssl_expr.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ssl/ssl_expr.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ssl/ssl_expr.h (original)
+++ httpd/httpd/trunk/modules/ssl/ssl_expr.h Sun Aug 28 16:03:59 2005
@@ -14,16 +14,23 @@
* limitations under the License.
*/
-/* _ _
- * _ __ ___ ___ __| | ___ ___| | mod_ssl
- * | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
- * | | | | | | (_) | (_| | \__ \__ \ |
- * |_| |_| |_|\___/ \__,_|___|___/___/_|
- * |_____|
- * ssl_expr.h
- * Expression Handling (Header)
+/**
+ * @verbatim
+ _ _
+ _ __ ___ ___ __| | ___ ___| | mod_ssl
+ | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
+ | | | | | | (_) | (_| | \__ \__ \ |
+ |_| |_| |_|\___/ \__,_|___|___/___/_|
+ |_____|
+ @endverbatim
+ * @file ssl_expr.h
+ * @brief Expression Handling (Header).
+ * ``May all your PUSHes be POPed.''
+ *
+ * @defgroup MOD_SSL_EXPR Expression Handling
+ * @ingroup MOD_SSL
+ * @{
*/
- /* ``May all your PUSHes be POPed.'' */
#ifndef __SSL_EXPR_H__
#define __SSL_EXPR_H__
@@ -102,3 +109,5 @@
extern BOOL ssl_expr_eval(request_rec *, ssl_expr *);
#endif /* __SSL_EXPR_H__ */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/ssl/ssl_private.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ssl/ssl_private.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ssl/ssl_private.h (original)
+++ httpd/httpd/trunk/modules/ssl/ssl_private.h Sun Aug 28 16:03:59 2005
@@ -17,11 +17,16 @@
#ifndef SSL_PRIVATE_H
#define SSL_PRIVATE_H
-/*
- * Internal interfaces private to mod_ssl.
+/**
+ * @file ssl_private.h
+ * @brief Internal interfaces private to mod_ssl.
+ *
+ * @defgroup MOD_SSL_PRIVATE Private
+ * @ingroup MOD_SSL
+ * @{
*/
-/* Apache headers */
+/** Apache headers */
#include "httpd.h"
#include "http_config.h"
#include "http_core.h"
@@ -50,22 +55,22 @@
#define MOD_SSL_VERSION AP_SERVER_BASEREVISION
-/* mod_ssl headers */
+/** mod_ssl headers */
#include "ssl_toolkit_compat.h"
#include "ssl_expr.h"
#include "ssl_util_ssl.h"
-/* The #ifdef macros are only defined AFTER including the above
+/** The #ifdef macros are only defined AFTER including the above
* therefore we cannot include these system files at the top :-(
*/
#if APR_HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#if APR_HAVE_UNISTD_H
-#include <unistd.h> /* needed for STDIN_FILENO et.al., at least on FreeBSD */
+#include <unistd.h> /** needed for STDIN_FILENO et.al., at least on FreeBSD */
#endif
-/*
+/**
* Provide reasonable default for some defines
*/
#ifndef FALSE
@@ -91,7 +96,7 @@
#define RAND_MAX INT_MAX
#endif
-/*
+/**
* Provide reasonable defines for some types
*/
#ifndef BOOL
@@ -101,7 +106,7 @@
#define UCHAR unsigned char
#endif
-/*
+/**
* Provide useful shorthands
*/
#define strEQ(s1,s2) (strcmp(s1,s2) == 0)
@@ -128,19 +133,19 @@
#define myCtxVarSet(mc,num,val) mc->rCtx.pV##num = val
#define myCtxVarGet(mc,num,type) (type)(mc->rCtx.pV##num)
-/*
+/**
* Defaults for the configuration
*/
#ifndef SSL_SESSION_CACHE_TIMEOUT
#define SSL_SESSION_CACHE_TIMEOUT 300
#endif
-/*
+/**
* Support for MM library
*/
#define SSL_MM_FILE_MODE ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD )
-/*
+/**
* Support for DBM library
*/
#define SSL_DBM_FILE_MODE ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD )
@@ -158,7 +163,7 @@
#endif
#endif
-/*
+/**
* Define the certificate algorithm types
*/
@@ -174,7 +179,7 @@
#define SSL_AIDX_MAX (2)
-/*
+/**
* Define IDs for the temporary RSA keys and DH params
*/
@@ -184,7 +189,7 @@
#define SSL_TMP_KEY_DH_1024 (3)
#define SSL_TMP_KEY_MAX (4)
-/*
+/**
* Define the SSL options
*/
#define SSL_OPT_NONE (0)
@@ -197,7 +202,7 @@
#define SSL_OPT_ALL (SSL_OPT_STDENVVARS|SSL_OPT_EXPORTCERTDATA|SSL_OPT_FAKEBASICAUTH|SSL_OPT_STRICTREQUIRE|SSL_OPT_OPTRENEGOTIATE)
typedef int ssl_opt_t;
-/*
+/**
* Define the SSL Protocol options
*/
#define SSL_PROTOCOL_NONE (0)
@@ -207,7 +212,7 @@
#define SSL_PROTOCOL_ALL (SSL_PROTOCOL_SSLV2|SSL_PROTOCOL_SSLV3|SSL_PROTOCOL_TLSV1)
typedef int ssl_proto_t;
-/*
+/**
* Define the SSL verify levels
*/
typedef enum {
@@ -232,7 +237,7 @@
|| (errnum == X509_V_ERR_CERT_UNTRUSTED) \
|| (errnum == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE))
-/*
+/**
* Define the SSL pass phrase dialog types
*/
typedef enum {
@@ -242,7 +247,7 @@
SSL_PPTYPE_PIPE = 2
} ssl_pphrase_t;
-/*
+/**
* Define the Path Checking modes
*/
#define SSL_PCM_EXISTS 1
@@ -251,7 +256,7 @@
#define SSL_PCM_ISNONZERO 8
typedef unsigned int ssl_pathcheck_t;
-/*
+/**
* Define the SSL session cache modes and structures
*/
typedef enum {
@@ -263,7 +268,7 @@
SSL_SCMODE_NONE_NOT_NULL = 5
} ssl_scmode_t;
-/*
+/**
* Define the SSL mutex modes
*/
typedef enum {
@@ -272,7 +277,7 @@
SSL_MUTEXMODE_USED = 1
} ssl_mutexmode_t;
-/*
+/**
* Define the SSL enabled state
*/
typedef enum {
@@ -282,7 +287,7 @@
SSL_ENABLED_OPTIONAL = 3
} ssl_enabled_t;
-/*
+/**
* Define the SSL requirement structure
*/
typedef struct {
@@ -290,7 +295,7 @@
ssl_expr *mpExpr;
} ssl_require_t;
-/*
+/**
* Define the SSL random number generator seeding source
*/
typedef enum {
@@ -310,7 +315,7 @@
int nBytes;
} ssl_randseed_t;
-/*
+/**
* Define the structure of an ASN.1 anything
*/
typedef struct {
@@ -319,7 +324,7 @@
apr_time_t source_mtime;
} ssl_asn1_t;
-/*
+/**
* Define the mod_ssl per-module configuration structure
* (i.e. the global configuration for each httpd process)
*/
@@ -371,9 +376,9 @@
} rCtx;
} SSLModConfigRec;
-/* public cert/private key */
+/** public cert/private key */
typedef struct {
- /*
+ /**
* server only has 1-2 certs/keys
* 1 RSA and/or 1 DSA
*/
@@ -382,28 +387,28 @@
X509 *certs[SSL_AIDX_MAX];
EVP_PKEY *keys[SSL_AIDX_MAX];
- /* Certificates which specify the set of CA names which should be
+ /** Certificates which specify the set of CA names which should be
* sent in the CertificateRequest message: */
const char *ca_name_path;
const char *ca_name_file;
} modssl_pk_server_t;
typedef struct {
- /* proxy can have any number of cert/key pairs */
+ /** proxy can have any number of cert/key pairs */
const char *cert_file;
const char *cert_path;
STACK_OF(X509_INFO) *certs;
} modssl_pk_proxy_t;
-/* stuff related to authentication that can also be per-dir */
+/** stuff related to authentication that can also be per-dir */
typedef struct {
- /* known/trusted CAs */
+ /** known/trusted CAs */
const char *ca_cert_path;
const char *ca_cert_file;
const char *cipher_suite;
- /* for client or downstream server authentication */
+ /** for client or downstream server authentication */
int verify_depth;
ssl_verify_t verify_mode;
} modssl_auth_ctx_t;
@@ -411,22 +416,22 @@
typedef struct SSLSrvConfigRec SSLSrvConfigRec;
typedef struct {
- SSLSrvConfigRec *sc; /* pointer back to server config */
+ SSLSrvConfigRec *sc; /** pointer back to server config */
SSL_CTX *ssl_ctx;
- /* we are one or the other */
+ /** we are one or the other */
modssl_pk_server_t *pks;
modssl_pk_proxy_t *pkp;
ssl_proto_t protocol;
- /* config for handling encrypted keys */
+ /** config for handling encrypted keys */
ssl_pphrase_t pphrase_dialog_type;
const char *pphrase_dialog_path;
const char *cert_chain;
- /* certificate revocation list */
+ /** certificate revocation list */
const char *crl_path;
const char *crl_file;
X509_STORE *crl;
@@ -446,7 +451,7 @@
modssl_ctx_t *proxy;
};
-/*
+/**
* Define the mod_ssl per-directory configuration structure
* (i.e. the local configuration for all <Directory>
* and .htaccess contexts)
@@ -465,17 +470,17 @@
const char *szUserName;
} SSLDirConfigRec;
-/*
+/**
* function prototypes
*/
-/* API glue structures */
+/** API glue structures */
extern module AP_MODULE_DECLARE_DATA ssl_module;
-/* "global" stuff */
+/** "global" stuff */
extern const char ssl_valid_ssl_mutex_string[];
-/* configuration handling */
+/** configuration handling */
SSLModConfigRec *ssl_config_global_create(server_rec *);
void ssl_config_global_fix(SSLModConfigRec *);
BOOL ssl_config_global_isfixed(SSLModConfigRec *);
@@ -521,7 +526,7 @@
const char *ssl_cmd_SSLProxyMachineCertificatePath(cmd_parms *, void *, const char *);
const char *ssl_cmd_SSLProxyMachineCertificateFile(cmd_parms *, void *, const char *);
-/* module initialization */
+/** module initialization */
int ssl_init_Module(apr_pool_t *, apr_pool_t *, apr_pool_t *, server_rec *);
void ssl_init_Engine(server_rec *, apr_pool_t *);
void ssl_init_ConfigureServer(server_rec *, apr_pool_t *, apr_pool_t *, SSLSrvConfigRec *);
@@ -531,7 +536,7 @@
void ssl_init_Child(apr_pool_t *, server_rec *);
apr_status_t ssl_init_ModuleKill(void *data);
-/* Apache API hooks */
+/** Apache API hooks */
int ssl_hook_Auth(request_rec *);
int ssl_hook_UserCheck(request_rec *);
int ssl_hook_Access(request_rec *);
@@ -540,7 +545,7 @@
int ssl_hook_Upgrade(request_rec *);
void ssl_hook_ConfigTest(apr_pool_t *pconf, server_rec *s);
-/* OpenSSL callbacks */
+/** OpenSSL callbacks */
RSA *ssl_callback_TmpRSA(SSL *, int, int);
DH *ssl_callback_TmpDH(SSL *, int, int);
int ssl_callback_SSLVerify(int, X509_STORE_CTX *);
@@ -551,7 +556,7 @@
void ssl_callback_DelSessionCacheEntry(SSL_CTX *, SSL_SESSION *);
void ssl_callback_LogTracingState(MODSSL_INFO_CB_ARG_TYPE, int, int);
-/* Session Cache Support */
+/** Session Cache Support */
void ssl_scache_init(server_rec *, apr_pool_t *);
void ssl_scache_status_register(apr_pool_t *p);
void ssl_scache_kill(server_rec *);
@@ -581,19 +586,19 @@
void ssl_scache_dc_remove(server_rec *, UCHAR *, int);
void ssl_scache_dc_status(request_rec *r, int flags, apr_pool_t *pool);
-/* Proxy Support */
+/** Proxy Support */
int ssl_proxy_enable(conn_rec *c);
int ssl_engine_disable(conn_rec *c);
-/* I/O */
+/** I/O */
void ssl_io_filter_init(conn_rec *, SSL *);
void ssl_io_filter_register(apr_pool_t *);
long ssl_io_data_cb(BIO *, int, MODSSL_BIO_CB_ARG_TYPE *, int, long, long);
-/* PRNG */
+/** PRNG */
int ssl_rand_seed(server_rec *, apr_pool_t *, ssl_rsctx_t, char *);
-/* Utility Functions */
+/** Utility Functions */
char *ssl_util_vhostid(apr_pool_t *, server_rec *);
apr_file_t *ssl_util_ppopen(server_rec *, apr_pool_t *, const char *,
const char * const *);
@@ -606,10 +611,10 @@
void ssl_util_thread_setup(apr_pool_t *);
int ssl_init_ssl_connection(conn_rec *c);
-/* Pass Phrase Support */
+/** Pass Phrase Support */
void ssl_pphrase_Handle(server_rec *, apr_pool_t *);
-/* Diffie-Hellman Parameter Support */
+/** Diffie-Hellman Parameter Support */
DH *ssl_dh_GetTmpParam(int);
DH *ssl_dh_GetParamFromFile(char *);
@@ -628,17 +633,17 @@
const char *ssl_asn1_table_keyfmt(apr_pool_t *p,
const char *id,
int keytype);
-/* Mutex Support */
+/** Mutex Support */
int ssl_mutex_init(server_rec *, apr_pool_t *);
int ssl_mutex_reinit(server_rec *, apr_pool_t *);
int ssl_mutex_on(server_rec *);
int ssl_mutex_off(server_rec *);
-/* Logfile Support */
+/** Logfile Support */
void ssl_die(void);
void ssl_log_ssl_error(const char *, int, int, server_rec *);
-/* Variables */
+/** Variables */
void ssl_var_register(void);
char *ssl_var_lookup(apr_pool_t *, server_rec *, conn_rec *, request_rec *, char *);
const char *ssl_ext_lookup(apr_pool_t *p, conn_rec *c, int peer, const char *oid);
@@ -650,3 +655,5 @@
#define APR_SHM_MAXSIZE (64 * 1024 * 1024)
#endif /* SSL_PRIVATE_H */
+/** @} */
+
Modified: httpd/httpd/trunk/modules/ssl/ssl_toolkit_compat.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ssl/ssl_toolkit_compat.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ssl/ssl_toolkit_compat.h (original)
+++ httpd/httpd/trunk/modules/ssl/ssl_toolkit_compat.h Sun Aug 28 16:03:59 2005
@@ -17,14 +17,19 @@
#ifndef SSL_TOOLKIT_COMPAT_H
#define SSL_TOOLKIT_COMPAT_H
-/*
- * this header file provides a compatiblity layer
- * between OpenSSL and RSA sslc
+/**
+ * @file ssl_toolkit_compat.h
+ * @brief this header file provides a compatiblity layer
+ * between OpenSSL and RSA sslc
+ *
+ * @defgroup MOD_SSL_TOOLKIT Toolkit
+ * @ingroup MOD_SSL
+ * @{
*/
#ifdef HAVE_OPENSSL
-/* OpenSSL headers */
+/** OpenSSL headers */
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/x509.h>
@@ -33,14 +38,14 @@
#include <openssl/evp.h>
#include <openssl/rand.h>
#include <openssl/x509v3.h>
-/* Avoid tripping over an engine build installed globally and detected
+/** Avoid tripping over an engine build installed globally and detected
* when the user points at an explicit non-engine flavor of OpenSSL
*/
#if defined(HAVE_OPENSSL_ENGINE_H) && defined(HAVE_ENGINE_INIT)
#include <openssl/engine.h>
#endif
-/*
+/**
* rsa sslc uses incomplete types for most structures
* so we macroize for OpenSSL those which cannot be dereferenced
* using the same sames as the sslc functions
@@ -66,7 +71,7 @@
#define SSL_SESSION_get_session_id(s) (s->session_id)
#define SSL_SESSION_get_session_id_length(s) (s->session_id_length)
-/*
+/**
* Support for retrieving/overriding states
*/
#ifndef SSL_get_state
@@ -85,7 +90,7 @@
#define MODSSL_CLIENT_CERT_CB_ARG_TYPE X509
#define MODSSL_PCHAR_CAST
-/* ...shifting sands of openssl... */
+/** ...shifting sands of openssl... */
#if (OPENSSL_VERSION_NUMBER >= 0x0090707f)
# define MODSSL_D2I_SSL_SESSION_CONST const
#else
@@ -130,7 +135,7 @@
#ifndef PEM_F_DEF_CALLBACK
#ifdef PEM_F_PEM_DEF_CALLBACK
-/* In OpenSSL 0.9.8 PEM_F_DEF_CALLBACK was renamed */
+/** In OpenSSL 0.9.8 PEM_F_DEF_CALLBACK was renamed */
#define PEM_F_DEF_CALLBACK PEM_F_PEM_DEF_CALLBACK
#endif
#endif
@@ -146,10 +151,10 @@
#include <objects.h>
#include <sslc.h>
-/* sslc does not support this function, OpenSSL has since 9.5.1 */
+/** sslc does not support this function, OpenSSL has since 9.5.1 */
#define RAND_status() 1
-/* sslc names this function a bit differently */
+/** sslc names this function a bit differently */
#define CRYPTO_num_locks() CRYPTO_get_num_locks()
#ifndef STACK_OF
@@ -179,7 +184,7 @@
PEM_read_bio_PrivateKey(b, k, cb)
#ifndef HAVE_SSL_SET_STATE
-#define SSL_set_state(ssl, state) /* XXX: should throw an error */
+#define SSL_set_state(ssl, state) /** XXX: should throw an error */
#endif
#define modssl_set_cipher_list(ssl, l) \
@@ -202,13 +207,13 @@
#define modssl_set_verify(ssl, verify, cb) \
SSL_set_verify(ssl, verify)
-#else /* SSLC_VERSION_NUMBER >= 0x2000 */
+#else /** SSLC_VERSION_NUMBER >= 0x2000 */
#define CRYPTO_malloc_init R_malloc_init
#define EVP_cleanup()
-#endif /* SSLC_VERSION_NUMBER >= 0x2000 */
+#endif /** SSLC_VERSION_NUMBER >= 0x2000 */
typedef void (*modssl_popfree_fn)(char *data);
@@ -238,7 +243,7 @@
#define sk_X509_REVOKED_num sk_num
#define sk_X509_REVOKED_value (X509_REVOKED *)sk_value
-#else /* ! HAVE_OPENSSL && ! HAVE_SSLC */
+#else /** ! HAVE_OPENSSL && ! HAVE_SSLC */
#error "Unrecognized SSL Toolkit!"
@@ -254,3 +259,5 @@
#endif
#endif /* SSL_TOOLKIT_COMPAT_H */
+
+/** @} */
Modified: httpd/httpd/trunk/modules/ssl/ssl_util_ssl.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/ssl/ssl_util_ssl.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/ssl/ssl_util_ssl.h (original)
+++ httpd/httpd/trunk/modules/ssl/ssl_util_ssl.h Sun Aug 28 16:03:59 2005
@@ -14,20 +14,27 @@
* limitations under the License.
*/
-/* _ _
- * _ __ ___ ___ __| | ___ ___| | mod_ssl
- * | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
- * | | | | | | (_) | (_| | \__ \__ \ |
- * |_| |_| |_|\___/ \__,_|___|___/___/_|
- * |_____|
- * ssl_util_ssl.h
- * Additional Utility Functions for OpenSSL
+/**
+ * @verbatim
+ _ _
+ _ __ ___ ___ __| | ___ ___| | mod_ssl
+ | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
+ | | | | | | (_) | (_| | \__ \__ \ |
+ |_| |_| |_|\___/ \__,_|___|___/___/_|
+ |_____|
+ @endverbatim
+ * @file ssl_util_ssl.h
+ * @brief Additional Utility Functions for OpenSSL
+ *
+ * @defgroup MOD_SSL_UTIL Utilities
+ * @ingroup MOD_SSL
+ * @{
*/
#ifndef __SSL_UTIL_SSL_H__
#define __SSL_UTIL_SSL_H__
-/*
+/**
* Determine SSL library version number
*/
#ifdef OPENSSL_VERSION_NUMBER
@@ -40,18 +47,18 @@
#define SSL_LIBRARY_TEXT "OtherSSL 0.0.0 00 XXX 0000"
#endif
-/*
+/**
* Maximum length of a DER encoded session.
* FIXME: There is no define in OpenSSL, but OpenSSL uses 1024*10,
* so this value should be ok. Although we have no warm feeling.
*/
#define SSL_SESSION_MAX_DER 1024*10
-/* max length for SSL_SESSION_id2sz */
+/** max length for SSL_SESSION_id2sz */
#define SSL_SESSION_ID_STRING_LEN \
((SSL_MAX_SSL_SESSION_ID_LENGTH + 1) * 2)
-/*
+/**
* Additional Functions
*/
void SSL_init_app_data2_idx(void);
@@ -71,10 +78,12 @@
int SSL_CTX_use_certificate_chain(SSL_CTX *, char *, int, modssl_read_bio_cb_fn *);
char *SSL_SESSION_id2sz(unsigned char *, int, char *, int);
-/* util functions for OpenSSL+sslc compat */
+/** util functions for OpenSSL+sslc compat */
int modssl_session_get_time(SSL_SESSION *session);
DH *modssl_dh_configure(unsigned char *p, int plen,
unsigned char *g, int glen);
#endif /* __SSL_UTIL_SSL_H__ */
+/** @} */
+
Modified: httpd/httpd/trunk/os/beos/beosd.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/beos/beosd.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/beos/beosd.h (original)
+++ httpd/httpd/trunk/os/beos/beosd.h Sun Aug 28 16:03:59 2005
@@ -14,12 +14,19 @@
* limitations under the License.
*/
+/**
+ * @file beosd.h
+ * @brief common stuff that beos MPMs will want
+ *
+ * @addtogroup APACHE_OS_BEOS
+ * @{
+ */
+
#ifndef BEOSD_H
#define BEOSD_H
#include "httpd.h"
#include "ap_listen.h"
-/* common stuff that beos MPMs will want */
/* Default user name and group name. These may be specified as numbers by
* placing a # before a number */
@@ -58,3 +65,4 @@
"Effective group id for this server (NO-OP)")
#endif /* BEOSD_H */
+/** @} */
Modified: httpd/httpd/trunk/os/beos/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/beos/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/beos/os.h (original)
+++ httpd/httpd/trunk/os/beos/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file beos/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_BEOS beos
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_H
#define APACHE_OS_H
@@ -28,3 +39,4 @@
#endif
#endif /* !APACHE_OS_H */
+/** @} */
Modified: httpd/httpd/trunk/os/bs2000/ebcdic.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/bs2000/ebcdic.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/bs2000/ebcdic.h (original)
+++ httpd/httpd/trunk/os/bs2000/ebcdic.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file bs2000/ebcdic.h
+ * @brief EBCDIC/ASCII converson function declarations
+ *
+ * @addtogroup APACHE_OS_BS2000
+ * @{
+ */
+
#include <sys/types.h>
extern const unsigned char os_toascii[256];
@@ -21,4 +29,5 @@
void ebcdic2ascii(unsigned char *dest, const unsigned char *srce, size_t count);
void ebcdic2ascii_strictly(unsigned char *dest, const unsigned char *srce, size_t count);
void ascii2ebcdic(unsigned char *dest, const unsigned char *srce, size_t count);
+/** @} */
Modified: httpd/httpd/trunk/os/bs2000/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/bs2000/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/bs2000/os.h (original)
+++ httpd/httpd/trunk/os/bs2000/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file bs2000/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_BS2000 bs2000
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_BS2000_H
#define APACHE_OS_BS2000_H
@@ -21,14 +32,9 @@
#include "../unix/os.h"
-/*
- * This file in included in all Apache source code. It contains definitions
- * of facilities available on _this_ operating system (HAVE_* macros),
- * and prototypes of OS specific functions defined in os.c or os-inline.c
- */
-
/* Other ap_os_ routines not used by this platform */
extern pid_t os_fork(const char *user);
#endif /* APACHE_OS_BS2000_H */
+/** @} */
Modified: httpd/httpd/trunk/os/netware/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/netware/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/netware/os.h (original)
+++ httpd/httpd/trunk/os/netware/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file netware/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_NETWARE netware
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_H
#define APACHE_OS_H
@@ -38,3 +49,4 @@
#define exit(s) {if((s||hold_screen_on_exit)&&(hold_screen_on_exit>=0)){pressanykey();}apr_terminate();exit(s);}
#endif /* ! APACHE_OS_H */
+/** @} */
Modified: httpd/httpd/trunk/os/netware/pre_nw.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/netware/pre_nw.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/netware/pre_nw.h (original)
+++ httpd/httpd/trunk/os/netware/pre_nw.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file pre_nw.h
+ * @brief Definitions for Netware systems
+ *
+ * @addtogroup APACHE_OS_NETWARE
+ * @{
+ */
+
#ifndef __pre_nw__
#define __pre_nw__
@@ -65,6 +73,4 @@
#define AP_MAX_INCLUDE_DEPTH 48
#endif
-
-
-
+/** @} */
Modified: httpd/httpd/trunk/os/os2/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/os2/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/os2/os.h (original)
+++ httpd/httpd/trunk/os/os2/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file os2/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_OS2 os2
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_H
#define APACHE_OS_H
@@ -24,10 +35,5 @@
#define HAVE_UNC_PATHS
#define CASE_BLIND_FILESYSTEM
-/*
- * This file in included in all Apache source code. It contains definitions
- * of facilities available on _this_ operating system (HAVE_* macros),
- * and prototypes of OS specific functions defined in os.c or os-inline.c
- */
-
#endif /* ! APACHE_OS_H */
+/** @} */
Modified: httpd/httpd/trunk/os/tpf/ebcdic.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/tpf/ebcdic.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/tpf/ebcdic.h (original)
+++ httpd/httpd/trunk/os/tpf/ebcdic.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file tpf/ebcdic.h
+ * @brief EBCDIC/ASCII converson function declarations
+ *
+ * @addtogroup APACHE_OS_TPF
+ * @{
+ */
+
#include <sys/types.h>
extern const unsigned char os_toascii[256];
@@ -21,4 +29,4 @@
void ebcdic2ascii(void *dest, const void *srce, size_t count);
void ebcdic2ascii_strictly(unsigned char *dest, const unsigned char *srce, size_t count);
void ascii2ebcdic(void *dest, const void *srce, size_t count);
-
+/** @} */
Modified: httpd/httpd/trunk/os/tpf/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/tpf/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/tpf/os.h (original)
+++ httpd/httpd/trunk/os/tpf/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file tpf/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_TPF tpf
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_H
#define APACHE_OS_H
@@ -23,12 +34,6 @@
#undef errno
#endif
-/*
- * This file in included in all Apache source code. It contains definitions
- * of facilities available on _this_ operating system (HAVE_* macros),
- * and prototypes of OS specific functions defined in os.c or os-inline.c
- */
-
#include "apr.h"
#include "ap_config.h"
#include <strings.h>
@@ -85,3 +90,4 @@
#undef NSIG
#endif
#endif /*! APACHE_OS_H*/
+/** @} */
Modified: httpd/httpd/trunk/os/unix/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/unix/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/unix/os.h (original)
+++ httpd/httpd/trunk/os/unix/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file unix/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_UNIX unix
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifndef APACHE_OS_H
#define APACHE_OS_H
@@ -34,3 +45,4 @@
#endif
#endif /* !APACHE_OS_H */
+/** @} */
Modified: httpd/httpd/trunk/os/unix/unixd.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/unix/unixd.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/unix/unixd.h (original)
+++ httpd/httpd/trunk/os/unix/unixd.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file unixd.h
+ * @brief common stuff that unix MPMs will want
+ *
+ * @addtogroup APACHE_OS_UNIX
+ * @{
+ */
+
#ifndef UNIXD_H
#define UNIXD_H
@@ -48,7 +56,6 @@
AP_DECLARE_HOOK(ap_unix_identity_t *, get_suexec_identity,(const request_rec *r))
-/* common stuff that unix MPMs will want */
/* Default user name and group name. These may be specified as numbers by
* placing a # before a number */
@@ -107,3 +114,4 @@
"Effective group id for this server")
#endif
+/** @} */
Modified: httpd/httpd/trunk/os/win32/os.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/os/win32/os.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/os/win32/os.h (original)
+++ httpd/httpd/trunk/os/win32/os.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,17 @@
* limitations under the License.
*/
+/**
+ * @file win32/os.h
+ * @brief This file in included in all Apache source code. It contains definitions
+ * of facilities available on _this_ operating system (HAVE_* macros),
+ * and prototypes of OS specific functions defined in os.c or os-inline.c
+ *
+ * @defgroup APACHE_OS_WIN32 win32
+ * @ingroup APACHE_OS
+ * @{
+ */
+
#ifdef WIN32
#ifndef AP_OS_H
@@ -121,3 +132,4 @@
#endif /* ndef AP_OS_H */
#endif /* def WIN32 */
+/** @} */
Modified: httpd/httpd/trunk/server/core_filters.c
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/core_filters.c?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/core_filters.c (original)
+++ httpd/httpd/trunk/server/core_filters.c Sun Aug 28 16:03:59 2005
@@ -14,8 +14,9 @@
* limitations under the License.
*/
-/*
- * core_filters.c --- Core input/output network filters.
+/**
+ * @file core_filters.c
+ * @brief Core input/output network filters.
*/
#include "apr.h"
Modified: httpd/httpd/trunk/server/main.c
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/main.c?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/main.c (original)
+++ httpd/httpd/trunk/server/main.c Sun Aug 28 16:03:59 2005
@@ -731,5 +731,6 @@
extern const void *ap_ugly_hack;
return ap_ugly_hack;
+ gzeof(NULL);
}
#endif
Modified: httpd/httpd/trunk/server/mpm/beos/beos.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/beos/beos.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/beos/beos.h (original)
+++ httpd/httpd/trunk/server/mpm/beos/beos.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,13 @@
* limitations under the License.
*/
+/**
+ * @file beos/beos.h
+ * @brief Extern functions/values for BEOS MPM
+ *
+ * @addtogroup APACHE_MPM_BEOS
+ * @{
+ */
#ifndef APACHE_MPM_BEOS_H
#define APACHE_MPM_BEOS_H
@@ -24,3 +31,4 @@
extern int max_daemons_limit;
#endif /* APACHE_MPM_BEOS_H */
+/** @} */
Modified: httpd/httpd/trunk/server/mpm/beos/mpm.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/beos/mpm.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/beos/mpm.h (original)
+++ httpd/httpd/trunk/server/mpm/beos/mpm.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file beos/mpm.h
+ * @brief BEOS MPM
+ *
+ * @defgroup APACHE_MPM_BEOS BEOS MPM
+ * @ingroup APACHE_MPM APACHE_OS_BEOS
+ * @{
+ */
+
#ifndef APACHE_MPM_BEOS_H
#define APACHE_MPM_BEOS_H
@@ -38,3 +47,4 @@
extern int ap_threads_per_child;
#endif /* APACHE_MPM_BEOS_H */
+/** @} */
Modified: httpd/httpd/trunk/server/mpm/beos/mpm_default.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/beos/mpm_default.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/beos/mpm_default.h (original)
+++ httpd/httpd/trunk/server/mpm/beos/mpm_default.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,13 @@
* limitations under the License.
*/
+/**
+ * @file beos/mpm_default.h
+ * @brief beos MPM defaults
+ *
+ * @addtogroup APACHE_MPM_BEOS
+ * @{
+ */
#ifndef APACHE_MPM_DEFAULT_H
#define APACHE_MPM_DEFAULT_H
@@ -74,3 +81,4 @@
#endif
#endif /* AP_MPM_DEFAULT_H */
+/** @} */
Modified: httpd/httpd/trunk/server/mpm/experimental/event/fdqueue.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/experimental/event/fdqueue.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/experimental/event/fdqueue.h (original)
+++ httpd/httpd/trunk/server/mpm/experimental/event/fdqueue.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,14 @@
* limitations under the License.
*/
+/**
+ * @file event/fdqueue.h
+ * @brief fd queue declarations
+ *
+ * @addtogroup APACHE_MPM_EVENT
+ * @{
+ */
+
#ifndef FDQUEUE_H
#define FDQUEUE_H
#include "httpd.h"
@@ -71,3 +79,4 @@
apr_status_t ap_queue_term(fd_queue_t * queue);
#endif /* FDQUEUE_H */
+/** @} */
Modified: httpd/httpd/trunk/server/mpm/experimental/event/mpm.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/experimental/event/mpm.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/experimental/event/mpm.h (original)
+++ httpd/httpd/trunk/server/mpm/experimental/event/mpm.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+/**
+ * @file event/mpm.h
+ * @brief Unix Exent driven MPM
+ *
+ * @defgroup APACHE_MPM_EVENT Unix Event MPM
+ * @ingroup APACHE_OS_UNIX APACHE_MPM
+ * @{
+ */
+
#include "scoreboard.h"
#include "unixd.h"
@@ -49,3 +58,4 @@
extern char ap_coredump_dir[MAX_STRING_LEN];
#endif /* APACHE_MPM_EVENT_H */
+/** @} */
Modified: httpd/httpd/trunk/server/mpm/experimental/event/mpm_default.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/server/mpm/experimental/event/mpm_default.h?rev=263931&r1=263930&r2=263931&view=diff
==============================================================================
--- httpd/httpd/trunk/server/mpm/experimental/event/mpm_default.h (original)
+++ httpd/httpd/trunk/server/mpm/experimental/event/mpm_default.h Sun Aug 28 16:03:59 2005
@@ -14,6 +14,15 @@
* limitations under the License.
*/
+
+/**
+ * @file event/mpm_default.h
+ * @brief Event MPM defaults
+ *
+ * @addtogroup APACHE_MPM_EVENT
+ * @{
+ */
+
#ifndef APACHE_MPM_DEFAULT_H
#define APACHE_MPM_DEFAULT_H
@@ -67,3 +76,4 @@
#endif
#endif /* AP_MPM_DEFAULT_H */
+/** @} */