Updates to GIO documentation. (#506395, Mikael Hermansson)

* gcontenttype.c: Describe memory management for return value of
g_content_types_get_registered(). Missing piece from #505815.
* gdrive.c, gmount.c, gvolumemonitor.c: Add more description to
GVolume, GDrive, GMounts, which hopefully gives the user less
confusions when using this API. Following explainations from
Alexander Larsson on gtk-devel-list.

svn path=/trunk/; revision=6222
This commit is contained in:
Mathias Hasselmann 2007-12-31 10:00:52 +00:00
parent de08b57f02
commit 9002395011
5 changed files with 28 additions and 5 deletions

View File

@ -1,3 +1,14 @@
2007-12-31 Mathias Hasselmann <mathias@openismus.com>
Updates to GIO documentation. (#506395, Mikael Hermansson)
* gcontenttype.c: Describe memory management for return value of
g_content_types_get_registered(). Missing piece from #505815.
* gdrive.c, gmount.c, gvolumemonitor.c: Add more description to
GVolume, GDrive, GMounts, which hopefully gives the user less
confusions when using this API. Following explainations from
Alexander Larsson on gtk-devel-list.
2007-12-30 Matthias Clasen <mclasen@redhat.com>
* gfileinfo.c: Expand the long description.

View File

@ -840,8 +840,8 @@ enumerate_mimetypes_dir (const char *dir,
* g_content_types_get_registered:
*
* Gets a list of strings containing all the registered content types
* known to the system.
*
* known to the system. The list and its data should be freed using
* @g_list_foreach(list, g_free, NULL) and @g_list_free(list)
* Returns: #GList of the registered content types.
**/
GList *

View File

@ -33,6 +33,10 @@
* @short_description: Virtual File System drive management
* @include: gio.h
*
* #GDrive - this represent a piece of hardware connected to the machine.
* Its generally only created for removable hardware or hardware with
* removable media.
*
* #GDrive is a container class for #GVolume objects that stem from
* the same piece of media. As such, #GDrive abstracts a drive with
* (or without) removable media and provides operations for querying

View File

@ -38,9 +38,15 @@
* SECTION:gmount
* @short_description: Mount management
* @include: gio.h
*
* @see also: GVolume, GUnixMount
*
* The #GMount interface represents user-visible mounts. Note, when
* porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume.
*
* #GMount is a "mounted" filesystem that you can access. Mounted is in
* quotes because its not the same as a unix mount, it might be a gvfs
* mount, but you can still access the files on it if you use GIO. Might or
* might not be related to a volume object.
*
* Unmounting a #GMount instance is an asynchronous operation. For
* more information about asynchronous operations, see #GAsyncReady

View File

@ -33,8 +33,10 @@
* @include: gio.h
* @see_also: #GDirectoryMonitor, #GFileMonitor
*
* Monitors a mounted volume for changes.
**/
* #GVolumeMonitor is for listing the user interesting devices and volumes
* on the computer. In other words, what a file selector or file manager
* would show in a sidebar.
**/
G_DEFINE_TYPE (GVolumeMonitor, g_volume_monitor, G_TYPE_OBJECT);