Expanded the g_file_new_for_commandline_arg description a bit, based on

2008-01-01  Wouter Bolsterlee  <wbolster@svn.gnome.org>

	* gfile.c: Expanded the g_file_new_for_commandline_arg
	description a bit, based on the code and the docs of the
	other g_file_new_for_* functions.

svn path=/trunk/; revision=6229

diff --git a/gio/ChangeLog b/gio/ChangeLog
index b6a74a89afefd1292c905db22e717b72da11332e..3632e0a22e3d7c3ef82443dcb53afae6bf4073f1 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,9 @@
+2008-01-01  Wouter Bolsterlee  <wbolster@svn.gnome.org>
+
+       * gfile.c: Expanded the g_file_new_for_commandline_arg
+       description a bit, based on the code and the docs of the
+       other g_file_new_for_* functions.
+
 2007-12-31  Wouter Bolsterlee  <wbolster@svn.gnome.org>
 
        * gfilemonitor.h: Fixed typo in docs.

diff --git a/gio/gfile.c b/gio/gfile.c
index defead7726c7b01317c39fc2ba31c92b863e2236..45d9f9230018bea37c10bcadc014035140c93b88 100644 (file)
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -3970,9 +3970,12 @@ has_valid_scheme (const char *uri)
  * g_file_new_for_commandline_arg:
  * @arg: a command line string.
  * 
- * Creates a #GFile with the given argument from
- * the command line. 
- * 
+ * Creates a #GFile with the given argument from the command line. The value of
+ * @arg can be either a URI, an absolute path or a relative path resolved
+ * relative to the current working directory.
+ * This operation never fails, but the returned object might not support any
+ * I/O operation if @arg points to a malformed path.
+ *
  * Returns: a new #GFile. 
  **/
 GFile *