itdb_thumb_to_pixbufs API doc

git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@2071 f01d2545-417e-4e96-918e-98f8d0dbbcb6

1 files changed, 17 insertions, 0 deletions

diff --git a/src/itdb_thumb.c b/src/itdb_thumb.c
index b55fe6c..7e8716b 100644
--- a/src/itdb_thumb.c
+++ b/src/itdb_thumb.c
@@ -525,6 +525,23 @@ static GList *itdb_thumb_ipod_to_pixbufs (Itdb_Device *dev, Itdb_Thumb_Ipod *thu
         return pixbufs;
 }
 
+/**
+ * itdb_thumb_to_pixbufs:
+ * @device: an #Itdb_Device
+ * @thumb: an #Itdb_Thumb
+ * 
+ * Return value: a #GList of #GdkPixbuf which are associated with @thumb, NULL
+ * if the pixbuf was invalid or if libgpod is compiled without gdk-pixbuf
+ * support. The #GdkPixbuf must be unreffed with gdk_pixbuf_unref() after use 
+ * and the #GList must be freed with g_list_free().
+ *
+ * Converts @thumb to a #GList of #GdkPixbuf. The returned #GList will
+ * generally contain only 1 element, the full-size pixbuf associated with
+ * @thumb, but when the artwork has been read from the ipod and hasn't been
+ * modified from the library, then the returned #GList will contain several
+ * #GdkPixbuf corresponding to the various thumbnail sizes that were
+ * written to the iPod database.
+ **/
 GList *itdb_thumb_to_pixbufs (Itdb_Device *dev, Itdb_Thumb *thumb)
 {
     GList *pixbufs = NULL;