GNOME.org
 

[tracker] libtracker-miner: Improve docs

commit bd4a6a10ae93b28e2f116f62d7b0e207ebff5bd8
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.

 .../libtracker-miner/libtracker-miner-docs.sgml    |   13 ++----
 .../libtracker-miner/libtracker-miner-sections.txt |   40 +++++++-------------
 .../libtracker-miner/libtracker-miner.types        |    1 +
 docs/reference/libtracker-miner/overview.sgml      |   21 ++++++----
 src/libtracker-miner/tracker-miner-object.c        |   14 +++++-
 src/libtracker-miner/tracker-miner-proxy.c         |   17 ++++++++
 6 files changed, 60 insertions(+), 46 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml 
b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
index 18c5d64..fc5986a 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
@@ -29,16 +29,11 @@
     </partintro>
 
     <chapter>
-      <title>Basics and foundations</title>
-      <xi:include href="xml/tracker-miner-enums.xml"/>
-    </chapter>
-
-    <chapter>
       <title>Base abstract miner classes</title>
+      <xi:include href="xml/tracker-miner-enums.xml"/>
       <xi:include href="xml/tracker-miner-object.xml"/>
       <xi:include href="xml/tracker-miner-online.xml"/>
       <xi:include href="xml/tracker-data-provider.xml"/>
-      <xi:include href="xml/tracker-decorator.xml"/>
       <xi:include href="xml/tracker-indexing-tree.xml"/>
     </chapter>
 
@@ -50,9 +45,9 @@
     </chapter>
 
     <chapter>
-      <title>Utilities</title>
-      <xi:include href="xml/tracker-thumbnailer.xml"/>
-      <xi:include href="xml/tracker-media-art.xml"/>
+      <title>DBus helpers</title>
+      <xi:include href="xml/tracker-decorator.xml"/>
+      <xi:include href="xml/tracker-miner-proxy.xml"/>
     </chapter>
   </part>
 
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt 
b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index d88c9a6..d5b74d2 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -104,6 +104,7 @@ tracker_indexing_tree_get_root
 tracker_indexing_tree_get_master_root
 tracker_indexing_tree_file_is_root
 tracker_indexing_tree_list_roots
+tracker_indexing_tree_notify_update
 <SUBSECTION Standard>
 TRACKER_INDEXING_TREE
 TRACKER_INDEXING_TREE_CLASS
@@ -115,12 +116,6 @@ tracker_indexing_tree_get_type
 </SECTION>
 
 <SECTION>
-<FILE>tracker-media-art</FILE>
-tracker_media_art_queue_remove
-tracker_media_art_queue_empty
-</SECTION>
-
-<SECTION>
 <FILE>tracker-miner-enum-types</FILE>
 <SUBSECTION Standard>
 TRACKER_TYPE_DIRECTORY_FLAGS
@@ -147,6 +142,7 @@ TrackerNetworkType
 TrackerMinerFS
 TrackerMinerFSClass
 TrackerMinerFSError
+TrackerMinerFSEventType
 tracker_miner_fs_error_quark
 tracker_miner_fs_get_indexing_tree
 tracker_miner_fs_get_data_provider
@@ -184,13 +180,9 @@ tracker_miner_start
 tracker_miner_stop
 tracker_miner_is_started
 tracker_miner_is_paused
-tracker_miner_get_n_pause_reasons
 tracker_miner_pause
 tracker_miner_resume
 tracker_miner_get_connection
-tracker_miner_get_dbus_connection
-tracker_miner_get_dbus_full_name
-tracker_miner_get_dbus_full_path
 <SUBSECTION Standard>
 TRACKER_IS_MINER
 TRACKER_IS_MINER_CLASS
@@ -219,22 +211,18 @@ tracker_miner_online_get_type
 </SECTION>
 
 <SECTION>
-<FILE>tracker-thumbnailer</FILE>
-<TITLE>TrackerThumbnailer</TITLE>
-TrackerThumbnailer
-TrackerThumbnailerClass
-tracker_thumbnailer_new
-tracker_thumbnailer_send
-tracker_thumbnailer_move_add
-tracker_thumbnailer_remove_add
-tracker_thumbnailer_cleanup
+<FILE>tracker-miner-proxy</FILE>
+<TITLE>TrackerMinerProxy</TITLE>
+TrackerMinerProxy
+TrackerMinerProxyClass
+tracker_miner_proxy_new
 <SUBSECTION Standard>
