ap_expr related fixes/enhancements:

[apache] / include / util_script.h

diff --git a/include/util_script.h b/include/util_script.h
index ddbf516906ba6166589cbbcb8b00eeba695b6df7..924dd1425698019b462ff1df03f7ef391b414533 100644 (file)
--- a/include/util_script.h
+++ b/include/util_script.h
@@ -1,8 +1,9 @@
-/* Copyright 1999-2004 Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
@@ -13,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
 
@@ -22,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
@@ -40,7 +46,7 @@ extern "C" {
  * @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);
 
@@ -51,7 +57,7 @@ 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);
 
@@ -59,14 +65,14 @@ 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);
 
@@ -79,7 +85,7 @@ 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);
 
@@ -92,7 +98,7 @@ AP_DECLARE(int) ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *b
  * @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,
@@ -107,10 +113,11 @@ AP_DECLARE(int) ap_scan_script_header_err_brigade(request_rec *r,
  *               error, the string that cause the error is stored here. 
  * @param termch Pointer to the last character parsed.
  * @param termarg Pointer to an int to capture the last argument parsed.
- * @param args   String arguments to parse consecutively for headers, 
- *               a NULL argument terminates the list.
+ * 
+ * The varargs are string arguments to parse consecutively for headers, 
+ * with a NULL argument to terminate 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)
  */ 
 AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r, 
                                                       char *buffer, 
@@ -128,14 +135,16 @@ AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
                    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)
  */ 
 AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
                                       int (*getsfunc) (char *, int, void *),
                                       void *getsfunc_data);
 
+AP_DECLARE(void) ap_args_to_table(request_rec *r, apr_table_t **table);
+
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* !APACHE_UTIL_SCRIPT_H */
+/** @} */