[tracker/tracker-1.6] libtracker-control: Improve the documentation

[Debarshi Ray <debarshir src gnome org>]

commit e10127e145fabca0bf98b18e665440ff6a1126bb
Author: Debarshi Ray <debarshir gnome org>
Date:   Fri Oct 30 16:14:21 2015 +0100

    libtracker-control: Improve the documentation
    
    Make it clear that tracker_miner_manager_index_file only tells the
    miner to start indexing a file. It doesn't wait for the actual indexing
    operation to complete.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=757366

 src/libtracker-control/tracker-miner-manager.c |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/src/libtracker-control/tracker-miner-manager.c b/src/libtracker-control/tracker-miner-manager.c
index d0c370b..aba5b38 100644
--- a/src/libtracker-control/tracker-miner-manager.c
+++ b/src/libtracker-control/tracker-miner-manager.c
@@ -1605,7 +1605,7 @@ miner_manager_index_file_thread (GTask *task,
  * @file: a URL valid in GIO of a file to give to the miner for processing
  * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
- * Tells the filesystem miner to index the @file.
+ * Tells the filesystem miner to start indexing the @file.
  *
  * On failure @error will be set.
  *
@@ -1632,9 +1632,9 @@ tracker_miner_manager_index_file (TrackerMinerManager  *manager,
  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
  * @user_data: the data to pass to the callback function
  *
- * Tells the filesystem miner to index the @file. When the operation is called,
+ * Tells the filesystem miner to start indexing the @file. Once the message has been sent,
  * @callback will be called. You can then call tracker_miner_manager_index_file_finish()
- * to get the result of the operation.
+ * to get the result.
  *
  * Since: 0.16
  **/