[tracker/cleanup-media-art] libtracker-common: Document functions that were made public



commit eef7de28e5bdafdf3a5167fce999fb61f2c7bd7c
Author: Philip Van Hoof <philip codeminded be>
Date:   Wed May 18 14:25:49 2011 +0200

    libtracker-common: Document functions that were made public

 src/libtracker-common/tracker-albumart.c |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)
---
diff --git a/src/libtracker-common/tracker-albumart.c b/src/libtracker-common/tracker-albumart.c
index c9c9e03..9167010 100644
--- a/src/libtracker-common/tracker-albumart.c
+++ b/src/libtracker-common/tracker-albumart.c
@@ -74,6 +74,16 @@ albumart_strip_find_next_block (const gchar    *original,
 	return FALSE;
 }
 
+/**
+ * tracker_albumart_strip_invalid_entities:
+ * @original: original string
+ *
+ * Strip a albumname or artistname string to prepare it for calculating the
+ * albumart path with it. Certain characters and charactersets will be stripped
+ * and a newly allocated string returned which you must free with g_free.
+ *
+ * Since: 0.10
+ */
 gchar *
 tracker_albumart_strip_invalid_entities (const gchar *original)
 {
@@ -188,6 +198,20 @@ albumart_checksum_for_data (GChecksumType  checksum_type,
 	return retval;
 }
 
+/**
+ * tracker_albumart_get_path:
+ * @artist: the artist
+ * @album: the album
+ * @prefix: For example "album"
+ * @uri: NULL or the uri of the file
+ * @path: the location to store the local path
+ * @local_uri: the location to store the local uri or NULL
+ *
+ * Get the path to albumart for a given album or song. Newly allocated data in
+ * @path and @local_uri must be freed with g_free.
+ *
+ * Since: 0.10
+ */
 void
 tracker_albumart_get_path (const gchar  *artist,
                            const gchar  *album,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]