[tracker/wip/sam/resource: 1/8] Tweak documentation of tracker_decorator_info_get_task()

[Sam Thursfield <sthursfield src gnome org>]

commit 8401d0f8d003f4e45868ea5140f346359fa08248
Author: Sam Thursfield <sam afuera me uk>
Date:   Fri Jun 10 23:59:33 2016 +0100

    Tweak documentation of tracker_decorator_info_get_task()
    
    Mention what the task's data will be. Readers might not realise that
    the documentation of tracker_decorator_info_get_sparql() holds that
    information (I didn't).

 src/libtracker-miner/tracker-decorator.c |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-decorator.c b/src/libtracker-miner/tracker-decorator.c
index 8f161d0..55f5f71 100644
--- a/src/libtracker-miner/tracker-decorator.c
+++ b/src/libtracker-miner/tracker-decorator.c
@@ -1754,6 +1754,11 @@ tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info)
  * Get the #GTask associated with retrieving extended metadata and
  * information for a URN in Tracker.
  *
+ * The task object's data (accessible with g_task_get_task_data()) is the
+ * #TrackerSparqlBuilder that you must populate with the results of the
+ * metadata extraction. This can also be accessed with
+ * tracker_decorator_info_get_sparql().
+ *
  * Returns: (transfer none): the #GTask for #TrackerDecoratorInfo on
  * success or #NULL if there is no existing #GTask.
  *