Author: joes
Date: Sat Apr 9 13:13:52 2005
New Revision: 160717
URL: http://svn.apache.org/viewcvs?view=rev&rev=160717
Log:
Document charset returns from apreq_decode and apreq_decodev.
Modified:
httpd/apreq/branches/multi-env-unstable/include/apreq_param.h
httpd/apreq/branches/multi-env-unstable/include/apreq_util.h
Modified: httpd/apreq/branches/multi-env-unstable/include/apreq_param.h
URL:
http://svn.apache.org/viewcvs/httpd/apreq/branches/multi-env-unstable/include/apreq_param.h?view=diff&r1=160716&r2=160717
==============================================================================
--- httpd/apreq/branches/multi-env-unstable/include/apreq_param.h (original)
+++ httpd/apreq/branches/multi-env-unstable/include/apreq_param.h Sat Apr 9
13:13:52 2005
@@ -102,7 +102,11 @@
* @param word Start of the name=value pair.
* @param nlen Length of urlencoded name.
* @param vlen Length of urlencoded value.
- * @remark Unless vlen == 0, this function assumes there is
+ *
+ * @return APR_SUCCESS + apreq_charset_t (<=APREQ_CHARSET_UTF8) on success.
+ * @return ::APREQ_ERROR_BADSEQ or ::APREQ_ERROR_BADCHAR on malformed input.
+ *
+ * @remarks Unless vlen == 0, this function assumes there is
* exactly one character ('=') which separates the pair.
*
*/
Modified: httpd/apreq/branches/multi-env-unstable/include/apreq_util.h
URL:
http://svn.apache.org/viewcvs/httpd/apreq/branches/multi-env-unstable/include/apreq_util.h?view=diff&r1=160716&r2=160717
==============================================================================
--- httpd/apreq/branches/multi-env-unstable/include/apreq_util.h (original)
+++ httpd/apreq/branches/multi-env-unstable/include/apreq_util.h Sat Apr 9
13:13:52 2005
@@ -123,7 +123,9 @@
* @param src Original string.
* @param slen Length of original string.
*
- * @return APR_SUCCESS.
+ * @return APR_SUCCESS + apreq_charset_t (<=APREQ_CHARSET_UTF8) on success.
+ * @return APR_INCOMPLETE + apreq_charset_t (<=APREQ_CHARSET_UTF8) if the
string
+ * ends in the middle of an escape sequence.
* @return ::APREQ_ERROR_BADSEQ or ::APREQ_ERROR_BADCHAR on malformed input.
*
* @remarks In the non-success case, dlen will be set to include
@@ -144,9 +146,9 @@
* @param v Array of iovecs that represent the source string
* @param nelts Number of iovecs in the array.
*
- * @return APR_SUCCESS.
- * @return ::APR_INCOMPLETE if the iovec ends in the middle of an \%XX escape
- * sequence.
+ * @return APR_SUCCESS + apreq_charset_t (<=APREQ_CHARSET_UTF8) on success.
+ * @return APR_INCOMPLETE + apreq_charset_t (<=APREQ_CHARSET_UTF8) if the iovec
+ * ends in the middle of an escape sequence.
* @return ::APREQ_ERROR_BADSEQ or ::APREQ_ERROR_BADCHAR on malformed input.
*
* @remarks In the non-APR_SUCCESS case, dlen will be set to include
