summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjailletc36 <jailletc36@13f79535-47bb-0310-9956-ffa450edef68>2018-08-26 10:25:03 +0000
committerjailletc36 <jailletc36@13f79535-47bb-0310-9956-ffa450edef68>2018-08-26 10:25:03 +0000
commit97843dbc72f185bd4d8c622f6110f78c804ba196 (patch)
tree07fb603d5ab76af0d66262f865845d2ef5dd0a7c
parent0c93d321923ec099908988f3e80a2c0e8bda30c4 (diff)
downloadlibapr-97843dbc72f185bd4d8c622f6110f78c804ba196.tar.gz
Do not forget to escape characters in the documentation of functions that escape characters, otherwise they look as no-op :)
Backport of 1839186 from trunk resp. 1839187 from 1.7.x git-svn-id: http://svn.apache.org/repos/asf/apr/apr/branches/1.6.x@1839188 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--include/apr_escape.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/apr_escape.h b/include/apr_escape.h
index 536cb9090..428a8cb6b 100644
--- a/include/apr_escape.h
+++ b/include/apr_escape.h
@@ -223,8 +223,8 @@ APR_DECLARE(const char *) apr_pescape_urlencoded(apr_pool_t *p,
/**
* Apply entity encoding to a string. Characters are replaced as follows:
- * '<' becomes '&lt;', '>' becomes '&gt;', '&' becomes '&amp;', the
- * double quote becomes '&quot;" and the single quote becomes '&apos;'.
+ * '<' becomes '\&lt;', '>' becomes '\&gt;', '&' becomes '\&amp;', the
+ * double quote becomes '\&quot;" and the single quote becomes '\&apos;'.
*
* If toasc is not zero, any non ascii character will be encoded as
* '%\#ddd;', where ddd is the decimal code of the character.
@@ -242,9 +242,9 @@ APR_DECLARE(apr_status_t) apr_escape_entity(char *escaped, const char *str,
/**
* Apply entity encoding to a string, returning the result from a pool.
- * Characters are replaced as follows: '<' becomes '&lt;', '>' becomes
- * '&gt;', '&' becomes '&amp;', the double quote becomes '&quot;" and the
- * single quote becomes '&apos;'.
+ * Characters are replaced as follows: '<' becomes '\&lt;', '>' becomes
+ * '\&gt;', '&' becomes '\&amp;', the double quote becomes '\&quot;" and the
+ * single quote becomes '\&apos;'.
* @param p Pool to allocate from
* @param str The original string
* @param toasc If non zero, encode non ascii characters