[tracker/data-provider-monitor-interface] libtracker-miner: Added missing documentation for TrackerDataProvider



commit 62b57de319768e8a36c781b6979c0e4c9d97ded5
Author: Martyn Russell <martyn lanedo com>
Date:   Thu Jan 15 15:16:47 2015 +0000

    libtracker-miner: Added missing documentation for TrackerDataProvider

 .../libtracker-miner/libtracker-miner-sections.txt |    8 ++++++++
 src/libtracker-miner/tracker-data-provider.h       |    9 ++++++---
 2 files changed, 14 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt 
b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 93b0361..52d7b5d 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -8,6 +8,14 @@ tracker_data_provider_begin_finish
 tracker_data_provider_end
 tracker_data_provider_end_async
 tracker_data_provider_end_finish
+tracker_data_provider_monitor_add
+tracker_data_provider_monitor_remove
+tracker_data_provider_monitor_move
+tracker_data_provider_is_monitored
+tracker_data_provider_is_monitored_by_path
+tracker_data_provider_monitor_count
+tracker_data_provider_set_indexing_tree
+tracker_data_provider_get_indexing_tree
 TrackerDataProvider
 <SUBSECTION Standard>
 TRACKER_DATA_PROVIDER
diff --git a/src/libtracker-miner/tracker-data-provider.h b/src/libtracker-miner/tracker-data-provider.h
index c360089..852766f 100644
--- a/src/libtracker-miner/tracker-data-provider.h
+++ b/src/libtracker-miner/tracker-data-provider.h
@@ -77,6 +77,12 @@ typedef struct _TrackerDataProviderIface TrackerDataProviderIface;
  * string instead of a #GFile.
  * @monitor_count: Called to find out number of containers monitored
  * by the data_provider.
+ * @set_indexing_tree: The #TrackerIndexingTree is central to what is
+ * indexed and what is ignored. It is used by many components using
+ * the #TrackerDataProvider. This <emphasis>MUST</emphasis> be set or
+ * #TrackerMinerFS will fail to instantiate.
+ * @get_indexing_tree: Return the #TrackerIndexingTree used with this
+ * #TrackerDataProvider.
  * @item_created: Signalled when an item is created in a monitored
  * container. This can be another container or object itself. A
  * container could be a directory and an object could be a file in
@@ -186,9 +192,6 @@ struct _TrackerDataProviderIface {
                                                      GError                **error);
        TrackerIndexingTree * (* get_indexing_tree)  (TrackerDataProvider    *data_provider,
                                                      GError                **error);
-
-       /*< private >*/
-       /* Already +1 past padding :/ */
 };
 
 GType              tracker_data_provider_get_type        (void) G_GNUC_CONST;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]