GNOME.org
 

[tracker/wip/tintou/tracker-miner-doc: 1/2] Prepare source files to documentation

commit 246c0cbb943a20b608374a603320d13138463baa
Author: Corentin Noël <corentin noel collabora com>
Date:   Wed Mar 27 16:23:12 2019 +0100

    Prepare source files to documentation

 src/libtracker-miner/tracker-data-provider.c      |  2 +-
 src/libtracker-miner/tracker-data-provider.h      |  7 ----
 src/libtracker-miner/tracker-decorator.c          | 43 +++++++++++------------
 src/libtracker-miner/tracker-file-data-provider.c |  2 +-
 src/libtracker-miner/tracker-indexing-tree.c      | 22 ++++++------
 src/libtracker-miner/tracker-indexing-tree.h      |  1 +
 src/libtracker-miner/tracker-miner-enums.h        |  2 +-
 src/libtracker-miner/tracker-miner-fs.c           |  4 +--
 src/libtracker-miner/tracker-miner-fs.h           |  6 +++-
 src/libtracker-miner/tracker-miner-object.h       | 10 +++---
 src/libtracker-miner/tracker-miner-online.c       |  8 ++---
 src/libtracker-miner/tracker-miner-online.h       |  2 +-
 12 files changed, 53 insertions(+), 56 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-data-provider.c b/src/libtracker-miner/tracker-data-provider.c
