Revision: 2346
          http://gtkpod.svn.sourceforge.net/gtkpod/?rev=2346&view=rev
Author:   teuf
Date:     2009-05-02 20:53:13 +0000 (Sat, 02 May 2009)

Log Message:
-----------
Add API doc to the cover art functions

Modified Paths:
--------------
    libgpod/trunk/ChangeLog
    libgpod/trunk/src/itdb_device.c

Modified: libgpod/trunk/ChangeLog
===================================================================
--- libgpod/trunk/ChangeLog     2009-05-02 19:23:13 UTC (rev 2345)
+++ libgpod/trunk/ChangeLog     2009-05-02 20:53:13 UTC (rev 2346)
@@ -1,5 +1,9 @@
 2009-05-02  Christophe Fergeau  <[email protected]>
 
+       * src/itdb_device.c: add API doc to the cover art functions
+
+2009-05-02  Christophe Fergeau  <[email protected]>
+
        Patch from: Erik Hovland <[email protected]>
 
        Remove or rework any dead code.

Modified: libgpod/trunk/src/itdb_device.c
===================================================================
--- libgpod/trunk/src/itdb_device.c     2009-05-02 19:23:13 UTC (rev 2345)
+++ libgpod/trunk/src/itdb_device.c     2009-05-02 20:53:13 UTC (rev 2346)
@@ -1106,6 +1106,15 @@
     return artwork_formats;
 }
 
+/**
+ * itdb_device_get_photo_formats:
+ * @device: an #Itdb_Device
+ *
+ * Returns: a #GList of #Itdb_ArtworkFormat describing the photo formats 
+ * supported by the iPod associated with @device. The returned list must
+ * be freed with g_list_free() when no longer needed.
+ *
+ **/
 GList *itdb_device_get_photo_formats (const Itdb_Device *device)
 {
     g_return_val_if_fail (device != NULL, NULL);
@@ -1119,6 +1128,15 @@
     g_return_val_if_reached (NULL);
 }
 
+/**
+ * itdb_device_get_cover_art_formats:
+ * @device: an #Itdb_Device
+ *
+ * Returns: a #GList of #Itdb_ArtworkFormat describing the cover art formats 
+ * supported by the iPod associated with @device. The returned list must
+ * freed with g_list_free() when no longer needed.
+ *
+ **/
 GList *itdb_device_get_cover_art_formats (const Itdb_Device *device)
 {
     g_return_val_if_fail (device != NULL, NULL);
@@ -1132,6 +1150,15 @@
     g_return_val_if_reached (NULL);
 }
 
+/**
+ * itdb_device_get_chapter_image_formats:
+ * @device: an #Itdb_Device
+ *
+ * Returns: a #GList of #Itdb_ArtworkFormat describing the chapter image 
+ * formats supported by the iPod associated with @device. The returned list
+ * must be freed with g_list_free() when no lonber needed.
+ *
+ **/
 GList *itdb_device_get_chapter_image_formats (const Itdb_Device *device)
 {
     g_return_val_if_fail (device != NULL, NULL);


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

------------------------------------------------------------------------------
Register Now & Save for Velocity, the Web Performance & Operations 
Conference from O'Reilly Media. Velocity features a full day of 
expert-led, hands-on workshops and two days of sessions from industry 
leaders in dedicated Performance & Operations tracks. Use code vel09scf 
and Save an extra 15% before 5/3. http://p.sf.net/sfu/velocityconf
_______________________________________________
gtkpod-cvs2 mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtkpod-cvs2

Reply via email to