docs: Clarify string encoding for GFile constructors
authorBenjamin Otte <otte@redhat.com>
Fri, 10 Sep 2010 22:12:13 +0000 (00:12 +0200)
committerBenjamin Otte <otte@redhat.com>
Fri, 10 Sep 2010 22:13:36 +0000 (00:13 +0200)
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

index 9fd10ca..b97ada2 100644 (file)
@@ -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