[libmediaart] docs: Last minute fixes before a release

[Martyn James Russell <mr src gnome org>]

commit a687fc3ec5a1e15dad4fff7874ae93327f1a9923
Author: Martyn Russell <martyn lanedo com>
Date:   Mon Oct 21 08:54:36 2013 +0100

    docs: Last minute fixes before a release

 libmediaart/extract.c |   36 +++++++++++++++++++++++++-----------
 libmediaart/storage.c |   14 +++++++-------
 libmediaart/storage.h |    6 +++---
 3 files changed, 35 insertions(+), 21 deletions(-)
---
diff --git a/libmediaart/extract.c b/libmediaart/extract.c
index 5164ce1..faecba6 100644
--- a/libmediaart/extract.c
+++ b/libmediaart/extract.c
@@ -43,11 +43,12 @@
  * @include: libmediaart/mediaart.h
  *
  * The libmediaart library supports taking image data that you have extracted
- * from a media file and saving it into the media art cache, so that in future
+ * from a media file and saving it into the media art cache, so that future
  * applications can display the media art without having to extract the image
- * again. This is done using the media_art_process_file() function.
+ * again. This is done using the media_art_process_file() or
+ * media_art_process() functions.
  *
- * Extracting the media art from the file needs to be done by your application.
+ * Extracting new media art from a file needs to be done by your application.
  * Usually, when an application loads a media file any embedded images will be
  * made available as a side effect. For example, if you are using GStreamer any
  * images will be returned through the #GstTagList interface as %GST_TAG_IMAGE
@@ -55,14 +56,16 @@
  *
  * The media art cache requires that all images are saved as 'application/jpeg'
  * files. Embedded images can be in several formats, and
- * media_art_process_file() will convert the supplied image data into the
- * correct format if necessary. There are multiple backends that can be used
- * for this, and you can choose which is used at build time using the library's
+ * media_art_process_file() and media_art_process() functions will
+ * convert the supplied image data into the correct format if
+ * necessary. There are multiple backends that can be used for this,
+ * and you can choose which is used at build time using the library's
  * 'configure' script.
  *
- * If there is no embedded media art in a file, media_art_process_file() will
- * look in the directory that contains the media file for likely media art
- * using a simple heuristic.
+ * If there is no embedded media art in a file,
+ * media_art_process_file() and media_art_process() functions will
+ * look in the directory that contains the media file for likely media
+ * art using a simple heuristic.
  *
  * You must call media_art_init() before using the functions in libmediaart,
  * and call media_art_shutdown() to free the resources it uses.
@@ -1049,9 +1052,14 @@ media_art_queue_cb (GObject      *source_object,
 /**
  * media_art_init:
  *
- * Initialise libmediaart.
+ * Initialize libmediaart.
+ *
+ * This function initializes cache hash tables, backend plugins,
+ * storage modules used for removable devices and connections to D-Bus.
  *
  * Returns: %TRUE if initialisation was successful, %FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 media_art_init (void)
@@ -1088,7 +1096,9 @@ media_art_init (void)
 /**
  * media_art_shutdown:
  *
- * Free the image processing backend and other resources used by libmediaart.
+ * Clean up and free the resources created and mentioned in media_art_init().
+ *
+ * Since: 0.2.0
  */
 void
 media_art_shutdown (void)
@@ -1212,6 +1222,8 @@ get_mtime_by_uri (const gchar *uri)
  * cache on the removable file system rather than on the host machine.
  *
  * Returns: #TRUE if the file could be processed.
+ *
+ * Since: 0.2.0
  */
 gboolean
 media_art_process_file (const guchar *buffer,
@@ -1369,6 +1381,8 @@ media_art_process_file (const guchar *buffer,
  * a string rather than a #GFile object.
  *
  * Returns: %TRUE in case of success, %FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 media_art_process (const unsigned char *buffer,
diff --git a/libmediaart/storage.c b/libmediaart/storage.c
index 47df9ad..feb22f6 100644
--- a/libmediaart/storage.c
+++ b/libmediaart/storage.c
@@ -30,7 +30,7 @@
 /**
  * SECTION:-storage
  * @short_description: Removable storage and mount point convenience API
- * @include: lib-miner/-miner.h
+ * @include: libmediaart/mediaart.h
  *
  * This API is a convenience to to be able to keep track of volumes
  * which are mounted and also the type of removable media available.
@@ -845,7 +845,7 @@ mount_pre_removed_cb (GVolumeMonitor *monitor,
  *
  * Returns: The newly created #Storage.
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 Storage *
 storage_new (void)
@@ -897,7 +897,7 @@ get_mount_point_by_uuid_foreach (gpointer key,
  * @exact_match. Each element must be freed using g_free() and the
  * list itself through g_slist_free().
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 GSList *
 storage_get_device_roots (Storage     *storage,
@@ -933,7 +933,7 @@ storage_get_device_roots (Storage     *storage,
  * on @exact_match. Each element must be freed using g_free()
  * and the list itself through g_slist_free().
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 GSList *
 storage_get_device_uuids (Storage     *storage,
@@ -982,7 +982,7 @@ storage_get_device_uuids (Storage     *storage,
  *
  * Returns: The mount point for @uuid, this should not be freed.
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 const gchar *
 storage_get_mount_point_for_uuid (Storage     *storage,
@@ -1015,7 +1015,7 @@ storage_get_mount_point_for_uuid (Storage     *storage,
  *
  * Returns: The type flags for @uuid.
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 StorageType
 storage_get_type_for_uuid (Storage     *storage,
@@ -1058,7 +1058,7 @@ storage_get_type_for_uuid (Storage     *storage,
  * Returns: Returns the UUID of the removable device for @file, this
  * should not be freed.
  *
- * Since: 0.2
+ * Since: 0.2.0
  **/
 const gchar *
 storage_get_uuid_for_file (Storage *storage,
diff --git a/libmediaart/storage.h b/libmediaart/storage.h
index 0774075..e4678ad 100644
--- a/libmediaart/storage.h
+++ b/libmediaart/storage.h
@@ -36,7 +36,7 @@ G_BEGIN_DECLS
  *
  * Flags specifying properties of the type of storage.
  *
- * Since: 0.8
+ * Since: 0.2.0
  */
 typedef enum {
        STORAGE_REMOVABLE = 1 << 0,
@@ -51,7 +51,7 @@ typedef enum {
  *
  * Returns: %TRUE if the storage is marked as removable media, %FALSE otherwise
  *
- * Since: 0.10
+ * Since: 0.2.0
  */
 #define STORAGE_TYPE_IS_REMOVABLE(type) ((type & STORAGE_REMOVABLE) ? TRUE : FALSE)
 
@@ -63,7 +63,7 @@ typedef enum {
  *
  * Returns: %TRUE if the storage is marked as optical disc, %FALSE otherwise
  *
- * Since: 0.10
+ * Since: 0.2.0
  */
 #define STORAGE_TYPE_IS_OPTICAL(type) ((type & STORAGE_OPTICAL) ? TRUE : FALSE)