vendor/apr/apr-1.7.0vendor/apr

1 files changed, 13 insertions, 0 deletions

diff --git a/include/apr_escape.h b/include/apr_escape.h
index 428a8cb6bd88..ed048c956d25 100644
--- a/include/apr_escape.h
+++ b/include/apr_escape.h
@@ -33,6 +33,19 @@ extern "C" {
 
 /* Simple escape/unescape functions.
  *
+ * The design goal of these functions are:
+ *
+ * - Avoid unnecessary work.
+ *
+ * In most cases the strings passed in do not need to be escaped at all. In
+ * these cases the original string will be returned.
+ *
+ * - Lowest possible memory footprint.
+ *
+ * The amount of memory allocated for a given encoding is calculated based
+ * on the exact amount of memory needed, and not the theoretical worst case
+ * scenario.
+ *
  */
 
 /**