[tracker-miners/wip/carlosg/shuffle-libtracker-miner: 3/115] libtracker-miner: Improve docs

[Carlos Garnacho <carlosg src gnome org>]

commit 6af5ac29975e56d8e378d6e757f3be24ec04256d
Author: Carlos Garnacho <carlosg gnome org>
Date:   Mon Aug 7 11:10:16 2017 +0200

    libtracker-miner: Improve docs
    
    Remove no longer existing methods, add the newer objects/methods
    that were missing, and add some further docs here and there.

 src/libtracker-miner/tracker-miner-object.c | 14 +++++++++++---
 src/libtracker-miner/tracker-miner-proxy.c  | 17 +++++++++++++++++
 2 files changed, 28 insertions(+), 3 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-miner-object.c b/src/libtracker-miner/tracker-miner-object.c
index b60ea9842..7c19ef6be 100644
--- a/src/libtracker-miner/tracker-miner-object.c
+++ b/src/libtracker-miner/tracker-miner-object.c
@@ -51,9 +51,8 @@
  *
  * #TrackerMiner is an abstract base class to help developing data miners
  * for tracker-store, being an abstract class it doesn't do much by itself,
- * but provides the basic signaling and operation control so the miners
- * implementing this class are properly recognized by Tracker, and can be
- * controlled properly by external means such as #TrackerMinerManager.
+ * but provides the basic signaling and control over the actual indexing
+ * task.
  *
  * #TrackerMiner implements the #GInitable interface, and thus, all objects of
  * types inheriting from #TrackerMiner must be initialized with g_initable_init()
@@ -259,6 +258,15 @@ tracker_miner_class_init (TrackerMinerClass *klass)
                                                           G_MAXINT,
                                                           -1,
                                                           G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
+       /**
+        * TrackerMiner:connection:
+        *
+        * The SPARQL connection to use. For compatibility reasons, if not set
+        * at construct time, one shall be obtained through
+        * tracker_sparql_connection_get().
+        *
+        * Since: 2.0
+        **/
        g_object_class_install_property (object_class,
                                         PROP_CONNECTION,
                                         g_param_spec_object ("connection",
diff --git a/src/libtracker-miner/tracker-miner-proxy.c b/src/libtracker-miner/tracker-miner-proxy.c
index b69e7b889..e7de535cf 100644
--- a/src/libtracker-miner/tracker-miner-proxy.c
+++ b/src/libtracker-miner/tracker-miner-proxy.c
@@ -19,6 +19,23 @@
  * Authors: Carlos Garnacho <carlosg gnome org>
  */
 
+/**
+ * SECTION:tracker-miner-proxy
+ * @short_description: Proxies a #TrackerMiner on DBus
+ * @include: libtracker-miner/tracker-miner.h
+ *
+ * #TrackerMinerProxy is a helper object to expose org.freedesktop.Tracker1.Miner
+ * DBus interfaces for the given #TrackerMiner object. This is used to implement
+ * miners as DBus services.
+ *
+ * This proxy allows the miner to be controlled through external means, such as
+ * #TrackerMinerManager in libtracker-control.
+ *
+ * #TrackerMinerProxy implements the #GInitable interface, and thus all objects of
+ * types inheriting from #TrackerMinerProxy must be initialized with g_initable_init()
+ * just after creation (or directly created with g_initable_new()).
+ **/
+
 #include "config-miners.h"
 
 #include <glib/gi18n.h>