[tracker/external-crawler: 45/45] libtracker-miner: Document roots in tracker_indexing_tree_get_master_root()

[Martyn James Russell <mr src gnome org>]

commit 32f403dbe9a494f7691679521d12c5e8db9e3367
Author: Martyn Russell <martyn lanedo com>
Date:   Tue Aug 12 19:50:07 2014 +0100

    libtracker-miner: Document roots in tracker_indexing_tree_get_master_root()

 src/libtracker-miner/tracker-indexing-tree.c |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-indexing-tree.c b/src/libtracker-miner/tracker-indexing-tree.c
index 79a9c9d..7a3adae 100644
--- a/src/libtracker-miner/tracker-indexing-tree.c
+++ b/src/libtracker-miner/tracker-indexing-tree.c
@@ -896,6 +896,18 @@ tracker_indexing_tree_get_root (TrackerIndexingTree   *tree,
  * cases where no root is given, we fallback to
  * <filename>file:///</filename>.
  *
+ * Roots explained:
+ *
+ * - master root = top most level root node,
+ *   e.g. file:///
+ *
+ * - config root = a root node from GSettings,
+ *   e.g. file:///home/martyn/Documents
+ *
+ * - root = ANY root, normally config root, but it can also apply to
+ *   roots added for devices, which technically are not a config root or a
+ *   master root.
+ *
  * Returns: (transfer none): the effective root for all locations, or
  * %NULL on error. The root is owned by @tree and should not be freed.
  * It can be referenced using g_object_ref().