glibmm r511 - in trunk: . glib/src

[murrayc svn gnome org]

Author: murrayc
Date: Tue Jan 15 13:52:24 2008
New Revision: 511
URL: http://svn.gnome.org/viewvc/glibmm?rev=511&view=rev

Log:
2008-01-15  Murray Cumming  <murrayc murrayc com>

* glib/src/uriutils.hg: Improved the documentation for uri_unescape_string(), 
based on the improved C documentation.

Modified:
   trunk/ChangeLog
   trunk/glib/src/uriutils.hg

Modified: trunk/glib/src/uriutils.hg
==============================================================================
--- trunk/glib/src/uriutils.hg	(original)
+++ trunk/glib/src/uriutils.hg	Tue Jan 15 13:52:24 2008
@@ -34,9 +34,14 @@
 
 
 /** Unescapes a whole escaped string.
+ * If any of the characters in @a illegal_characters or the character zero appears
+ * as an escaped character in @a escaped_string then that is an error and an empty string 
+ * will be returned. This is useful it you want to avoid, for instance, having a
+ * slash being expanded in an escaped path element, which might confuse pathname
+ * handling.
  *
  * @param escaped_string An escaped string to be unescaped.
- * @param illegal_characters A string of illegal characters not to be allowed.
+ * @param illegal_characters An optional string of illegal characters not to be allowed.
  * @result An unescaped version of @a escaped_string.
  * 
  * @ingroup UriUtils