summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTodd Zullinger <tmz@pobox.com>2008-08-02 03:02:11 -0400
committerTodd Zullinger <tmz@pobox.com>2008-11-14 12:14:43 -0500
commit027db7e774dba3fa0b33efafe4c76a10e7da3b72 (patch)
treebaf806341052dbba706c097e1bbed567ad7341be
parentd570e71c1d2634ad3d7e0bd418ba3695b62dd418 (diff)
downloadlibgpod-tmz-027db7e774dba3fa0b33efafe4c76a10e7da3b72.tar.gz
libgpod-tmz-027db7e774dba3fa0b33efafe4c76a10e7da3b72.tar.xz
libgpod-tmz-027db7e774dba3fa0b33efafe4c76a10e7da3b72.zip
Documentation: mark functions added in 0.7.0
-rw-r--r--src/itdb.h4
-rw-r--r--src/itdb_artwork.c16
-rw-r--r--src/itdb_chapterdata.c36
-rw-r--r--src/itdb_device.c2
-rw-r--r--src/itdb_thumb.c8
-rw-r--r--src/itdb_track.c8
6 files changed, 57 insertions, 17 deletions
diff --git a/src/itdb.h b/src/itdb.h
index 9903518..5c4c6c7 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -737,6 +737,8 @@ struct _Itdb_SPLRules
* @reserved2: Reserved for future use
*
* Structure representing an iTunesDB Chapter
+ *
+ * Since: 0.7.0
*/
struct _Itdb_Chapter
{
@@ -761,6 +763,8 @@ struct _Itdb_Chapter
* @reserved2: Reserved for future use
*
* Structure representing iTunesDB Chapter data
+ *
+ * Since: 0.7.0
*/
struct _Itdb_Chapterdata
{
diff --git a/src/itdb_artwork.c b/src/itdb_artwork.c
index 09a5e9c..439002e 100644
--- a/src/itdb_artwork.c
+++ b/src/itdb_artwork.c
@@ -133,7 +133,9 @@ itdb_artwork_remove_thumbnails (Itdb_Artwork *artwork)
*
* Return value: TRUE if the thumbnail could be successfully added, FALSE
* otherwise. @error is set appropriately.
- **/
+ *
+ * Since: 0.7.0
+ */
gboolean
itdb_artwork_set_thumbnail (Itdb_Artwork *artwork,
const gchar *filename,
@@ -191,7 +193,9 @@ itdb_artwork_set_thumbnail (Itdb_Artwork *artwork,
*
* Return value: TRUE if the thumbnail could be successfully added, FALSE
* otherwise. @error is set appropriately.
- **/
+ *
+ * Since: 0.7.0
+ */
gboolean
itdb_artwork_set_thumbnail_from_pixbuf (Itdb_Artwork *artwork,
gpointer pixbuf,
@@ -250,7 +254,9 @@ itdb_artwork_set_thumbnail_from_pixbuf (Itdb_Artwork *artwork,
*
* Return value: TRUE if the thumbnail could be successfully added, FALSE
* otherwise. @error is set appropriately.
- **/
+ *
+ * Since: 0.7.0
+ */
gboolean
itdb_artwork_set_thumbnail_from_data (Itdb_Artwork *artwork,
const guchar *image_data,
@@ -894,7 +900,9 @@ gpointer itdb_thumb_ipod_item_to_pixbuf (Itdb_Device *device,
* Return value: a #GdkPixbuf that must be unreffed when no longer used, NULL
* if no artwork could be found or if libgpod is compiled without GdkPixbuf
* support
- **/
+ *
+ * Since: 0.7.0
+ */
gpointer itdb_artwork_get_pixbuf (Itdb_Device *device, Itdb_Artwork *artwork,
gint width, gint height)
{
diff --git a/src/itdb_chapterdata.c b/src/itdb_chapterdata.c
index c632ae0..99058c7 100644
--- a/src/itdb_chapterdata.c
+++ b/src/itdb_chapterdata.c
@@ -43,7 +43,9 @@
*
* Return value: a new #Itdb_Chapterdata to be freed with
* itdb_chapterdata_free() when no longer needed
- **/
+ *
+ * Since: 0.7.0
+ */
Itdb_Chapterdata *itdb_chapterdata_new (void)
{
Itdb_Chapterdata *chapterdata = g_new0 (Itdb_Chapterdata, 1);
@@ -55,7 +57,9 @@ Itdb_Chapterdata *itdb_chapterdata_new (void)
* @chapterdata: an #Itdb_Chapterdata
*
* Frees memory used by @chapterdata
- **/
+ *
+ * Since: 0.7.0
+ */
void itdb_chapterdata_free (Itdb_Chapterdata *chapterdata)
{
g_return_if_fail (chapterdata);
@@ -93,7 +97,9 @@ static GList *dup_chapters (GList *chapters)
* Duplicates @chapterdata
*
* Return value: a new copy of @chapterdata
- **/
+ *
+ * Since: 0.7.0
+ */
Itdb_Chapterdata *itdb_chapterdata_duplicate (Itdb_Chapterdata *chapterdata)
{
Itdb_Chapterdata *dup;
@@ -119,7 +125,9 @@ Itdb_Chapterdata *itdb_chapterdata_duplicate (Itdb_Chapterdata *chapterdata)
* @chapter: an #Itdb_Chapter
*
* Removes @chapter from @chapterdata. The memory used by @chapter is freed.
- **/
+ *
+ * Since: 0.7.0
+ */
void
itdb_chapterdata_remove_chapter (Itdb_Chapterdata *chapterdata, Itdb_Chapter *chapter)
{
@@ -135,7 +143,9 @@ itdb_chapterdata_remove_chapter (Itdb_Chapterdata *chapterdata, Itdb_Chapter *ch
* @chapterdata: an #Itdb_Chapterdata
*
* Removes all chapters from @chapterdata
- **/
+ *
+ * Since: 0.7.0
+ */
void
itdb_chapterdata_remove_chapters (Itdb_Chapterdata *chapterdata)
{
@@ -156,7 +166,9 @@ itdb_chapterdata_remove_chapters (Itdb_Chapterdata *chapterdata)
*
* Return Value: newly allocated #Itdb_Chapter to be freed with itdb_chapter_free()
* after use
- **/
+ *
+ * Since: 0.7.0
+ */
Itdb_Chapter *itdb_chapter_new (void)
{
Itdb_Chapter *chapter = g_new0 (Itdb_Chapter, 1);
@@ -168,7 +180,9 @@ Itdb_Chapter *itdb_chapter_new (void)
* @chapter: an #Itdb_Chapter
*
* Frees the memory used by @chapter
- **/
+ *
+ * Since: 0.7.0
+ */
void itdb_chapter_free (Itdb_Chapter *chapter)
{
g_return_if_fail (chapter);
@@ -185,7 +199,9 @@ void itdb_chapter_free (Itdb_Chapter *chapter)
*
* Return value: a newly allocated copy of @chapter to be freed with
* itdb_chapter_free() after use
- **/
+ *
+ * Since: 0.7.0
+ */
Itdb_Chapter *itdb_chapter_duplicate (Itdb_Chapter *chapter)
{
Itdb_Chapter *new_chapter;
@@ -209,7 +225,9 @@ Itdb_Chapter *itdb_chapter_duplicate (Itdb_Chapter *chapter)
*
* Return value: TRUE if the chapter could be successfully added, FALSE
* otherwise.
- **/
+ *
+ * Since: 0.7.0
+ */
gboolean
itdb_chapterdata_add_chapter (Itdb_Chapterdata *chapterdata,
gint32 startpos,
diff --git a/src/itdb_device.c b/src/itdb_device.c
index fb4d519..ea28056 100644
--- a/src/itdb_device.c
+++ b/src/itdb_device.c
@@ -1360,6 +1360,8 @@ gboolean itdb_device_supports_artwork (const Itdb_Device *device)
* Indicates whether @device can play videos or not.
*
* Return value: true if @device can play videos.
+ *
+ * Since: 0.7.0
*/
gboolean itdb_device_supports_video (const Itdb_Device *device)
{
diff --git a/src/itdb_thumb.c b/src/itdb_thumb.c
index 4eff766..d2919e1 100644
--- a/src/itdb_thumb.c
+++ b/src/itdb_thumb.c
@@ -370,7 +370,9 @@ const GList *itdb_thumb_ipod_get_thumbs (Itdb_Thumb_Ipod *thumbs)
* Return value: a #GdkPixbuf that must be unreffed with gdk_pixbuf_unref()
* after use, or NULL if the creation of the gdk-pixbuf failed or if
* libgpod was compiled without gdk-pixbuf support.
- **/
+ *
+ * Since: 0.7.0
+ */
gpointer itdb_thumb_to_pixbuf_at_size (Itdb_Device *device, Itdb_Thumb *thumb,
gint width, gint height)
{
@@ -540,7 +542,9 @@ static GList *itdb_thumb_ipod_to_pixbufs (Itdb_Device *device,
* 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().
- **/
+ *
+ * Since: 0.7.0
+ */
GList *itdb_thumb_to_pixbufs (Itdb_Device *device, Itdb_Thumb *thumb)
{
GList *pixbufs = NULL;
diff --git a/src/itdb_track.c b/src/itdb_track.c
index aabf89b..4053a93 100644
--- a/src/itdb_track.c
+++ b/src/itdb_track.c
@@ -621,7 +621,9 @@ Itdb_Track *itdb_track_id_tree_by_id (GTree *idtree, guint32 id)
* Determine if a @track has thumbnails
*
* Return value: TRUE if @track has artwork available, FALSE otherwise
- **/
+ *
+ * Since: 0.7.0
+ */
gboolean itdb_track_has_thumbnails (Itdb_Track *track)
{
g_return_val_if_fail (track != NULL, FALSE);
@@ -643,7 +645,9 @@ gboolean itdb_track_has_thumbnails (Itdb_Track *track)
* Return value: a #GdkPixbuf that must be unreffed when no longer used, NULL
* if no artwork could be found or if libgpod is compiled without GdkPixbuf
* support
- **/
+ *
+ * Since: 0.7.0
+ */
gpointer itdb_track_get_thumbnail (Itdb_Track *track, gint width, gint height)
{
g_return_val_if_fail (track != NULL, NULL);