[tracker/tracker-0.10] libtracker-miner: Document newly added functions

[Martyn James Russell <mr src gnome org>]

commit 5031f594d932d339de7ebafb1488fbea5201e4fd
Author: Philip Van Hoof <philip codeminded be>
Date:   Wed May 18 14:21:53 2011 +0200

    libtracker-miner: Document newly added functions

 src/libtracker-common/tracker-albumart.c |   26 ++++++++++++++++++++++++++
 src/libtracker-miner/tracker-albumart.c  |    8 ++++----
 2 files changed, 30 insertions(+), 4 deletions(-)
---
diff --git a/src/libtracker-common/tracker-albumart.c b/src/libtracker-common/tracker-albumart.c
index c9c9e03..24471ce 100644
--- a/src/libtracker-common/tracker-albumart.c
+++ b/src/libtracker-common/tracker-albumart.c
@@ -74,6 +74,18 @@ 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.
+ *
+ * Returns: copy of original but then stripped
+ *
+ * Since: 0.10.4
+ */
 gchar *
 tracker_albumart_strip_invalid_entities (const gchar *original)
 {
@@ -188,6 +200,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.4
+ */
 void
 tracker_albumart_get_path (const gchar  *artist,
                            const gchar  *album,
diff --git a/src/libtracker-miner/tracker-albumart.c b/src/libtracker-miner/tracker-albumart.c
index b7e5af5..7a041d2 100644
--- a/src/libtracker-miner/tracker-albumart.c
+++ b/src/libtracker-miner/tracker-albumart.c
@@ -143,11 +143,11 @@ on_error:
  * @mime_type: mime-type of the file
  *
  * Adds a new request to tell the albumart subsystem that @uri was removed.
- * Stored requests can be processed with tracker_thumbnailer_process().
+ * Stored requests can be processed with tracker_albumart_check_cleanup().
  *
  * Returns: #TRUE if successfully stored to be reported, #FALSE otherwise.
  *
- * Since: 0.8
+ * Since: 0.10.4
  */
 gboolean
 tracker_albumart_remove_add (const gchar *uri,
@@ -192,11 +192,11 @@ on_timer_destroy (gpointer data)
 }
 
 /**
- * tracker_albumart_process:
+ * tracker_albumart_check_cleanup:
  *
  * Process all stored albumart requests.
  *
- * Since: 0.10
+ * Since: 0.10.4
  */
 void
 tracker_albumart_check_cleanup (TrackerSparqlConnection *connection)