libtracker-miner: Fixed all documentation warnings

12 files changed, 59 insertions, 10 deletions

diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
index f34662b67..074f485bf 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
@@ -44,6 +44,7 @@
 
     <chapter>
       <title>Utilities</title>
+      <xi:include href="xml/tracker-thumbnailer.xml"/>
       <xi:include href="xml/tracker-miner-enums.xml"/>
     </chapter>
   </part>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index d119a77ea..081bb4893 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -129,11 +129,13 @@ tracker_miner_get_type
 
 <SECTION>
 <FILE>tracker-miner-online</FILE>
-<TITLE>TrackerMinerOnline</FILE>
+<TITLE>TrackerMinerOnline</TITLE>
 TrackerMinerOnline
 TrackerMinerOnlineClass
 tracker_miner_online_get_type
 tracker_miner_online_get_network_type
+TrackerNetworkType
+tracker_network_type_get_type
 <SUBSECTION Standard>
 TRACKER_MINER_ONLINE
 TRACKER_MINER_ONLINE_CLASS
@@ -144,16 +146,41 @@ TRACKER_TYPE_MINER_ONLINE
 </SECTION>
 
 <SECTION>
+<FILE>tracker-thumbnailer</FILE>
+<TITLE>TrackerThumbnailer</TITLE>
+TrackerThumbnailer
+TrackerThumbnailerClass
+tracker_thumbnailer_cleanup
+tracker_thumbnailer_get_type
+tracker_thumbnailer_move_add
+tracker_thumbnailer_new
+tracker_thumbnailer_remove_add
+tracker_thumbnailer_send
+<SUBSECTION Standard>
+TRACKER_THUMBNAILER
+TRACKER_THUMBNAILER_CLASS
+TRACKER_THUMBNAILER_GET_CLASS
+TRACKER_IS_THUMBNAILER
+TRACKER_IS_THUMBNAILER_CLASS
+TRACKER_TYPE_NETWORK_TYPE
+TRACKER_TYPE_THUMBNAILER
+</SECTION>
+
+<SECTION>
 <FILE>tracker-decorator</FILE>
 <TITLE>TrackerDecorator</TITLE>
 TrackerDecorator
 TrackerDecoratorClass
 TrackerDecoratorInfo
-tracker_decorator_delete_ids
+tracker_decorator_get_type
 tracker_decorator_get_class_names
 tracker_decorator_get_data_source
 tracker_decorator_get_n_items
-tracker_decorator_get_type
+tracker_decorator_set_priority_rdf_types
+tracker_decorator_prepend_id
+tracker_decorator_delete_id
+tracker_decorator_next
+tracker_decorator_next_finish
 tracker_decorator_info_get_type
 tracker_decorator_info_ref
 tracker_decorator_info_unref
@@ -162,9 +189,6 @@ tracker_decorator_info_get_sparql
 tracker_decorator_info_get_task
 tracker_decorator_info_get_url
 tracker_decorator_info_get_urn
-tracker_decorator_next
-tracker_decorator_next_finish
-tracker_decorator_prepend_ids
 <SUBSECTION Standard>
 TRACKER_DECORATOR
 TRACKER_DECORATOR_CLASS
