Documentation: Clarify the ownership of the regurn GLists.

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.

svn path=/trunk/; revision=6330

diff --git a/gio/ChangeLog b/gio/ChangeLog
index cf3a4ad..a3c6c7b 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,11 @@
+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.
+
 2008-01-17  Alexander Larsson  <alexl@redhat.com>
 
         * gfile.h:

diff --git a/gio/gvolumemonitor.c b/gio/gvolumemonitor.c
index 2724e68..eb219b7 100644 (file)
--- a/gio/gvolumemonitor.c
+++ b/gio/gvolumemonitor.c
@@ -238,8 +238,11 @@ g_volume_monitor_init (GVolumeMonitor *monitor)
  * @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 @@ g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor)
  * @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 @@ g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor)
  * @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)