[tracker] libtracker-miner: Fixed documentation errors and added some

[Martyn James Russell <mr src gnome org>]

commit 55ad5199aa63e02c1d35ce90cfca6385ecd8133d
Author: Martyn Russell <martyn lanedo com>
Date:   Wed Mar 31 13:19:14 2010 +0100

    libtracker-miner: Fixed documentation errors and added some
    
    Some major sections like tracker-password-provider, tracker-storage
    and tracker-thumbnailer had no section description.

 docs/reference/libtracker-miner/Makefile.am        |    4 +++
 .../libtracker-miner/libtracker-miner-sections.txt |   29 +-------------------
 src/libtracker-miner/tracker-password-provider.c   |   12 ++++++++
 src/libtracker-miner/tracker-password-provider.h   |    5 +--
 src/libtracker-miner/tracker-storage.c             |   10 +++++++
 src/libtracker-miner/tracker-thumbnailer.c         |   14 +++++++++
 6 files changed, 43 insertions(+), 31 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
index 8f9a644..7e4dbe6 100644
--- a/docs/reference/libtracker-miner/Makefile.am
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -24,9 +24,13 @@ CFILE_GLOB=$(top_srcdir)/src/libtracker-miner/*.c
 # Header files to ignore when scanning
 IGNORE_HFILES=								\
 	tracker-crawler.h						\
+	tracker-dbus.h							\
 	tracker-marshal.h						\
 	tracker-miner-client.h						\
+	tracker-miner-dbus.h						\
 	tracker-miner-glue.h						\
+	tracker-miner-web-dbus.h					\
+	tracker-miner-web-glue.h					\
 	tracker-miner-web-glue.h					\
 	tracker-monitor.h						\
 	tracker-utils.h
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index ded9369..a745584 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -87,28 +87,10 @@ TRACKER_MINER_FS_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>tracker-miner-dbus</FILE>
-TRACKER_MINER_DBUS_INTERFACE
-TRACKER_MINER_DBUS_NAME_PREFIX
-TRACKER_MINER_DBUS_PATH_PREFIX
-tracker_miner_dbus_init
-tracker_miner_dbus_shutdown
-TrackerMinerDBusNameFunc
-tracker_miner_dbus_add_name_watch
-tracker_miner_dbus_get_name
-tracker_miner_dbus_get_description
-tracker_miner_dbus_get_status
-tracker_miner_dbus_get_progress
-tracker_miner_dbus_get_pause_details
-tracker_miner_dbus_pause
-tracker_miner_dbus_resume
-tracker_miner_dbus_ignore_next_update
-</SECTION>
-
-<SECTION>
 <FILE>tracker-miner-web</FILE>
 TRACKER_MINER_WEB_ERROR_DOMAIN
 TRACKER_MINER_WEB_ERROR
+TRACKER_MINER_WEB_DBUS_INTERFACE
 TrackerMinerWebPrivate
 <TITLE>TrackerMinerWeb</TITLE>
 TrackerMinerWeb
@@ -130,15 +112,6 @@ TRACKER_MINER_WEB_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>tracker-miner-web-dbus</FILE>
-TRACKER_MINER_WEB_DBUS_INTERFACE
-tracker_miner_web_dbus_associate
-tracker_miner_web_dbus_dissociate
-tracker_miner_web_dbus_authenticate
-tracker_miner_web_dbus_get_association_data
-</SECTION>
-
-<SECTION>
 <FILE>tracker-password-provider</FILE>
 <TITLE>TrackerPasswordProvider</TITLE>
 TRACKER_PASSWORD_PROVIDER_ERROR_DOMAIN
diff --git a/src/libtracker-miner/tracker-password-provider.c b/src/libtracker-miner/tracker-password-provider.c
index bcdf18e..1216137 100644
--- a/src/libtracker-miner/tracker-password-provider.c
+++ b/src/libtracker-miner/tracker-password-provider.c
@@ -24,6 +24,18 @@
 
 #include "tracker-password-provider.h"
 
+/**
+ * SECTION:tracker-password-provider
+ * @short_description: Password storage interface for cross platform backends
+ * @include: libtracker-miner/tracker-miner.h
+ *
+ * The #TrackerPasswordProvider allows different backends to be
+ * written for storing sensitive information about web services which
+ * are needed to authenticate and mine data. Currently, there are two
+ * implementations. One for GNOME Keyring and one using #GKeyFile (as a
+ * fallback if GNOME Keyring is installed).
+ **/
+
 static void
 tracker_password_provider_init (gpointer object_class)
 {
diff --git a/src/libtracker-miner/tracker-password-provider.h b/src/libtracker-miner/tracker-password-provider.h
index 60cd1f0..5d3d7dc 100644
--- a/src/libtracker-miner/tracker-password-provider.h
+++ b/src/libtracker-miner/tracker-password-provider.h
@@ -37,7 +37,6 @@ G_BEGIN_DECLS
 #define TRACKER_PASSWORD_PROVIDER_ERROR         tracker_password_provider_error_quark()
 
 typedef struct TrackerPasswordProvider TrackerPasswordProvider;
-typedef struct TrackerPasswordProviderIface TrackerPasswordProviderIface;
 
 /**
  * TrackerPasswordProviderError:
@@ -67,7 +66,7 @@ typedef enum {
  *
  * Since: 0.8.
  **/
-struct TrackerPasswordProviderIface {
+typedef struct {
 	GTypeInterface parent_iface;
 
 	gboolean (* store_password)  (TrackerPasswordProvider  *provider,
@@ -83,7 +82,7 @@ struct TrackerPasswordProviderIface {
 	gboolean (* forget_password) (TrackerPasswordProvider  *provider,
 	                              const gchar              *service,
 	                              GError                  **error);
-};
+} TrackerPasswordProviderIface;
 
 GType    tracker_password_provider_get_type         (void) G_GNUC_CONST;
 GQuark   tracker_password_provider_error_quark      (void);
diff --git a/src/libtracker-miner/tracker-storage.c b/src/libtracker-miner/tracker-storage.c
index b8aa2dc..90a9b13 100644
--- a/src/libtracker-miner/tracker-storage.c
+++ b/src/libtracker-miner/tracker-storage.c
@@ -29,6 +29,16 @@
 #include "tracker-utils.h"
 #include "tracker-marshal.h"
 
+/**
+ * SECTION:tracker-storage
+ * @short_description: Removable storage and mount point convenience API
+ * @include: libtracker-miner/tracker-miner.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.
+ * The API is built upon the top of GIO's #GMount, #GDrive and #GVolume API.
+ **/
+
 #define TRACKER_STORAGE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), TRACKER_TYPE_STORAGE, TrackerStoragePrivate))
 
 typedef struct {
diff --git a/src/libtracker-miner/tracker-thumbnailer.c b/src/libtracker-miner/tracker-thumbnailer.c
index f40ca2b..10519b2 100644
--- a/src/libtracker-miner/tracker-thumbnailer.c
+++ b/src/libtracker-miner/tracker-thumbnailer.c
@@ -25,6 +25,20 @@
 
 #include "tracker-thumbnailer.h"
 
+/**
+ * SECTION:tracker-thumbnailer
+ * @short_description: Request the thumbnailer service creates or
+ * updates thumbnails.
+ * @include: libtracker-miner/tracker-miner.h
+ *
+ * This is a convenience API using D-Bus for creating and updating
+ * thumbnails for files being mined. It is also used to create
+ * thumbnails for album art found embedded in some medias.
+ *
+ * This follows the thumbnailer specification:
+ * http://live.gnome.org/ThumbnailerSpec
+ **/
+
 #define THUMBCACHE_SERVICE      "org.freedesktop.thumbnails.Cache1"
 #define THUMBCACHE_PATH         "/org/freedesktop/thumbnails/Cache1"
 #define THUMBCACHE_INTERFACE    "org.freedesktop.thumbnails.Cache1"