Re: patch nag, work in progress: documentation updates

[Alexander Larsson <alexl redhat com>]

On Mon, 2006-04-03 at 11:12 +0200, Christian Neumair wrote:
> Bug 337005 [1] has a patch that provides a major documentation update.
> The target is to get 80% symbol coverage for GnomeVFS 2.14.2 and 95%
> symbol coverage for GnomeVFS 2.16.
> 
> [1] http://bugzilla.gnome.org/show_bug.cgi?id=337005

@@ -193,6 +239,7 @@ gnome_vfs_drive_finalize (GObject *objec
 	g_free (priv->device_path);
 	g_free (priv->activation_uri);
 	g_free (priv->display_name);
+	g_free (priv->display_name_key);
 	g_free (priv->icon);
 	g_free (priv->hal_udi);
 	g_free (priv->hal_drive_udi);

Leftovers from other patch

+ * @GNOME_VFS_MONITOR_DIRECTORY: the monitor is registered for all files in a directory,
+ * 				 and the diectory itself.

typo

+/**
+ * GNOME_VFS_VOLUME:
+ * @object: the #GObject to cast
+ *
+ * Casts the #GObject @object to a #GnomeVFSVolume.
+ **/

We don't document standard gobject macros like this.

diff -u -p -r1.136 gnome-vfs-xfer.c
--- libgnomevfs/gnome-vfs-xfer.c	20 Mar 2006 12:16:54 -0000	1.136
+++ libgnomevfs/gnome-vfs-xfer.c	3 Apr 2006 09:02:09 -0000
@@ -1507,6 +1507,7 @@ copy_file (GnomeVFSFileInfo *info,
 					 skip);
 	}
 
+	/* TODO use GNOME_VFS_XFER_PHASE_CLOSESOURCE and GNOME_VFS_XFER_PHASE_CLOSETARGET? */
 	if (result == GNOME_VFS_OK 
 		&& call_progress_often (progress, GNOME_VFS_XFER_PHASE_CLOSETARGET) == 0) {
 		result = GNOME_VFS_ERROR_INTERRUPTED;
@@ -1886,6 +1887,7 @@ copy_items (const GList *source_uri_list
 		gnome_vfs_file_info_unref (info);
 
 		if (result != GNOME_VFS_OK) {
+			/* TODO error handling in move_items and link_items works differently. */
 			break;
 		}

I haven't looked at these TODO, but lets leave them out for now.

Otherwise this looks good to commit, from a quick glance.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 Alexander Larsson                                            Red Hat, Inc 
                   alexl redhat com    alla lysator liu se 
He's a leather-clad voodoo photographer plagued by the memory of his family's 
brutal murder. She's a chain-smoking cigar-chomping magician's assistant with 
someone else's memories. They fight crime!