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

diff --git a/gio/ChangeLog b/gio/ChangeLog
index b447dc40493122485d9bb3d2e0ed46c1033782f9..dd6b5841824cf74d9d949108c177cff13bc9f142 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -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.

diff --git a/gio/gcontenttype.c b/gio/gcontenttype.c
index 31d5e836ab7038045fcf1295d58748f7d7546356..0dfbeeaf29a0783e8190e50a74e635e1bb69c614 100644 (file)
--- a/gio/gcontenttype.c
+++ b/gio/gcontenttype.c
@@ -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 *

diff --git a/gio/gdrive.c b/gio/gdrive.c
index eec59484324510d5cdc72069e17987510b0154b2..ca792910102ddef9e83528e743ca977c7dadc840 100644 (file)
--- a/gio/gdrive.c
+++ b/gio/gdrive.c
@@ -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

diff --git a/gio/gmount.c b/gio/gmount.c
index b6f0df1751e13df2099dc1d8fd688b63ae923e43..8c0e0d174384b798b1ce812fa093cc81c92ab435 100644 (file)
--- a/gio/gmount.c
+++ b/gio/gmount.c
@@ -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

diff --git a/gio/gvolumemonitor.c b/gio/gvolumemonitor.c
index 3aafee0db14d1a1664cc74ae831adfea08998a33..aaadcb3f224fa791d0b700ee606cfb79a711e128 100644 (file)
--- a/gio/gvolumemonitor.c
+++ b/gio/gvolumemonitor.c
@@ -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);