diff options
| author | Todd Zullinger <tmz@pobox.com> | 2008-07-17 14:26:29 -0400 |
|---|---|---|
| committer | Todd Zullinger <tmz@pobox.com> | 2008-11-14 12:12:57 -0500 |
| commit | 952af46f2c179bb3de51f0f4b903b3c57e4442ee (patch) | |
| tree | ab6ba7e8c77461ca9d2c00f9978ad7578702fea9 /src/itdb_artwork.c | |
| parent | f6f1ddc8a49ce9424f9fe67e889c0cfaa8cde4d9 (diff) | |
| download | libgpod-tmz-952af46f2c179bb3de51f0f4b903b3c57e4442ee.tar.gz libgpod-tmz-952af46f2c179bb3de51f0f4b903b3c57e4442ee.tar.xz libgpod-tmz-952af46f2c179bb3de51f0f4b903b3c57e4442ee.zip | |
Documentation: update API docs
Add new functions to the proper places in the documentation, remove
old/unused functions, and clean up various minor issues.
Diffstat (limited to 'src/itdb_artwork.c')
| -rw-r--r-- | src/itdb_artwork.c | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/src/itdb_artwork.c b/src/itdb_artwork.c index db895d7..00ed62d 100644 --- a/src/itdb_artwork.c +++ b/src/itdb_artwork.c @@ -117,8 +117,7 @@ itdb_artwork_remove_thumbnails (Itdb_Artwork *artwork) /** * itdb_artwork_set_thumbnail - * @artwork: an #Itdb_Thumbnail - * @type: thumbnail size + * @artwork: an #Itdb_Artwork * @filename: image file to use to create the thumbnail * @rotation: angle by which the image should be rotated * counterclockwise. Valid values are 0, 90, 180 and 270. @@ -176,16 +175,15 @@ itdb_artwork_set_thumbnail (Itdb_Artwork *artwork, /** * itdb_artwork_set_thumbnail_from_pixbuf - * @artwork: an #Itdb_Thumbnail + * @artwork: an #Itdb_Artwork * @pixbuf: #GdkPixbuf to use to create the thumbnail * @rotation: angle by which the image should be rotated * counterclockwise. Valid values are 0, 90, 180 and 270. * @error: return location for a #GError or NULL * - * Appends a thumbnail of type @type to existing thumbnails in @artwork. No - * data is generated from @pixbuf yet, it will be done when @artwork is saved - * to disk. @pixbuf is ref'ed by this function, but is not copied, so it should - * not be modified before the database is saved. + * Set a thumbnail in @artwork. No data is generated from @pixbuf yet, it will + * be done when @artwork is saved to disk. @pixbuf is ref'ed by this function, + * but is not copied, so it should not be modified before the database is saved. * * For the rotation angle you can also use the gdk constants * GDK_PIXBUF_ROTATE_NONE, ..._COUNTERCLOCKWISE, ..._UPSIDEDOWN AND @@ -235,7 +233,7 @@ itdb_artwork_set_thumbnail_from_pixbuf (Itdb_Artwork *artwork, /** * itdb_artwork_set_thumbnail_from_data - * @artwork: an #Itdb_Thumbnail + * @artwork: an #Itdb_Artwork * @image_data: data used to create the thumbnail (the raw contents of * an image file) * @image_data_len: length of above data block @@ -243,9 +241,8 @@ itdb_artwork_set_thumbnail_from_pixbuf (Itdb_Artwork *artwork, * counterclockwise. Valid values are 0, 90, 180 and 270. * @error: return location for a #GError or NULL * - * Appends a thumbnail of type @type to existing thumbnails in - * @artwork. No data is processed yet. This will be done when @artwork - * is saved to disk. + * Set a thumbnail in @artwork. No data is processed yet. This will be done when + * @artwork is saved to disk. * * For the rotation angle you can also use the gdk constants * GDK_PIXBUF_ROTATE_NONE, ..._COUNTERCLOCKWISE, ..._UPSIDEDOWN AND @@ -881,12 +878,11 @@ gpointer itdb_thumb_ipod_item_to_pixbuf (Itdb_Device *device, #endif /** - * itdb_artwork_get_thumbnail! + * itdb_artwork_get_pixbuf: * @artwork: an #Itdb_Artwork - * + * @device: an #Itdb_Device * @width: width of the pixbuf to retrieve, -1 for the biggest * possible size and 0 for the smallest possible size (with no scaling) - * * @height: height of the pixbuf to retrieve, -1 for the biggest possible size * and 0 for the smallest possible size (with no scaling) * |