Documentation: add Itdb_Thumb (NEEDS WORK, Christophe :)

1 files changed, 26 insertions, 19 deletions

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;