index 0c6f8ce42..20a3396b6 100644
--- a/src/libtracker-miner/tracker-data-provider.c
+++ b/src/libtracker-miner/tracker-data-provider.c
@@ -118,7 +118,7 @@ tracker_data_provider_begin (TrackerDataProvider    *data_provider,
  * @url: a #GFile to enumerate
  * @attributes: an attribute query string
  * @flags: a set of #TrackerDirectoryFlags
- * @io_priority: the [I/O priority][io-priority] of the request
+ * @io_priority: the I/O priority of the request (example: %G_PRIORITY_DEFAULT)
  * @cancellable: (allow-none): optional #GCancellable object, %NULL to
  * ignore
  * @callback: (scope async): a #GAsyncReadyCallback to call when the
diff --git a/src/libtracker-miner/tracker-data-provider.h b/src/libtracker-miner/tracker-data-provider.h
index e780f7fc4..a2cf15552 100644
--- a/src/libtracker-miner/tracker-data-provider.h
+++ b/src/libtracker-miner/tracker-data-provider.h
@@ -55,13 +55,6 @@ typedef struct _TrackerDataProviderIface TrackerDataProviderIface;
  * using @begin_finish.
  * @begin_finish: Called when the data_provider is completing the
  * asynchronous operation provided by @begin_async.
- * @end: Called when the data_provider is synchronously
- * closing and cleaning up the iteration of a given location.
- * @end_async: Called when the data_provider is asynchronously
- * closing and cleaning up the iteration of a given location.
- * Completed using @end_finish.
- * @end_finish: Called when the data_provider is completing the
- * asynchronous operation provided by @end_async.
  *
  * Virtual methods left to implement.
  **/
diff --git a/src/libtracker-miner/tracker-decorator.c b/src/libtracker-miner/tracker-decorator.c
index f51b284c8..16fa21db7 100644
--- a/src/libtracker-miner/tracker-decorator.c
+++ b/src/libtracker-miner/tracker-decorator.c
@@ -132,7 +132,7 @@ static void notifier_events_cb (TrackerDecorator *decorator,
  *
  * Returns: the #GQuark used for the domain of a #GError.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 G_DEFINE_QUARK (TrackerDecoratorError, tracker_decorator_error)
 
@@ -175,7 +175,7 @@ tracker_decorator_info_new (TrackerDecorator    *decorator,
  *
  * Returns: the same @info passed in, or %NULL on error.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 TrackerDecoratorInfo *
 tracker_decorator_info_ref (TrackerDecoratorInfo *info)
@@ -191,7 +191,7 @@ tracker_decorator_info_ref (TrackerDecoratorInfo *info)
  * Decreases the reference count of @info by 1 and frees it when the
  * reference count reaches 0.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_decorator_info_unref (TrackerDecoratorInfo *info)
@@ -1259,7 +1259,7 @@ tracker_decorator_class_init (TrackerDecoratorClass *klass)
         * #TrackerDecorator sees resources that are available for
         * extended metadata extraction.
         *
-        * Since: 0.18.
+        * Since: 0.18
         **/
        signals[ITEMS_AVAILABLE] =
                g_signal_new ("items-available",
@@ -1277,7 +1277,7 @@ tracker_decorator_class_init (TrackerDecoratorClass *klass)
         * #TrackerDecorator has finished extracted extended metadata
         * for resources in the database.
         *
-        * Since: 0.18.
+        * Since: 0.18
         **/
        signals[FINISHED] =
                g_signal_new ("finished",
@@ -1323,7 +1323,7 @@ tracker_decorator_init (TrackerDecorator *decorator)
  *
  * Returns: a const gchar* or #NULL if an error happened.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 const gchar *
 tracker_decorator_get_data_source (TrackerDecorator *decorator)
@@ -1345,7 +1345,7 @@ tracker_decorator_get_data_source (TrackerDecorator *decorator)
  *
  * Returns: (transfer none): a const gchar** or #NULL.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 const gchar **
 tracker_decorator_get_class_names (TrackerDecorator *decorator)
@@ -1369,7 +1369,7 @@ tracker_decorator_get_class_names (TrackerDecorator *decorator)
  *
  * Returns: the number of items queued to be processed, always >= 0.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 guint
 tracker_decorator_get_n_items (TrackerDecorator *decorator)
@@ -1393,7 +1393,7 @@ tracker_decorator_get_n_items (TrackerDecorator *decorator)
  * @id is the same IDs emitted by tracker-store when the database is updated for
  * consistency. For details, see the GraphUpdated signal.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_decorator_prepend_id (TrackerDecorator *decorator,
@@ -1420,7 +1420,7 @@ tracker_decorator_prepend_id (TrackerDecorator *decorator,
  * queue. @id is the same IDs emitted by tracker-store when the database is
  * updated for consistency. For details, see the GraphUpdated signal.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_decorator_delete_id (TrackerDecorator *decorator,
@@ -1458,7 +1458,7 @@ tracker_decorator_delete_id (TrackerDecorator *decorator,
  * This function will give a #GError if the miner is paused at the
  * time it is called.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_decorator_next (TrackerDecorator    *decorator,
@@ -1503,7 +1503,7 @@ tracker_decorator_next (TrackerDecorator    *decorator,
  * Returns: (transfer full): a #TrackerDecoratorInfo on success or
  *  #NULL on error. Free with tracker_decorator_info_unref().
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 TrackerDecoratorInfo *
 tracker_decorator_next_finish (TrackerDecorator  *decorator,
@@ -1554,7 +1554,7 @@ decorator_set_class_priority (TrackerDecorator *decorator,
  * applications that need their content available sooner than the
  * standard time it would take to index content.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_decorator_set_priority_rdf_types (TrackerDecorator    *decorator,
@@ -1586,7 +1586,7 @@ tracker_decorator_set_priority_rdf_types (TrackerDecorator    *decorator,
  *
  * Returns: the URN for #TrackerDecoratorInfo on success or #NULL on error.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 const gchar *
 tracker_decorator_info_get_urn (TrackerDecoratorInfo *info)
@@ -1604,7 +1604,7 @@ tracker_decorator_info_get_urn (TrackerDecoratorInfo *info)
  *
  * Returns: the URL for #TrackerDecoratorInfo on success or #NULL on error.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 const gchar *
 tracker_decorator_info_get_url (TrackerDecoratorInfo *info)
@@ -1625,7 +1625,7 @@ tracker_decorator_info_get_url (TrackerDecoratorInfo *info)
  *
  * Returns: the MIME type for #TrackerDecoratorInfo on success or #NULL on error.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 const gchar *
 tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info)
@@ -1643,14 +1643,13 @@ tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info)
  * 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().
+ * #TrackerSparqlBuilder. Use tracker_decorator_info_complete() to complete
+ * the task instead of using this object.
  *
  * Returns: (transfer none): the #GTask for #TrackerDecoratorInfo on
  * success or #NULL if there is no existing #GTask.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 GTask *
 tracker_decorator_info_get_task (TrackerDecoratorInfo *info)
@@ -1662,7 +1661,7 @@ tracker_decorator_info_get_task (TrackerDecoratorInfo *info)
 /**
  * tracker_decorator_info_complete:
  * @info: a #TrackerDecoratorInfo
- * @sparql: SPARQL string
+ * @sparql: (transfer full): SPARQL string
  *
  * Completes the task associated to this #TrackerDecoratorInfo.
  * Takes ownership of @sparql.
@@ -1679,7 +1678,7 @@ tracker_decorator_info_complete (TrackerDecoratorInfo *info,
 /**
  * tracker_decorator_info_complete_error:
  * @info: a #TrackerDecoratorInfo
- * @error: An error occurred during SPARQL generation
+ * @error: (transfer full): An error occurred during SPARQL generation
  *
  * Completes the task associated to this #TrackerDecoratorInfo,
  * returning the given @error happened during SPARQL generation.
diff --git a/src/libtracker-miner/tracker-file-data-provider.c 
b/src/libtracker-miner/tracker-file-data-provider.c
index 97ee9cce6..8f983ce33 100644
--- a/src/libtracker-miner/tracker-file-data-provider.c
+++ b/src/libtracker-miner/tracker-file-data-provider.c
@@ -212,7 +212,7 @@ tracker_file_data_provider_file_iface_init (TrackerDataProviderIface *iface)
  * Returns: (transfer full): a #TrackerDataProvider which must be
  * unreferenced with g_object_unref().
  *
- * Since: 1.2:
+ * Since: 1.2
  **/
 TrackerDataProvider *
 tracker_file_data_provider_new (void)
diff --git a/src/libtracker-miner/tracker-indexing-tree.c b/src/libtracker-miner/tracker-indexing-tree.c
index dbda0f46f..53007931c 100644
--- a/src/libtracker-miner/tracker-indexing-tree.c
+++ b/src/libtracker-miner/tracker-indexing-tree.c
@@ -276,7 +276,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
         * signalled when the tracker_indexing_tree_add() API is
         * called.
         *
-        * Since: 0.14.0
+        * Since: 0.14
         **/
        signals[DIRECTORY_ADDED] =
                g_signal_new ("directory-added",
@@ -299,7 +299,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
         * signalled when the tracker_indexing_tree_remove() API is
         * called.
         *
-        * Since: 0.14.0
+        * Since: 0.14
         **/
        signals[DIRECTORY_REMOVED] =
                g_signal_new ("directory-removed",
@@ -321,7 +321,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
         * calls to tracker_indexing_tree_add()), or anytime an update is
         * requested through tracker_indexing_tree_notify_update().
         *
-        * Since: 0.14.0
+        * Since: 0.14
         **/
        signals[DIRECTORY_UPDATED] =
                g_signal_new ("directory-updated",
@@ -378,7 +378,7 @@ tracker_indexing_tree_init (TrackerIndexingTree *tree)
  *
  * Returns: a newly allocated #TrackerIndexingTree
  *
- * Since: 0.14.0
+ * Since: 0.14
  **/
 TrackerIndexingTree *
 tracker_indexing_tree_new (void)
@@ -948,7 +948,7 @@ tracker_indexing_tree_parent_is_indexable (TrackerIndexingTree *tree,
  *
  * Returns: %FALSE if hidden files are indexed, otherwise %TRUE.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 gboolean
 tracker_indexing_tree_get_filter_hidden (TrackerIndexingTree *tree)
@@ -975,7 +975,7 @@ tracker_indexing_tree_get_filter_hidden (TrackerIndexingTree *tree)
  * To ignore hidden files, @filter_hidden should be %TRUE, otherwise
  * %FALSE.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_indexing_tree_set_filter_hidden (TrackerIndexingTree *tree,
@@ -1004,7 +1004,7 @@ tracker_indexing_tree_set_filter_hidden (TrackerIndexingTree *tree,
  * For example, you can (by default), disable indexing all directories
  * using this function.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 void
 tracker_indexing_tree_set_default_policy (TrackerIndexingTree *tree,
@@ -1032,9 +1032,9 @@ tracker_indexing_tree_set_default_policy (TrackerIndexingTree *tree,
  * (#TRACKER_FILTER_FILE).
  *
  * Returns: Either #TRACKER_FILTER_POLICY_DENY or
- * #TRACKER_FILTER_POLICY_ALLOW.
+ * #TRACKER_FILTER_POLICY_ACCEPT.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 TrackerFilterPolicy
 tracker_indexing_tree_get_default_policy (TrackerIndexingTree *tree,
@@ -1137,7 +1137,7 @@ tracker_indexing_tree_get_root (TrackerIndexingTree   *tree,
  * %NULL on error. The root is owned by @tree and should not be freed.
  * It can be referenced using g_object_ref().
  *
- * Since: 1.2.
+ * Since: 1.2
  **/
 GFile *
 tracker_indexing_tree_get_master_root (TrackerIndexingTree *tree)
@@ -1161,7 +1161,7 @@ tracker_indexing_tree_get_master_root (TrackerIndexingTree *tree)
  *
  * Returns: %TRUE if @file matches the URL canonically, otherwise %FALSE.
  *
- * Since: 1.2.
+ * Since: 1.2
  **/
 gboolean
 tracker_indexing_tree_file_is_root (TrackerIndexingTree *tree,
diff --git a/src/libtracker-miner/tracker-indexing-tree.h b/src/libtracker-miner/tracker-indexing-tree.h
index 3a3731f51..aa2112893 100644
--- a/src/libtracker-miner/tracker-indexing-tree.h
+++ b/src/libtracker-miner/tracker-indexing-tree.h
@@ -57,6 +57,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.
+ * @child_updated: Called when a file inside 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 172a83f4d..b5b552bc1 100644
--- a/src/libtracker-miner/tracker-miner-enums.h
+++ b/src/libtracker-miner/tracker-miner-enums.h
@@ -49,7 +49,7 @@ G_BEGIN_DECLS
  * used and this flag makes sure the directory is given a priority
  * over other directories queued.
  * @TRACKER_DIRECTORY_FLAG_NO_STAT: For cases where the content being
- * crawled by the #TrackerEnumerator is not local (e.g. it's on a
+ * crawled by the enumerator is not local (e.g. it's on a
  * server somewhere), use the #TRACKER_DIRECTORY_FLAG_NO_STAT flag.
  * The default is to use stat() and assume we're mining a local or
  * mounted file system.
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index 8b070bd4b..c896c5d8d 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -320,7 +320,7 @@ static guint signals[LAST_SIGNAL] = { 0, };
  *
  * Returns: the #GQuark used for the domain of a #GError.
  *
- * Since: 1.2.
+ * Since: 1.2
  **/
 G_DEFINE_QUARK (TrackerMinerFSError, tracker_miner_fs_error)
 
@@ -2442,7 +2442,7 @@ check_file_parents (TrackerMinerFS *fs,
  * Tells the filesystem miner to check and index a file at
  * a given priority, this file must be part of the usual
  * crawling directories of #TrackerMinerFS. See
- * tracker_miner_fs_directory_add().
+ * tracker_indexing_tree_add().
  *
  * Since: 0.10
  **/
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index 32e948aed..d4398af3c 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -72,6 +72,10 @@ struct _TrackerMinerFS {
  * a file's attributes changes, for example, the mtime.
  * @finished_root: Called when all resources on a particular root URI
  * have been processed.
+ * @remove_file: Called when a file is removed.
+ * @remove_children: Called when children have been removed.
+ * @move_file: Called when a file has moved.
+ * @filter_event: Called to filter the event happening to a file.
  * @padding: Reserved for future API improvements.
  *
  * Prototype for the abstract class, @process_file must be implemented
@@ -125,7 +129,7 @@ typedef struct {
  * Possible errors returned when calling creating new objects based on
  * the #TrackerMinerFS type and other APIs available with this class.
  *
- * Since: 1.2.
+ * Since: 1.2
  **/
 typedef enum {
        TRACKER_MINER_FS_ERROR_INIT,
diff --git a/src/libtracker-miner/tracker-miner-object.h b/src/libtracker-miner/tracker-miner-object.h
index 180ac83a5..62513061b 100644
--- a/src/libtracker-miner/tracker-miner-object.h
+++ b/src/libtracker-miner/tracker-miner-object.h
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
  * The name of the D-Bus interface to use for all data miners that
  * inter-operate with Tracker.
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 #define TRACKER_MINER_DBUS_INTERFACE   "org.freedesktop.Tracker1.Miner"
 
@@ -50,7 +50,7 @@ G_BEGIN_DECLS
  * example and would show up on D-Bus under
  * &quot;org.freedesktop.Tracker1.Miner.Files&quot;.
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 #define TRACKER_MINER_DBUS_NAME_PREFIX "org.freedesktop.Tracker1.Miner."
 
@@ -62,7 +62,7 @@ G_BEGIN_DECLS
  * example and would show up on D-Bus under
  * &quot;/org/freedesktop/Tracker1/Miner/Files&quot;.
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 #define TRACKER_MINER_DBUS_PATH_PREFIX "/org/freedesktop/Tracker1/Miner/"
 
@@ -78,7 +78,7 @@ G_BEGIN_DECLS
  *
  * Used as the domain for any #GErrors reported by @TrackerMiner objects.
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 #define TRACKER_MINER_ERROR_DOMAIN "TrackerMiner"
 
@@ -88,7 +88,7 @@ G_BEGIN_DECLS
  * Returns the @GQuark used for #GErrors and for @TrackerMiner
  * implementations. This calls tracker_miner_error_quark().
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 #define TRACKER_MINER_ERROR        tracker_miner_error_quark()
 
diff --git a/src/libtracker-miner/tracker-miner-online.c b/src/libtracker-miner/tracker-miner-online.c
index 9717f3a6b..cf4733601 100644
--- a/src/libtracker-miner/tracker-miner-online.c
+++ b/src/libtracker-miner/tracker-miner-online.c
@@ -44,7 +44,7 @@
  * a connection is valid to retrieve data or not. The miner data extraction
  * still must be dictated through the #TrackerMiner vmethods.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 
 typedef struct _TrackerMinerOnlinePrivate TrackerMinerOnlinePrivate;
@@ -158,7 +158,7 @@ tracker_miner_online_class_init (TrackerMinerOnlineClass *klass)
         * Return values of #TRUE from this signal indicate whether a
         * #TrackerMiner should resume indexing or not upon ::connected.
         *
-        * Since: 0.18.0
+        * Since: 0.18
         **/
        signals[CONNECTED] =
                g_signal_new ("connected",
@@ -176,7 +176,7 @@ tracker_miner_online_class_init (TrackerMinerOnlineClass *klass)
         * the ::disconnected signal is emitted when a specific @type of
         * network becomes disconnected.
         *
-        * Since: 0.18.0
+        * Since: 0.18
         **/
        signals[DISCONNECTED] =
                g_signal_new ("disconnected",
@@ -392,7 +392,7 @@ miner_online_initable_iface_init (GInitableIface *iface)
  *
  * Returns: a #TrackerNetworkType on success or #TRACKER_NETWORK_TYPE_NONE on error.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 TrackerNetworkType
 tracker_miner_online_get_network_type (TrackerMinerOnline *miner)
diff --git a/src/libtracker-miner/tracker-miner-online.h b/src/libtracker-miner/tracker-miner-online.h
index 6a25cd529..b7bdc5d3e 100644
--- a/src/libtracker-miner/tracker-miner-online.h
+++ b/src/libtracker-miner/tracker-miner-online.h
@@ -58,7 +58,7 @@ struct _TrackerMinerOnline {
  *
  * Virtual methods that can be overridden.
  *
- * Since: 0.18.
+ * Since: 0.18
  **/
 struct _TrackerMinerOnlineClass {
        TrackerMinerClass parent_class;
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]