[tracker] Finish libtracker-miner docs.



commit 581db145d9239c53c0ffdb7da2306c60b246c644
Author: Carlos Garnacho <carlos lanedo com>
Date:   Wed Dec 9 16:33:20 2009 +0100

    Finish libtracker-miner docs.
    
    now with 100% coverage again.

 src/libtracker-miner/tracker-miner-fs.h |    1 +
 src/libtracker-miner/tracker-miner.c    |    8 ++++++++
 src/libtracker-miner/tracker-miner.h    |    3 +--
 3 files changed, 10 insertions(+), 2 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index f041da7..a856f41 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -58,6 +58,7 @@ struct TrackerMinerFS {
  * @check_directory: Called when a directory should be checked for further processing
  * @check_directory_contents: Called when a directory should be checked for further processing, based on the directory contents.
  * @process_file: Called when the metadata associated to a file is requested.
+ * @writeback_file: Called after a writeback event happens on a file.
  * @monitor_directory: Called to check whether a directory should be modified.
  * @finished: Called when all processing has been performed.
  *
diff --git a/src/libtracker-miner/tracker-miner.c b/src/libtracker-miner/tracker-miner.c
index 6c8f704..a32d5c4 100644
--- a/src/libtracker-miner/tracker-miner.c
+++ b/src/libtracker-miner/tracker-miner.c
@@ -229,6 +229,14 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 			      G_TYPE_NONE, 2,
 			      G_TYPE_STRING,
 			      G_TYPE_DOUBLE);
+	/**
+	 * TrackerMiner::error:
+	 * @miner: the #TrackerMiner
+	 * @error: the error that happened
+	 *
+	 * The ::error signal will be emitted by TrackerMiner implementations to
+	 * indicate some error in the data mining process.
+	 **/
 	signals[ERROR] =
 		g_signal_new ("error",
 			      G_OBJECT_CLASS_TYPE (object_class),
diff --git a/src/libtracker-miner/tracker-miner.h b/src/libtracker-miner/tracker-miner.h
index b0f4589..cd15b17 100644
--- a/src/libtracker-miner/tracker-miner.h
+++ b/src/libtracker-miner/tracker-miner.h
@@ -60,6 +60,7 @@ struct TrackerMiner {
  * @terminated: terminated.
  * @progress: progress.
  * @error: error.
+ * @writeback: Called after writeback event happens.
  *
  * Virtual methods left to implement.
  **/
@@ -73,8 +74,6 @@ typedef struct {
         void (* paused)     (TrackerMiner *miner);
         void (* resumed)    (TrackerMiner *miner);
 
-	void (* terminated) (TrackerMiner *miner);
-
 	void (* progress)   (TrackerMiner *miner,
 			     const gchar  *status,
 			     gdouble       progress);



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