diff --git a/src/libtracker-miner/tracker-decorator-fs.h b/src/libtracker-miner/tracker-decorator-fs.h
index 76a8ef197..984c81339 100644
--- a/src/libtracker-miner/tracker-decorator-fs.h
+++ b/src/libtracker-miner/tracker-decorator-fs.h
@@ -51,6 +51,7 @@ struct _TrackerDecoratorFS {
 /**
  * TrackerDecoratorFSClass:
  * @parent_class: parent object class.
+ * @padding: Reserved for future API improvements.
  *
  * A class that takes care of resources on mount points added or
  * removed, this is based on #TrackerDecoratorClass.
diff --git a/src/libtracker-miner/tracker-decorator.c b/src/libtracker-miner/tracker-decorator.c
index 58710cd33..f4823ae68 100644
--- a/src/libtracker-miner/tracker-decorator.c
+++ b/src/libtracker-miner/tracker-decorator.c
@@ -1076,7 +1076,8 @@ tracker_decorator_get_n_items (TrackerDecorator *decorator)
 /**
  * tracker_decorator_prepend_id:
  * @decorator: a #TrackerDecorator.
- * @id: an ID.
+ * @id: the ID of the resource ID.
+ * @class_name_id: the ID of the resource's class.
  *
  * Adds resource needing extended metadata extraction to the queue.
  * @id is the same IDs emitted by tracker-store when the database is updated for
diff --git a/src/libtracker-miner/tracker-decorator.h b/src/libtracker-miner/tracker-decorator.h
index f5cce9ade..c3a38a605 100644
--- a/src/libtracker-miner/tracker-decorator.h
+++ b/src/libtracker-miner/tracker-decorator.h
@@ -54,6 +54,7 @@ struct _TrackerDecorator {
  * @parent_class: parent object class.
  * @items_available: Called when there are resources to be processed.
  * @finished: Called when all resources have been processed.
+ * @padding: Reserved for future API improvements.
  *
  * An implementation that takes care of extracting extra metadata
  * specific to file types by talking to tracker-extract.
diff --git a/src/libtracker-miner/tracker-indexing-tree.h b/src/libtracker-miner/tracker-indexing-tree.h
index a2184ba15..7f159a325 100644
--- a/src/libtracker-miner/tracker-indexing-tree.h
+++ b/src/libtracker-miner/tracker-indexing-tree.h
@@ -58,6 +58,7 @@ struct _TrackerIndexingTree
  * @directory_added: Called when a directory is added.
  * @directory_removed: Called when a directory is removed.
  * @directory_updated: Called when a directory is updated.
+ * @padding: Reserved for future API improvements.
  *
  * Class for the #TrackerIndexingTree.
  */
diff --git a/src/libtracker-miner/tracker-miner-enums.h b/src/libtracker-miner/tracker-miner-enums.h
index 941b10aaf..5e5c9b399 100644
--- a/src/libtracker-miner/tracker-miner-enums.h
+++ b/src/libtracker-miner/tracker-miner-enums.h
@@ -41,6 +41,7 @@ G_BEGIN_DECLS
  * @TRACKER_DIRECTORY_FLAG_MONITOR: Should setup monitors in the items found in the directory.
  * @TRACKER_DIRECTORY_FLAG_IGNORE: Should ignore the directory contents.
  * @TRACKER_DIRECTORY_FLAG_PRESERVE: Should preserve items in the directory even if the directory gets removed.
+ * @TRACKER_DIRECTORY_FLAG_PRIORITY: Internally a priority queue is used and this flag makes sure the directory is given a priority over other directories queued.
  *
  * Flags used when adding a new directory to be indexed in the #TrackerIndexingTree.
  */
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index 77c036e1e..8da85899e 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -67,6 +67,8 @@ struct _TrackerMinerFS {
  * @process_file_attributes: Called when the metadata associated with
  * a file's attributes changes, for example, the mtime.
  * @writeback_file: Called when a file must be written back
+ * @padding: Reserved for future API improvements.
+
  *
  * Prototype for the abstract class, @process_file must be implemented
  * in the deriving class in order to actually extract data.
diff --git a/src/libtracker-miner/tracker-miner-object.h b/src/libtracker-miner/tracker-miner-object.h
index 87c4d9724..7fa9e709e 100644
--- a/src/libtracker-miner/tracker-miner-object.h
+++ b/src/libtracker-miner/tracker-miner-object.h
@@ -63,6 +63,7 @@ struct _TrackerMiner {
  * @resumed: Called when the miner is told to resume activity.
  * @progress: progress.
  * @ignore_next_update: Called after ignore on next update event happens.
+ * @padding: Reserved for future API improvements.
  *
  * Virtual methods left to implement.
  **/
diff --git a/src/libtracker-miner/tracker-miner-online.h b/src/libtracker-miner/tracker-miner-online.h
index 1c4a95daf..c3b087357 100644
--- a/src/libtracker-miner/tracker-miner-online.h
+++ b/src/libtracker-miner/tracker-miner-online.h
@@ -49,6 +49,7 @@ struct _TrackerMinerOnline {
  * @connected: called when there is a network connection, or a new
  *   default route, returning #TRUE starts/resumes indexing.
  * @disconnected: called when there is no network connection.
+ * @padding: Reserved for future API improvements.
  *
  * Since: 0.18.
  **/
diff --git a/src/libtracker-miner/tracker-thumbnailer.c b/src/libtracker-miner/tracker-thumbnailer.c
index ee80999a8..51a07db5e 100644
--- a/src/libtracker-miner/tracker-thumbnailer.c
+++ b/src/libtracker-miner/tracker-thumbnailer.c
@@ -27,7 +27,6 @@
 
 /**
  * SECTION:tracker-thumbnailer
- * @title: Thumbnailer management
  * @short_description: Request the thumbnailer service creates or
  * updates thumbnails.
  * @include: libtracker-miner/tracker-miner.h
@@ -265,6 +264,7 @@ tracker_thumbnailer_new (void)
 
 /**
  * tracker_thumbnailer_move_add:
+ * @thumbnailer: Thumbnailer object
  * @from_uri: URI of the file before the move
  * @mime_type: mime-type of the file
  * @to_uri: URI of the file after the move
@@ -311,6 +311,7 @@ tracker_thumbnailer_move_add (TrackerThumbnailer *thumbnailer,
 
 /**
  * tracker_thumbnailer_remove_add:
+ * @thumbnailer: Thumbnailer object
  * @uri: URI of the file
  * @mime_type: mime-type of the file
  *
@@ -351,6 +352,7 @@ tracker_thumbnailer_remove_add (TrackerThumbnailer *thumbnailer,
 
 /**
  * tracker_thumbnailer_cleanup:
+ * @thumbnailer: Thumbnailer object
  * @uri_prefix: URI prefix
  *
  * Tells thumbnailer to cleanup all thumbnails under @uri_prefix.
@@ -394,6 +396,7 @@ tracker_thumbnailer_cleanup (TrackerThumbnailer *thumbnailer,
 
 /**
  * tracker_thumbnailer_send:
+ * @thumbnailer: Thumbnailer object
  *
  * Sends to the thumbnailer all stored requests.
  *
diff --git a/src/libtracker-miner/tracker-thumbnailer.h b/src/libtracker-miner/tracker-thumbnailer.h
index c7b2f0859..b53dc2893 100644
--- a/src/libtracker-miner/tracker-thumbnailer.h
+++ b/src/libtracker-miner/tracker-thumbnailer.h
@@ -38,12 +38,24 @@ G_BEGIN_DECLS
 typedef struct _TrackerThumbnailer TrackerThumbnailer;
 typedef struct _TrackerThumbnailerClass TrackerThumbnailerClass;
 
+/**
+ * TrackerThumbnailer:
+ * @parent: parent object
+ *
+ * A class implementation for managing thumbnails when mining content.
+ **/
 struct _TrackerThumbnailer {
-	GObject parent_instance;
+	GObject parent;
 };
 
+/**
+ * TrackerThumbnailerClass:
+ * @parent: parent object class
+ *
+ * Prototype for the class.
+ **/
 struct _TrackerThumbnailerClass {
-	GObjectClass parent_class;
+	GObjectClass parent;
 };