glib r6304 - in trunk: . glib

[alexl svn gnome org]

Author: alexl
Date: Mon Jan 14 14:39:28 2008
New Revision: 6304
URL: http://svn.gnome.org/viewvc/glib?rev=6304&view=rev

Log:
2008-01-14  Alexander Larsson  <alexl redhat com>

        * glib/gurifuncs.c:
	Clarify docs for g_uri_escape_string (#508773)




Modified:
   trunk/ChangeLog
   trunk/glib/gurifuncs.c

Modified: trunk/glib/gurifuncs.c
==============================================================================
--- trunk/glib/gurifuncs.c	(original)
+++ trunk/glib/gurifuncs.c	Mon Jan 14 14:39:28 2008
@@ -200,6 +200,13 @@
  * @allow_utf8: %TRUE if the result can include UTF-8 characters.
  * 
  * Escapes a string for use in a URI.
+ *
+ * Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical
+ * characters plus dash, dot, underscore and tilde) are escaped.
+ * But if you specify characters in @reserved_chars_allowed they are not
+ * escaped. This is useful for the "reserved" characters in the URI
+ * specification, since those are allowed unescaped in some portions of
+ * a URI. 
  * 
  * Returns: an escaped version of @unescaped. The returned string should be 
  * freed when no longer needed.