* </pre>
* @param major The major module magic number
* @param minor The minor module magic number
- * @deffunc AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
+ * @fn AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
*/
#define AP_MODULE_MAGIC_AT_LEAST(major,minor) \
((major) < MODULE_MAGIC_NUMBER_MAJOR \
* @param plog the log pool, reset after the config file is read
* @param server_conf the global server config.
* @return 1 for shutdown 0 otherwise.
- * @deffunc int ap_mpm_run(apr_pool_t *pconf, apr_pool_t *plog, server_rec *server_conf)
+ * @fn int ap_mpm_run(apr_pool_t *pconf, apr_pool_t *plog, server_rec *server_conf)
*/
AP_DECLARE(int) ap_mpm_run(apr_pool_t *pconf, apr_pool_t *plog, server_rec *server_conf);
* predicate indicating if a graceful stop has been requested ...
* used by the connection loop
* @return 1 if a graceful stop has been requested, 0 otherwise
- * @deffunc int ap_graceful_stop_signalled(*void)
+ * @fn int ap_graceful_stop_signalled(*void)
*/
AP_DECLARE(int) ap_graceful_stop_signalled(void);
* @param query_code One of APM_MPMQ_*
* @param result A location to place the result of the query
* @return APR_SUCCESS or APR_ENOTIMPL
- * @deffunc int ap_mpm_query(int query_code, int *result)
+ * @fn int ap_mpm_query(int query_code, int *result)
*/
AP_DECLARE(apr_status_t) ap_mpm_query(int query_code, int *result);
* (e.g., AddIcon)
*/
FLAG, /**< One of 'On' or 'Off' */
- NO_ARGS, /**< No args at all, e.g. </Directory> */
+ NO_ARGS, /**< No args at all, e.g. </Directory> */
TAKE12, /**< one or two arguments */
TAKE3, /**< three arguments only */
TAKE23, /**< two or three arguments */
void *cmd_data;
/** What overrides need to be allowed to enable this command. */
int req_override;
- /** What the command expects as arguments
- * @defvar cmd_how args_how*/
+ /** What the command expects as arguments */
enum cmd_how args_how;
/** 'usage' message, in case of syntax errors */
* @{
*/
#define OR_NONE 0 /**< *.conf is not available anywhere in this override */
-#define OR_LIMIT 1 /**< *.conf inside <Directory> or <Location>
+#define OR_LIMIT 1 /**< *.conf inside <Directory> or <Location>
and .htaccess when AllowOverride Limit */
#define OR_OPTIONS 2 /**< *.conf anywhere
and .htaccess when AllowOverride Options */
#define OR_FILEINFO 4 /**< *.conf anywhere
and .htaccess when AllowOverride FileInfo */
-#define OR_AUTHCFG 8 /**< *.conf inside <Directory> or <Location>
+#define OR_AUTHCFG 8 /**< *.conf inside <Directory> or <Location>
and .htaccess when AllowOverride AuthConfig */
#define OR_INDEXES 16 /**< *.conf anywhere
and .htaccess when AllowOverride Indexes */
#define OR_UNSET 32 /**< unset a directive (in Allow) */
-#define ACCESS_CONF 64 /**< *.conf inside <Directory> or <Location> */
-#define RSRC_CONF 128 /**< *.conf outside <Directory> or <Location> */
+#define ACCESS_CONF 64 /**< *.conf inside <Directory> or <Location> */
+#define RSRC_CONF 128 /**< *.conf outside <Directory> or <Location> */
#define EXEC_ON_READ 256 /**< force directive to execute a command
which would modify the configuration (like including another
file, or IFModule */
void *info;
/** Which allow-override bits are set */
int override;
- /** Which methods are <Limit>ed */
+ /** Which methods are <Limit>ed */
apr_int64_t limited;
/** methods which are limited */
apr_array_header_t *limited_xmethods;
/** Server_rec being configured for */
server_rec *server;
/** If configuring for a directory, pathname of that directory.
- * NOPE! That's what it meant previous to the existance of <Files>,
- * <Location> and regex matching. Now the only usefulness that can be
+ * NOPE! That's what it meant previous to the existance of <Files>,
+ * <Location> and regex matching. Now the only usefulness that can be
* derived from this field is whether a command is being called in a
* server context (path == NULL) or being called in a dir context
* (path != NULL). */
void *dynamic_load_handle;
/** A pointer to the next module in the list
- * @defvar module_struct *next */
+ * @var module_struct *next */
struct module_struct *next;
/** Magic Cookie to identify a module structure; It's mainly
/**
* Return true if the specified method is limited by being listed in
- * a <Limit> container, or by *not* being listed in a <LimiteExcept>
+ * a <Limit> container, or by *not* being listed in a <LimitExcept>
* container.
*
* @param method Pointer to a string specifying the method to check.
AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
/**
- * Read all data between the current <foo> and the matching </foo>. All
+ * Read all data between the current <foo> and the matching </foo>. All
* of this data is forgotten immediately.
* @param cmd The cmd_parms to pass to the directives inside the container
* @param directive The directive name to read until
AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
/**
- * Read all data between the current <foo> and the matching </foo> and build
+ * Read all data between the current <foo> and the matching </foo> and build
* a config tree from it
* @param p pool to allocate from
* @param temp_pool Temporary pool to allocate from
AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd,
unsigned forbidden);
-#define NOT_IN_VIRTUALHOST 0x01 /**< Forbidden in <Virtualhost> */
-#define NOT_IN_LIMIT 0x02 /**< Forbidden in <Limit> */
-#define NOT_IN_DIRECTORY 0x04 /**< Forbidden in <Directory> */
-#define NOT_IN_LOCATION 0x08 /**< Forbidden in <Location> */
-#define NOT_IN_FILES 0x10 /**< Forbidden in <Files> */
-/** Forbidden in <Directory>/<Location>/<Files>*/
+#define NOT_IN_VIRTUALHOST 0x01 /**< Forbidden in <VirtualHost> */
+#define NOT_IN_LIMIT 0x02 /**< Forbidden in <Limit> */
+#define NOT_IN_DIRECTORY 0x04 /**< Forbidden in <Directory> */
+#define NOT_IN_LOCATION 0x08 /**< Forbidden in <Location> */
+#define NOT_IN_FILES 0x10 /**< Forbidden in <Files> */
+/** Forbidden in <Directory>/<Location>/<Files>*/
#define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES)
-/** Forbidden in <VirtualHost>/<Limit>/<Directory>/<Location>/<Files> */
+/** Forbidden in <VirtualHost>/<Limit>/<Directory>/<Location>/<Files> */
#define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
/** @} */
*/
AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
-/* For http_core.c... (<Directory> command and virtual hosts) */
+/* For http_core.c... (<Directory> command and virtual hosts) */
/**
* parse an htaccess file
* Convert a username to a numeric ID
* @param name The name to convert
* @return The user id corresponding to a name
- * @deffunc uid_t ap_uname2id(const char *name)
+ * @fn uid_t ap_uname2id(const char *name)
*/
AP_DECLARE(uid_t) ap_uname2id(const char *name);
#endif
* Convert a group name to a numeric ID
* @param name The name to convert
* @return The group id corresponding to a name
- * @deffunc gid_t ap_gname2id(const char *name)
+ * @fn gid_t ap_gname2id(const char *name)
*/
AP_DECLARE(gid_t) ap_gname2id(const char *name);
#endif
*
* 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
+ * that contain other directions, such as <Directory ...> cause a sub-level
* to be created, where the included directives are stored. The closing
- * directive (</Directory>) is not stored in the tree.
+ * directive (</Directory>) is not stored in the tree.
*/
struct ap_directive_t {
/** The current directive */
/** The arguments for the current directive, stored as a space
* separated list */
const char *args;
- /** The next directive node in the tree
- * @defvar ap_directive_t *next */
+ /** The next directive node in the tree */
struct ap_directive_t *next;
- /** The first child node of this directive
- * @defvar ap_directive_t *first_child */
+ /** The first child node of this directive */
struct ap_directive_t *first_child;
- /** The parent node of this directive
- * @defvar ap_directive_t *parent */
+ /** The parent node of this directive */
struct ap_directive_t *parent;
/** directive's module can store add'l data here */
/**
* The root of the configuration tree
- * @defvar ap_directive_t *conftree
+ * @var ap_directive_t *conftree
*/
AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
* connect if already connected (ldc->ldap != NULL). Does not bind
* if already bound.
* @return If successful LDAP_SUCCESS is returned.
- * @deffunc int util_ldap_connection_open(request_rec *r,
+ * @fn int util_ldap_connection_open(request_rec *r,
* util_ldap_connection_t *ldc)
*/
APR_DECLARE_OPTIONAL_FN(int,uldap_connection_open,(request_rec *r,
* @tip This function unbinds from the LDAP server, and clears ldc->ldap.
* It is possible to rebind to this server again using the same ldc
* structure, using apr_ldap_open_connection().
- * @deffunc util_ldap_close_connection(util_ldap_connection_t *ldc)
+ * @fn util_ldap_close_connection(util_ldap_connection_t *ldc)
*/
APR_DECLARE_OPTIONAL_FN(void,uldap_connection_close,(util_ldap_connection_t *ldc));
* @tip This function unbinds the LDAP connection, and disconnects from
* the server. It is used during error conditions, to bring the LDAP
* connection back to a known state.
- * @deffunc apr_status_t util_ldap_connection_unbind(util_ldap_connection_t *ldc)
+ * @fn apr_status_t util_ldap_connection_unbind(util_ldap_connection_t *ldc)
*/
APR_DECLARE_OPTIONAL_FN(apr_status_t,uldap_connection_unbind,(void *param));
* that was connected.
* @tip This function is registered with the pool cleanup to close down the
* LDAP connections when the server is finished with them.
- * @deffunc apr_status_t util_ldap_connection_cleanup(util_ldap_connection_t *ldc)
+ * @fn apr_status_t util_ldap_connection_cleanup(util_ldap_connection_t *ldc)
*/
APR_DECLARE_OPTIONAL_FN(apr_status_t,uldap_connection_cleanup,(void *param));
* lock that particular connection, so that another thread does not try and
* use this connection while it is busy. Once you are finished with a connection,
* apr_ldap_connection_close() must be called to release this connection.
- * @deffunc util_ldap_connection_t *util_ldap_connection_find(request_rec *r, const char *host, int port,
+ * @fn util_ldap_connection_t *util_ldap_connection_find(request_rec *r, const char *host, int port,
* const char *binddn, const char *bindpw, deref_options deref,
* int netscapessl, int starttls)
*/
* @tip Two DNs can be equal and still fail a string comparison. Eg "dc=example,dc=com"
* and "dc=example, dc=com". Use the compare_dn_on_server unless there are serious
* performance issues.
- * @deffunc int util_ldap_cache_comparedn(request_rec *r, util_ldap_connection_t *ldc,
+ * @fn int util_ldap_cache_comparedn(request_rec *r, util_ldap_connection_t *ldc,
* const char *url, const char *dn, const char *reqdn,
* int compare_dn_on_server)
*/
* @param value The value of the attribute we are trying to compare for.
* @tip Use this function to determine whether an attribute/value pair exists within an
* object. Typically this would be used to determine LDAP group membership.
- * @deffunc int util_ldap_cache_compare(request_rec *r, util_ldap_connection_t *ldc,
+ * @fn int util_ldap_cache_compare(request_rec *r, util_ldap_connection_t *ldc,
* const char *url, const char *dn, const char *attrib, const char *value)
*/
APR_DECLARE_OPTIONAL_FN(int,uldap_cache_compare,(request_rec *r, util_ldap_connection_t *ldc,
* @param retvals The values corresponding to the attributes requested in the attrs array.
* @tip The filter supplied will be searched for. If a single entry is returned, an attempt
* is made to bind as that user. If this bind succeeds, the user is not validated.
- * @deffunc int util_ldap_cache_checkuserid(request_rec *r, util_ldap_connection_t *ldc,
+ * @fn int util_ldap_cache_checkuserid(request_rec *r, util_ldap_connection_t *ldc,
* char *url, const char *basedn, int scope, char **attrs,
* char *filter, char *bindpw, char **binddn, char ***retvals)
*/
* @param retvals The values corresponding to the attributes requested in the attrs array.
* @tip The filter supplied will be searched for. If a single entry is returned, an attempt
* is made to bind as that user. If this bind succeeds, the user is not validated.
- * @deffunc int util_ldap_cache_getuserdn(request_rec *r, util_ldap_connection_t *ldc,
+ * @fn int util_ldap_cache_getuserdn(request_rec *r, util_ldap_connection_t *ldc,
* char *url, const char *basedn, int scope, char **attrs,
* char *filter, char **binddn, char ***retvals)
*/
/**
* Checks if SSL support is available in mod_ldap
- * @deffunc int util_ldap_ssl_supported(request_rec *r)
+ * @fn int util_ldap_ssl_supported(request_rec *r)
*/
APR_DECLARE_OPTIONAL_FN(int,uldap_ssl_supported,(request_rec *r));
* @param reqsize The size of the shared memory segement to request. A size
* of zero requests the max size possible from
* apr_shmem_init()
- * @deffunc void util_ldap_cache_init(apr_pool_t *p, util_ldap_state_t *st)
+ * @fn void util_ldap_cache_init(apr_pool_t *p, util_ldap_state_t *st)
* @return The status code returned is the status code of the
* apr_smmem_init() call. Regardless of the status, the cache
* will be set up at least for in-process or in-thread operation.
* @param The pool to allocate the returned string from
* @tip This function returns a string allocated from the provided pool that describes
* various stats about the cache.
- * @deffunc char *util_ald_cache_display(apr_pool_t *pool, util_ldap_state_t *st)
+ * @fn char *util_ald_cache_display(apr_pool_t *pool, util_ldap_state_t *st)
*/
char *util_ald_cache_display(request_rec *r, util_ldap_state_t *st);
#ifdef __cplusplus
* @param a Pool to allocate out of
* @param string String to get the checksum of
* @return The checksum
- * @deffunc char *ap_md5(apr_pool_t *a, const unsigned char *string)
+ * @fn char *ap_md5(apr_pool_t *a, const unsigned char *string)
*/
AP_DECLARE(char *) ap_md5(apr_pool_t *a, const unsigned char *string);
* @param buf Buffer to generate checksum for
* @param len The length of the buffer
* @return The checksum
- * @deffunc char *ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len)
+ * @fn char *ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len)
*/
AP_DECLARE(char *) ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len);
* @param p The pool to allocate out of
* @param context The context to convert
* @return The converted encoding
- * @deffunc char *ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context)
+ * @fn char *ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context)
*/
AP_DECLARE(char *) ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context);
* Create an MD5 Digest for a given file
* @param p The pool to allocate out of
* @param infile The file to create the digest for
- * @deffunc char *ap_md5digest(apr_pool_t *p, apr_file_t *infile)
+ * @fn char *ap_md5digest(apr_pool_t *p, apr_file_t *infile)
*/
AP_DECLARE(char *) ap_md5digest(apr_pool_t *p, apr_file_t *infile);
* @param mutexmech The APR mutex locking mechanism
* @param mutexfile The lockfile to use as required
* @return APR status code
- * @deffunc apr_status_t ap_parse_mutex(const char *arg, apr_pool_t *pool,
+ * @fn apr_status_t ap_parse_mutex(const char *arg, apr_pool_t *pool,
apr_lockmech_e *mutexmech,
const char **mutexfile)
*/
* @param t Apache table of key-value pairs
* @return An array containing the same key-value pairs suitable for
* use with an exec call.
- * @deffunc char **ap_create_environment(apr_pool_t *p, apr_table_t *t)
+ * @fn char **ap_create_environment(apr_pool_t *p, apr_table_t *t)
*/
AP_DECLARE(char **) ap_create_environment(apr_pool_t *p, apr_table_t *t);
* @param uri The uri we are currently parsing
* @param path_info The current path info
* @return The length of the path info
- * @deffunc int ap_find_path_info(const char *uri, const char *path_info)
+ * @fn int ap_find_path_info(const char *uri, const char *path_info)
*/
AP_DECLARE(int) ap_find_path_info(const char *uri, const char *path_info);
* Add CGI environment variables required by HTTP/1.1 to the request's
* environment table
* @param r the current request
- * @deffunc void ap_add_cgi_vars(request_rec *r)
+ * @fn void ap_add_cgi_vars(request_rec *r)
*/
AP_DECLARE(void) ap_add_cgi_vars(request_rec *r);
/**
* Add common CGI environment variables to the requests environment table
* @param r The current request
- * @deffunc void ap_add_common_vars(request_rec *r)
+ * @fn void ap_add_common_vars(request_rec *r)
*/
AP_DECLARE(void) ap_add_common_vars(request_rec *r);
* @param buffer Empty when calling the function. On output, if there was an
* error, the string that cause the error is stored here.
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer)
+ * @fn int ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer)
*/
AP_DECLARE(int) ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer);
* @param buffer Empty when calling the function. On output, if there was an
* error, the string that cause the error is stored here.
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err_brigade(request_rec *r, apr_bucket_brigade *bb, char *buffer)
+ * @fn int ap_scan_script_header_err_brigade(request_rec *r, apr_bucket_brigade *bb, char *buffer)
*/
AP_DECLARE(int) ap_scan_script_header_err_brigade(request_rec *r,
apr_bucket_brigade *bb,
* @param args String arguments to parse consecutively for headers,
* a NULL argument terminates the list.
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
+ * @fn int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
*/
AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
char *buffer,
act like gets()
* @param getsfunc_data The place to read from
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
+ * @fn int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
*/
AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
int (*getsfunc) (char *, int, void *),
* @param r The current request
* @param pdoc The XML post data
* @return HTTP status code
- * @deffunc int ap_xml_parse_input(request_rec *r, apr_xml_doc **pdoc)
+ * @fn int ap_xml_parse_input(request_rec *r, apr_xml_doc **pdoc)
*/
AP_DECLARE(int) ap_xml_parse_input(request_rec *r, apr_xml_doc **pdoc);
projects / apache / commitdiff