Doc fixes

svn path=/trunk/; revision=7223

diff --git a/gio/ChangeLog b/gio/ChangeLog
index df12368..35a16c3 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,8 @@
+2008-07-20  Matthias Clasen  <mclasen@redhat.com>
+
+       * gvfs.c:
+       * gmount.c: Documentation fixes
+
 2008-07-19  Matthias Clasen  <mclasen@redhat.com>
 
        543504 – crash in Epiphany Web Browser: Opening local file

diff --git a/gio/gmount.c b/gio/gmount.c
index 6f15f7c..a5545a4 100644 (file)
--- a/gio/gmount.c
+++ b/gio/gmount.c
@@ -113,6 +113,7 @@ g_mount_base_init (gpointer g_class)
     {
      /**
       * GMount::changed:
+      * @mount: the object on which the signal is emitted
       * 
       * Emitted when the mount has been changed.
       **/
@@ -126,6 +127,7 @@ g_mount_base_init (gpointer g_class)
 
      /**
       * 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 @@ g_mount_unmount (GMount              *mount,
  * @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 @@ g_mount_eject (GMount              *mount,
  * @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 @@ g_mount_remount (GMount              *mount,
  * @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.

diff --git a/gio/gvfs.c b/gio/gvfs.c
index 3158d3d..df59c62 100644 (file)
--- a/gio/gvfs.c
+++ b/gio/gvfs.c
@@ -78,7 +78,8 @@ g_vfs_is_active (GVfs *vfs)
  * 
  * 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_path (GVfs       *vfs,
 /**
  * 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 @@ g_vfs_get_file_for_uri (GVfs       *vfs,
  * 
  * 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 @@ g_vfs_get_supported_uri_schemes (GVfs *vfs)
  * 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,