[glib] docs: Clarify string encoding for GFile constructors



commit 1254104cea92c02f3d0e9cf10b99382dd7e71439
Author: Benjamin Otte <otte redhat com>
Date:   Sat Sep 11 00:12:13 2010 +0200

    docs: Clarify string encoding for GFile constructors
    
    The encoding was deduced from looking at the source code, feel free to
    fix if it's wrong (the docs _and_ the source code).

 gio/gfile.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/gio/gfile.c b/gio/gfile.c
index 9fd10ca..b97ada2 100644
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -5882,7 +5882,8 @@ g_file_real_copy_finish (GFile        *file,
 
 /**
  * g_file_new_for_path:
- * @path: a string containing a relative or absolute path.
+ * @path: a string containing a relative or absolute path. The string
+ *   must be encoded in the glib filename encoding.
  * 
  * Constructs a #GFile for a given path. This operation never
  * fails, but the returned object might not support any I/O
@@ -5900,7 +5901,7 @@ g_file_new_for_path (const char *path)
  
 /**
  * g_file_new_for_uri:
- * @uri: a string containing a URI.
+ * @uri: a UTF8 string containing a URI.
  * 
  * Constructs a #GFile for a given URI. This operation never 
  * fails, but the returned object might not support any I/O 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]