glib r7223 - trunk/gio

[matthiasc svn gnome org]

Author: matthiasc
Date: Mon Jul 21 02:19:56 2008
New Revision: 7223
URL: http://svn.gnome.org/viewvc/glib?rev=7223&view=rev

Log:
Doc fixes


Modified:
   trunk/gio/ChangeLog
   trunk/gio/gmount.c
   trunk/gio/gvfs.c

Modified: trunk/gio/gmount.c
==============================================================================
--- trunk/gio/gmount.c	(original)
+++ trunk/gio/gmount.c	Mon Jul 21 02:19:56 2008
@@ -113,6 +113,7 @@
     {
      /**
       * GMount::changed:
+      * @mount: the object on which the signal is emitted
       * 
       * Emitted when the mount has been changed.
       **/
@@ -126,6 +127,7 @@
 
      /**
       * GMount::unmounted:
+      * @mount: the object on which the signal is emitted
       * 
       * This signal is emitted when the #GMount have been
       * unmounted. If the recipient is holding references to the
@@ -368,7 +370,7 @@
  * @mount: a #GMount.
  * @result: a #GAsyncResult.
  * @error: a #GError location to store the error occuring, or %NULL to 
- * ignore.
+ *     ignore.
  * 
  * Finishes unmounting a mount. If any errors occurred during the operation, 
  * @error will be set to contain the errors and %FALSE will be returned.
@@ -443,7 +445,7 @@
  * @mount: a #GMount.
  * @result: a #GAsyncResult.
  * @error: a #GError location to store the error occuring, or %NULL to 
- * ignore.
+ *     ignore.
  * 
  * Finishes ejecting a mount. If any errors occurred during the operation, 
  * @error will be set to contain the errors and %FALSE will be returned.
@@ -525,7 +527,7 @@
  * @mount: a #GMount.
  * @result: a #GAsyncResult.
  * @error: a #GError location to store the error occuring, or %NULL to 
- * ignore.
+ *     ignore.
  * 
  * Finishes remounting a mount. If any errors occurred during the operation, 
  * @error will be set to contain the errors and %FALSE will be returned.

Modified: trunk/gio/gvfs.c
==============================================================================
--- trunk/gio/gvfs.c	(original)
+++ trunk/gio/gvfs.c	Mon Jul 21 02:19:56 2008
@@ -78,7 +78,8 @@
  * 
  * Gets a #GFile for @path.
  * 
- * Returns: a #GFile.
+ * Returns: a #GFile. 
+ *     Free the returned object with g_object_unref().
  **/
 GFile *
 g_vfs_get_file_for_path (GVfs       *vfs,
@@ -97,16 +98,16 @@
 /**
  * g_vfs_get_file_for_uri:
  * @vfs: a#GVfs.
- * @uri: a string containing a URI path.
+ * @uri: a string containing a URI 
  * 
  * Gets a #GFile for @uri.
  * 
  * This operation never fails, but the returned object
- * might not support any I/O operation if the uri
- * is malformed or if the uri type is not supported.
+ * might not support any I/O operation if the URI 
+ * is malformed or if the URI scheme is not supported.
  * 
  * Returns: a #GFile. 
- * 
+ *     Free the returned object with g_object_unref().
  **/
 GFile *
 g_vfs_get_file_for_uri (GVfs       *vfs,
@@ -128,7 +129,9 @@
  * 
  * Gets a list of URI schemes supported by @vfs.
  * 
- * Returns: a list of strings.
+ * Returns: a %NULL-terminated array of strings.
+ *     The returned array belongs to GIO and must 
+ *     not be freed or modified.
  **/
 const gchar * const *
 g_vfs_get_supported_uri_schemes (GVfs *vfs)
@@ -152,6 +155,7 @@
  * be parsed by the #GVfs module.
  * 
  * Returns: a #GFile for the given @parse_name.
+ *     Free the returned object with g_object_unref().
  **/
 GFile *
 g_vfs_parse_name (GVfs       *vfs,