glib r6330 - trunk/gio

[murrayc svn gnome org]

Author: murrayc
Date: Thu Jan 17 23:43:31 2008
New Revision: 6330
URL: http://svn.gnome.org/viewvc/glib?rev=6330&view=rev

Log:
2008-01-18  Murray Cumming  <murrayc murrayc com>

* gio/gvolumemonitor.c: 
(g_volume_monitor_get_connected_drives): 
(g_volume_monitor_get_volumes): 
(g_volume_monitor_get_mounts): Documentation: 
Clarify the ownership of the regurn GLists.

Modified:
   trunk/gio/ChangeLog
   trunk/gio/gvolumemonitor.c

Modified: trunk/gio/gvolumemonitor.c
==============================================================================
--- trunk/gio/gvolumemonitor.c	(original)
+++ trunk/gio/gvolumemonitor.c	Thu Jan 17 23:43:31 2008
@@ -238,8 +238,11 @@
  * @volume_monitor: a #GVolumeMonitor.
  * 
  * Gets a list of drives connected to the system.
+ *
+ * The returned list should be freed with g_list_free(), but
+ * its elements need not be freed.
  * 
- * Returns: a #GList of connected #GDrives. 
+ * Returns: a #GList of connected #GDrives - free with g_list_free(). 
  **/
 GList *
 g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor)
@@ -258,8 +261,11 @@
  * @volume_monitor: a #GVolumeMonitor.
  * 
  * Gets a list of the volumes on the system.
+ *
+ * The returned list should be freed with g_list_free(), but
+ * its elements need not be freed.
  * 
- * Returns: a #GList of #GVolume.
+ * Returns: a #GList of #GVolume - free with g_list_free().
  **/
 GList *
 g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor)
@@ -278,8 +284,11 @@
  * @volume_monitor: a #GVolumeMonitor.
  * 
  * Gets a list of the mounts on the system.
+ *
+ * The returned list should be freed with g_list_free(), but
+ * its elements need not be freed.
  * 
- * Returns: a #GList of #GMount.
+ * Returns: a #GList of #GMount - free with g_list_free().
  **/
 GList *
 g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor)