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
This commit is contained in:
Murray Cumming 2008-01-17 23:43:31 +00:00 committed by Murray Cumming
parent ee7ff848c7
commit acf029139d
2 changed files with 20 additions and 3 deletions

View File

@ -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:

View File

@ -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)