-TRACKER_IS_THUMBNAILER
-TRACKER_IS_THUMBNAILER_CLASS
-TRACKER_THUMBNAILER
-TRACKER_THUMBNAILER_CLASS
-TRACKER_THUMBNAILER_GET_CLASS
-TRACKER_TYPE_THUMBNAILER
-tracker_thumbnailer_get_type
+TRACKER_IS_MINER_PROXY
+TRACKER_IS_MINER_PROXY_CLASS
+TRACKER_MINER_PROXY
+TRACKER_MINER_PROXY_CLASS
+TRACKER_MINER_PROXY_GET_CLASS
+TRACKER_TYPE_MINER_PROXY
+tracker_miner_proxy_get_type
 </SECTION>
 
diff --git a/docs/reference/libtracker-miner/libtracker-miner.types 
b/docs/reference/libtracker-miner/libtracker-miner.types
index a26c9c2..8cff4f6 100644
--- a/docs/reference/libtracker-miner/libtracker-miner.types
+++ b/docs/reference/libtracker-miner/libtracker-miner.types
@@ -4,3 +4,4 @@ tracker_indexing_tree_get_type
 tracker_miner_get_type
 tracker_miner_fs_get_type
 tracker_miner_online_get_type
+tracker_miner_proxy_get_type
diff --git a/docs/reference/libtracker-miner/overview.sgml b/docs/reference/libtracker-miner/overview.sgml
index bd0b178..5becdcd 100644
--- a/docs/reference/libtracker-miner/overview.sgml
+++ b/docs/reference/libtracker-miner/overview.sgml
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding="ISO-8859-1"?>
+<?xml version='1.0' encoding="UTF-8"?>
 
 <part id="tracker-overview">
   <title>Overview</title>
@@ -6,7 +6,13 @@
     <para>
       The libtracker-miner library is the foundation for Tracker data miners,
       these miners will extract metadata and insert it in SPARQL form to
-      tracker-store, following the Nepomuk ontology.
+      a TrackerSparqlConnection.
+    </para>
+    <para>
+      The abstract objects provided by this library implement the data indexing
+      logic necessary for different data and patterns. They merely provide the
+      guidelines, SPARQL updates are also possible without a libtracker-miner
+      object implementation.
     </para>
   </partintro>
 
@@ -25,11 +31,11 @@
       <application>pkg-config</application> is used (the actual output on
       your system may be different):
 <programlisting>
-$ pkg-config --cflags tracker-miner-0.12
--pthread -I/usr/include/tracker-0.12 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include 
-I/usr/include/tracker-0.12/libtracker-sparql
+$ pkg-config --cflags tracker-miner-2.0
+-pthread -I/usr/include/tracker-2.0 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include 
-I/usr/include/tracker-2.0/libtracker-sparql
 
-$ pkg-config --libs tracker-miner-0.12
--pthread -Wl,--export-dynamic -ltracker-miner-0.12 -ltracker-sparql-0.12 -lgio-2.0 -lgobject-2.0 
-lgmodule-2.0 -lgthread-2.0 -lrt -lglib-2.0
+$ pkg-config --libs tracker-miner-2.0
+-pthread -Wl,--export-dynamic -ltracker-miner-2.0 -ltracker-sparql-2.0 -lgio-2.0 -lgobject-2.0 -lgmodule-2.0 
-lgthread-2.0 -lrt -lglib-2.0
 
 </programlisting>
     </para>
@@ -39,9 +45,8 @@ $ pkg-config --libs tracker-miner-0.12
       (<emphasis>not single quotes</emphasis>), then its output will be
       substituted into the command line before execution:
 <programlisting>
- $ cc `pkg-config --cflags --libs tracker-miner-0.12` hello.c -o hello
+ $ cc `pkg-config --cflags --libs tracker-miner-2.0` hello.c -o hello
 </programlisting>
     </para>
-
   </chapter>
 </part>
diff --git a/src/libtracker-miner/tracker-miner-object.c b/src/libtracker-miner/tracker-miner-object.c
index cec2bdf..57d692f 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 28772ea..f27fa4b 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.h"
 
 #include <glib/gi18n.h>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]