Documentation: add Itdb_Thumb (NEEDS WORK, Christophe :)

3 files changed, 35 insertions, 28 deletions

diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt
index a3af722..ded27a0 100644
--- a/docs/reference/libgpod-sections.txt
+++ b/docs/reference/libgpod-sections.txt
@@ -197,7 +197,6 @@ Itdb_ArtworkFormat
 <FILE>artwork</FILE>
 <TITLE>Artwork</TITLE>
 Itdb_Artwork
-Itdb_Thumb
 itdb_artwork_new
 itdb_artwork_duplicate
 itdb_artwork_free
@@ -206,6 +205,7 @@ itdb_artwork_set_thumbnail
 itdb_artwork_set_thumbnail_from_data
 itdb_artwork_set_thumbnail_from_pixbuf
 itdb_artwork_remove_thumbnails
+Itdb_Thumb
 itdb_thumb_duplicate
 itdb_thumb_free
 itdb_thumb_to_pixbuf_at_size
diff --git a/docs/reference/tmpl/artwork.sgml b/docs/reference/tmpl/artwork.sgml
index 70cdc4a..00a87f3 100644
--- a/docs/reference/tmpl/artwork.sgml
+++ b/docs/reference/tmpl/artwork.sgml
@@ -42,14 +42,6 @@ album/track artwork.  For working with photos, see the
 @userdata_duplicate: 
 @userdata_destroy: 
 
-<!-- ##### STRUCT Itdb_Thumb ##### -->
-<para>
-
-</para>
-
-@data_type: 
-@rotation: 
-
 <!-- ##### FUNCTION itdb_artwork_new ##### -->
 <para>
 
@@ -132,6 +124,14 @@ album/track artwork.  For working with photos, see the
 @artwork: 
 
 
+<!-- ##### STRUCT Itdb_Thumb ##### -->
+<para>
+
+</para>
+
+@data_type: 
+@rotation: 
+
 <!-- ##### FUNCTION itdb_thumb_duplicate ##### -->
 <para>
 
diff --git a/src/itdb_thumb.h b/src/itdb_thumb.h
index 09dd04e..27c7fc6 100644
--- a/src/itdb_thumb.h
+++ b/src/itdb_thumb.h
@@ -35,25 +35,32 @@ typedef enum {
     ITDB_THUMB_TYPE_IPOD
 } ItdbThumbDataType;
 
-/* The Itdb_Thumb structure can represent two slightly different
-   thumbnails:
-
-  a) a thumbnail before it's transferred to the iPod.
-
-     offset and size are 0
-
-     width and height, if unequal 0, will indicate the size on the
-     iPod. width and height are set the first time a pixbuf is
-     requested for this thumbnail.
-
-     type is set according to the type this thumbnail represents
-
-     filename point to a 'real' image file OR image_data and
-     image_data_len are set.
- 
-  b) a thumbnail (big or small) stored on a database in the iPod.  In
-     these cases, id corresponds to the ID originally used in the
-     database, filename points to a .ithmb file on the iPod
+/**
+ * Itdb_Thumb:
+ * @data_type: an #ItdbThumbDataType
+ * @rotation: angle by which the image is rotated counterclockwise
+ *
+ * The Itdb_Thumb structure can represent two slightly different
+ * thumbnails:
+ *
+ * a) a thumbnail before it's transferred to the iPod.
+ *
+ *    offset and size are 0
+ *
+ *    width and height, if unequal 0, will indicate the size on the
+ *    iPod. width and height are set the first time a pixbuf is
+ *    requested for this thumbnail.
+ *
+ *    type is set according to the type this thumbnail represents
+ *
+ *    filename point to a 'real' image file OR image_data and
+ *    image_data_len are set.
+ *
+ * b) a thumbnail (big or small) stored on a database in the iPod.  In
+ *    these cases, id corresponds to the ID originally used in the
+ *    database, filename points to a .ithmb file on the iPod
+ *
+ * Since: 0.3.0
  */
 struct _Itdb_Thumb {
     ItdbThumbDataType data_type;