[tracker/tracker-0.10] docs, libtracker-miner: Added missing 'Since:' tags



commit a1ef654da81317763dc5a38c80b6cc293175d4ac
Author: Aleksander Morgado <aleksander lanedo com>
Date:   Tue Feb 8 13:56:33 2011 +0100

    docs, libtracker-miner: Added missing 'Since:' tags

 src/libtracker-miner/tracker-miner-fs.c          |   37 ++++++++++++++++++++
 src/libtracker-miner/tracker-miner-manager.c     |   40 +++++++++++++++++++++-
 src/libtracker-miner/tracker-miner-manager.h     |    2 +
 src/libtracker-miner/tracker-miner-object.c      |   36 +++++++++++++++++++
 src/libtracker-miner/tracker-miner-web.c         |   10 +++++
 src/libtracker-miner/tracker-network-provider.c  |    6 +++
 src/libtracker-miner/tracker-password-provider.c |   20 +++++++++--
 src/libtracker-miner/tracker-password-provider.h |    4 ++-
 src/libtracker-miner/tracker-storage.c           |   12 ++++++
 src/libtracker-miner/tracker-storage.h           |    6 +++
 10 files changed, 168 insertions(+), 5 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index 8e5b1e8..aca9f7b 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -426,6 +426,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 * in order to check whether @file must be inspected my @miner_fs.
 	 *
 	 * Returns: %TRUE if @file must be inspected.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[CHECK_FILE] =
 		g_signal_new ("check-file",
@@ -446,6 +448,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 * in order to check whether @directory must be inspected my @miner_fs.
 	 *
 	 * Returns: %TRUE if @directory must be inspected.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[CHECK_DIRECTORY] =
 		g_signal_new ("check-directory",
@@ -469,6 +473,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 * to discard backup directories for example.
 	 *
 	 * Returns: %TRUE if @directory must be inspected.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[CHECK_DIRECTORY_CONTENTS] =
 		g_signal_new ("check-directory-contents",
@@ -489,6 +495,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 * check whether @directory must be monitored for filesystem changes or not.
 	 *
 	 * Returns: %TRUE if the directory must be monitored for changes.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[MONITOR_DIRECTORY] =
 		g_signal_new ("monitor-directory",
@@ -521,6 +529,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 *
 	 * Returns: %TRUE if the file is accepted for processing,
 	 *          %FALSE if the file should be ignored.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[PROCESS_FILE] =
 		g_signal_new ("process-file",
@@ -555,6 +565,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 *
 	 * Returns: %TRUE if the file is accepted for processing,
 	 *          %FALSE if the file should be ignored.
+	 *
+	 * Since: 0.10
 	 **/
 	signals[PROCESS_FILE_ATTRIBUTES] =
 		g_signal_new ("process-file-attributes",
@@ -581,6 +593,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 *
 	 * Returns: %TRUE on success
 	 *          %FALSE on failure
+	 *
+	 * Since: 0.8
 	 **/
 	signals[IGNORE_NEXT_UPDATE_FILE] =
 		g_signal_new ("ignore-next-update-file",
@@ -603,6 +617,8 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 *
 	 * The ::finished signal is emitted when @miner_fs has finished
 	 * all pending processing.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[FINISHED] =
 		g_signal_new ("finished",
@@ -3922,6 +3938,8 @@ tracker_miner_fs_directory_add_internal (TrackerMinerFS *fs,
  * @recurse: whether the directory should be inspected recursively
  *
  * Tells the filesystem miner to inspect a directory.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_fs_directory_add (TrackerMinerFS *fs,
@@ -4009,6 +4027,8 @@ processing_pool_cancel_foreach (gpointer data,
  *  watches are removed.
  *
  * Returns: %TRUE if the directory was successfully removed.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_fs_directory_remove (TrackerMinerFS *fs,
@@ -4095,6 +4115,8 @@ tracker_miner_fs_directory_remove (TrackerMinerFS *fs,
  * store.
  *
  * Returns: %TRUE if the directory was successfully removed.
+ *
+ * Since: 0.10
  **/
 gboolean
 tracker_miner_fs_directory_remove_full (TrackerMinerFS *fs,
@@ -4169,6 +4191,8 @@ check_file_parents (TrackerMinerFS *fs,
  * Tells the filesystem miner to check and index a file,
  * this file must be part of the usual crawling directories
  * of #TrackerMinerFS. See tracker_miner_fs_directory_add().
+ *
+ * Since: 0.10
  **/
 void
 tracker_miner_fs_check_file (TrackerMinerFS *fs,
@@ -4215,6 +4239,8 @@ tracker_miner_fs_check_file (TrackerMinerFS *fs,
  * Tells the filesystem miner to check and index a directory,
  * this file must be part of the usual crawling directories
  * of #TrackerMinerFS. See tracker_miner_fs_directory_add().
+ *
+ * Since: 0.10
  **/
 void
 tracker_miner_fs_check_directory (TrackerMinerFS *fs,
@@ -4257,6 +4283,8 @@ tracker_miner_fs_check_directory (TrackerMinerFS *fs,
  * Notifies @fs that all processing on @file has been finished, if any error
  * happened during file data processing, it should be passed in @error, else
  * that parameter will contain %NULL to reflect success.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_fs_file_notify (TrackerMinerFS *fs,
@@ -4302,6 +4330,8 @@ tracker_miner_fs_file_notify (TrackerMinerFS *fs,
  * a value of 0 means no throttling at all, so the miner
  * will perform operations at full speed, 1 is the slowest
  * value.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_fs_set_throttle (TrackerMinerFS *fs,
@@ -4342,6 +4372,8 @@ tracker_miner_fs_set_throttle (TrackerMinerFS *fs,
  * Gets the current throttle value. see tracker_miner_fs_set_throttle().
  *
  * Returns: current throttle value.
+ *
+ * Since: 0.8
  **/
 gdouble
 tracker_miner_fs_get_throttle (TrackerMinerFS *fs)
@@ -4364,6 +4396,8 @@ tracker_miner_fs_get_throttle (TrackerMinerFS *fs)
  *
  * Returns: The URN containing the data associated to @file,
  *          or %NULL.
+ *
+ * Since: 0.8
  **/
 G_CONST_RETURN gchar *
 tracker_miner_fs_get_urn (TrackerMinerFS *fs,
@@ -4454,6 +4488,8 @@ tracker_miner_fs_query_urn (TrackerMinerFS *fs,
  * return non-%NULL.
  *
  * Returns: The parent folder URN, or %NULL.
+ *
+ * Since: 0.8
  **/
 G_CONST_RETURN gchar *
 tracker_miner_fs_get_parent_urn (TrackerMinerFS *fs,
@@ -4618,6 +4654,7 @@ tracker_miner_fs_has_items_to_process (TrackerMinerFS *fs)
  * caches, an extra query will be done so that these elements
  * are taken into account.
  *
+ * Since: 0.10
  **/
 void
 tracker_miner_fs_add_directory_without_parent (TrackerMinerFS *fs,
diff --git a/src/libtracker-miner/tracker-miner-manager.c b/src/libtracker-miner/tracker-miner-manager.c
index 623334d..4bf03e2 100644
--- a/src/libtracker-miner/tracker-miner-manager.c
+++ b/src/libtracker-miner/tracker-miner-manager.c
@@ -103,6 +103,8 @@ tracker_miner_manager_class_init (TrackerMinerManagerClass *klass)
 	 *
 	 * The ::miner-progress signal is meant to report status/progress changes
 	 * in any tracked miner.
+	 *
+	 * Since: 0.8
 	 **/
 	signals [MINER_PROGRESS] =
 		g_signal_new ("miner-progress",
@@ -122,6 +124,8 @@ tracker_miner_manager_class_init (TrackerMinerManagerClass *klass)
 	 *
 	 * The ::miner-paused signal will be emitted whenever a miner
 	 * (referenced by @miner) is paused.
+	 *
+	 * Since: 0.8
 	 **/
 	signals [MINER_PAUSED] =
 		g_signal_new ("miner-paused",
@@ -139,6 +143,8 @@ tracker_miner_manager_class_init (TrackerMinerManagerClass *klass)
 	 *
 	 * The ::miner-resumed signal will be emitted whenever a miner
 	 * (referenced by @miner) is resumed.
+	 *
+	 * Since: 0.8
 	 **/
 	signals [MINER_RESUMED] =
 		g_signal_new ("miner-resumed",
@@ -157,6 +163,8 @@ tracker_miner_manager_class_init (TrackerMinerManagerClass *klass)
 	 * The ::miner-activated signal will be emitted whenever a miner
 	 * (referenced by @miner) is activated (technically, this means
 	 * the miner has appeared in the session bus).
+	 *
+	 * Since: 0.8
 	 **/
 	signals [MINER_ACTIVATED] =
 		g_signal_new ("miner-activated",
@@ -175,6 +183,8 @@ tracker_miner_manager_class_init (TrackerMinerManagerClass *klass)
 	 * The ::miner-deactivated signal will be emitted whenever a miner
 	 * (referenced by @miner) is deactivated (technically, this means
 	 * the miner has disappeared from the session bus).
+	 *
+	 * Since: 0.8
 	 **/
 	signals [MINER_DEACTIVATED] =
 		g_signal_new ("miner-deactivated",
@@ -450,6 +460,8 @@ miner_manager_finalize (GObject *object)
  * Creates a new #TrackerMinerManager instance.
  *
  * Returns: a #TrackerMinerManager.
+ *
+ * Since: 0.8
  **/
 TrackerMinerManager *
 tracker_miner_manager_new (void)
@@ -467,6 +479,8 @@ tracker_miner_manager_new (void)
  * Returns: a #GSList which must be freed with g_slist_free() and all
  * contained data with g_free(). Otherwise %NULL is returned if there
  * are no miners.
+ *
+ * Since: 0.8
  **/
 GSList *
 tracker_miner_manager_get_running (TrackerMinerManager *manager)
@@ -643,6 +657,8 @@ initialize_miners_data (TrackerMinerManager *manager)
  * Returns: a #GSList which must be freed with g_slist_free() and all
  * contained data with g_free(). Otherwise %NULL is returned if there
  * are no miners.
+ *
+ * Since: 0.8
  **/
 GSList *
 tracker_miner_manager_get_available (TrackerMinerManager *manager)
@@ -675,6 +691,8 @@ tracker_miner_manager_get_available (TrackerMinerManager *manager)
  *
  * Returns: %TRUE if the miner was paused successfully, otherwise
  * %FALSE.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_pause (TrackerMinerManager *manager,
@@ -743,6 +761,8 @@ tracker_miner_manager_pause (TrackerMinerManager *manager,
  *
  * Returns: %TRUE if the miner was successfully resumed, otherwise
  * %FALSE.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_resume (TrackerMinerManager *manager,
@@ -789,6 +809,8 @@ tracker_miner_manager_resume (TrackerMinerManager *manager,
  * Returns the miner's current activity.
  *
  * Returns: %TRUE if the @miner is active, otherwise %FALSE.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_is_active (TrackerMinerManager *manager,
@@ -840,6 +862,8 @@ tracker_miner_manager_is_active (TrackerMinerManager *manager,
  *
  * Returns: %TRUE if the status could be retrieved successfully,
  * otherwise %FALSE
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_get_status (TrackerMinerManager  *manager,
@@ -929,6 +953,8 @@ tracker_miner_manager_get_status (TrackerMinerManager  *manager,
  * application/pause reason pairs have the same index.
  *
  * Returns: %TRUE if @miner is paused, otherwise %FALSE.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_is_paused (TrackerMinerManager *manager,
@@ -1003,6 +1029,8 @@ tracker_miner_manager_is_paused (TrackerMinerManager *manager,
  * Returns a translated display name for @miner.
  *
  * Returns: A string which should not be freed or %NULL.
+ *
+ * Since: 0.8
  **/
 const gchar *
 tracker_miner_manager_get_display_name (TrackerMinerManager *manager,
@@ -1035,6 +1063,8 @@ tracker_miner_manager_get_display_name (TrackerMinerManager *manager,
  * Returns the description for the given @miner.
  *
  * Returns: A string which should not be freed or %NULL if none is specified.
+ *
+ * Since: 0.8
  **/
 const gchar *
 tracker_miner_manager_get_description (TrackerMinerManager *manager,
@@ -1072,6 +1102,8 @@ tracker_miner_manager_get_description (TrackerMinerManager *manager,
  * the stack the changes to @urls.
  *
  * Returns: %TRUE on success, otherwise %FALSE.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
@@ -1116,6 +1148,8 @@ tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
  *
  * Returns: the #GQuark used to identify miner manager errors in
  * GError structures.
+ *
+ * Since: 0.8
  **/
 GQuark
 tracker_miner_manager_error_quark (void)
@@ -1142,6 +1176,8 @@ tracker_miner_manager_error_quark (void)
  * On failure @error will be set.
  *
  * Returns: %TRUE on success, otherwise %FALSE.
+ *
+ * Since: 0.10
  **/
 gboolean
 tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager  *manager,
@@ -1195,10 +1231,12 @@ tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager  *manager,
  * @error: return location for errors
  *
  * Tells the filesystem miner to index the @file.
- * 
+ *
  * On failure @error will be set.
  *
  * Returns: %TRUE on success, otherwise %FALSE.
+ *
+ * Since: 0.10
  **/
 gboolean
 tracker_miner_manager_index_file (TrackerMinerManager  *manager,
diff --git a/src/libtracker-miner/tracker-miner-manager.h b/src/libtracker-miner/tracker-miner-manager.h
index 763383e..7f1842c 100644
--- a/src/libtracker-miner/tracker-miner-manager.h
+++ b/src/libtracker-miner/tracker-miner-manager.h
@@ -49,6 +49,8 @@ typedef struct _TrackerMinerManagerClass TrackerMinerManagerClass;
  *
  * Enumeration values used in errors returned by the
  * #TrackerMinerManager API.
+ *
+ * Since: 0.8
  **/
 typedef enum {
 	TRACKER_MINER_MANAGER_ERROR_NOT_AVAILABLE,
diff --git a/src/libtracker-miner/tracker-miner-object.c b/src/libtracker-miner/tracker-miner-object.c
index 8aa09c3..7d03dc6 100644
--- a/src/libtracker-miner/tracker-miner-object.c
+++ b/src/libtracker-miner/tracker-miner-object.c
@@ -205,6 +205,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * the ::started signal is emitted in the miner
 	 * right after it has been started through
 	 * tracker_miner_start().
+	 *
+	 * Since: 0.8
 	 **/
 	signals[STARTED] =
 		g_signal_new ("started",
@@ -221,6 +223,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * the ::stopped signal is emitted in the miner
 	 * right after it has been stopped through
 	 * tracker_miner_stop().
+	 *
+	 * Since: 0.8
 	 **/
 	signals[STOPPED] =
 		g_signal_new ("stopped",
@@ -238,6 +242,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * there is any reason to pause, either
 	 * internal (through tracker_miner_pause()) or
 	 * external (through DBus, see #TrackerMinerManager).
+	 *
+	 * Since: 0.8
 	 **/
 	signals[PAUSED] =
 		g_signal_new ("paused",
@@ -254,6 +260,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * the ::resumed signal is emitted whenever
 	 * all reasons to pause have disappeared, see
 	 * tracker_miner_resume() and #TrackerMinerManager.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[RESUMED] =
 		g_signal_new ("resumed",
@@ -273,6 +281,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * to indicate progress about the data mining process. @status will
 	 * contain a translated string with the current miner status and @progress
 	 * will indicate how much has been processed so far.
+	 *
+	 * Since: 0.8
 	 **/
 	signals[PROGRESS] =
 		g_signal_new ("progress",
@@ -293,6 +303,8 @@ tracker_miner_class_init (TrackerMinerClass *klass)
 	 * the ::ignore-next-update signal is emitted in the miner
 	 * right after it has been asked to mark @urls as to ignore on next update
 	 * through tracker_miner_ignore_next_update().
+	 *
+	 * Since: 0.8
 	 **/
 	signals[IGNORE_NEXT_UPDATE] =
 		g_signal_new ("ignore-next-update",
@@ -599,6 +611,8 @@ pause_data_destroy (gpointer data)
  * Returns the #GQuark used to identify miner errors in GError structures.
  *
  * Returns: the error #GQuark
+ *
+ * Since: 0.8
  **/
 GQuark
 tracker_miner_error_quark (void)
@@ -611,6 +625,8 @@ tracker_miner_error_quark (void)
  * @miner: a #TrackerMiner
  *
  * Tells the miner to start processing data.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_start (TrackerMiner *miner)
@@ -638,6 +654,8 @@ tracker_miner_start (TrackerMiner *miner)
  * @miner: a #TrackerMiner
  *
  * Tells the miner to stop processing data.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_stop (TrackerMiner *miner)
@@ -666,6 +684,8 @@ tracker_miner_stop (TrackerMiner *miner)
  * @urls: the urls to mark as to ignore on next update
  *
  * Tells the miner to mark @urls are to ignore on next update.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_ignore_next_update (TrackerMiner *miner,
@@ -683,6 +703,8 @@ tracker_miner_ignore_next_update (TrackerMiner *miner,
  * Returns #TRUE if the miner has been started.
  *
  * Returns: #TRUE if the miner is already started.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_is_started (TrackerMiner *miner)
@@ -699,6 +721,8 @@ tracker_miner_is_started (TrackerMiner *miner)
  * Returns #TRUE if the miner is paused.
  *
  * Returns: #TRUE if the miner is paused.
+ *
+ * Since: 0.10
  **/
 gboolean
 tracker_miner_is_paused (TrackerMiner *miner)
@@ -768,6 +792,8 @@ tracker_miner_pause_internal (TrackerMiner  *miner,
  * operations. On failure @error will be set and -1 will be returned.
  *
  * Returns: The pause cookie ID.
+ *
+ * Since: 0.8
  **/
 gint
 tracker_miner_pause (TrackerMiner  *miner,
@@ -799,6 +825,8 @@ tracker_miner_pause (TrackerMiner  *miner,
  * operations until all pause requests have been resumed.
  *
  * Returns: #TRUE if the cookie was valid.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_miner_resume (TrackerMiner  *miner,
@@ -839,6 +867,8 @@ tracker_miner_resume (TrackerMiner  *miner,
  * Gets the #TrackerSparqlConnection initialized by @miner
  *
  * Returns: a #TrackerSparqlConnection.
+ *
+ * Since: 0.10
  **/
 TrackerSparqlConnection *
 tracker_miner_get_connection (TrackerMiner *miner)
@@ -853,6 +883,8 @@ tracker_miner_get_connection (TrackerMiner *miner)
  * Gets the #GDBusConnection initialized by @miner
  *
  * Returns: a #GDBusConnection.
+ *
+ * Since: 0.10
  **/
 GDBusConnection *
 tracker_miner_get_dbus_connection (TrackerMiner *miner)
@@ -867,6 +899,8 @@ tracker_miner_get_dbus_connection (TrackerMiner *miner)
  * Gets the DBus name registered by @miner
  *
  * Returns: a constant string which should not be modified by the caller.
+ *
+ * Since: 0.10
  **/
 G_CONST_RETURN gchar *
 tracker_miner_get_dbus_full_name (TrackerMiner *miner)
@@ -881,6 +915,8 @@ tracker_miner_get_dbus_full_name (TrackerMiner *miner)
  * Gets the DBus path registered by @miner
  *
  * Returns: a constant string which should not be modified by the caller.
+ *
+ * Since: 0.10
  **/
 G_CONST_RETURN gchar *
 tracker_miner_get_dbus_full_path (TrackerMiner *miner)
diff --git a/src/libtracker-miner/tracker-miner-web.c b/src/libtracker-miner/tracker-miner-web.c
index cf14b39..7da7632 100644
--- a/src/libtracker-miner/tracker-miner-web.c
+++ b/src/libtracker-miner/tracker-miner-web.c
@@ -472,6 +472,8 @@ handle_set_property (GDBusConnection  *connection,
  *
  * Returns: the #GQuark used to identify miner web errors in GError
  * structures.
+ *
+ * Since: 0.8
  **/
 GQuark
 tracker_miner_web_error_quark (void)
@@ -486,6 +488,8 @@ tracker_miner_web_error_quark (void)
  *
  * Asks @miner to authenticate with a remote service. On failure
  * @error will be set.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_web_authenticate (TrackerMinerWeb  *miner,
@@ -508,6 +512,8 @@ tracker_miner_web_authenticate (TrackerMinerWeb  *miner,
  *
  * Returns: a %GHashTable with the data. On failure @error will be set
  * and %NULL will be returned.
+ *
+ * Since: 0.8
  **/
 GHashTable *
 tracker_miner_web_get_association_data (TrackerMinerWeb  *miner,
@@ -531,6 +537,8 @@ tracker_miner_web_get_association_data (TrackerMinerWeb  *miner,
  * information.
  *
  * On failure @error will be set.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_web_associate (TrackerMinerWeb  *miner,
@@ -553,6 +561,8 @@ tracker_miner_web_associate (TrackerMinerWeb  *miner,
  * which could be used to authenticate with the remote service.
  *
  * On failure @error will be set.
+ *
+ * Since: 0.8
  **/
 void
 tracker_miner_web_dissociate (TrackerMinerWeb   *miner,
diff --git a/src/libtracker-miner/tracker-network-provider.c b/src/libtracker-miner/tracker-network-provider.c
index 5abf73e..5c6d7b9 100644
--- a/src/libtracker-miner/tracker-network-provider.c
+++ b/src/libtracker-miner/tracker-network-provider.c
@@ -57,6 +57,8 @@ tracker_network_provider_init (gpointer object_class)
 		 *
 		 * the ::status-changed signal is emitted whenever the backend informs
 		 * that the network status changed.
+		 *
+		 * Since: 0.10
 		 **/
 		g_signal_new ("status-changed",
 		              TRACKER_TYPE_NETWORK_PROVIDER,
@@ -106,6 +108,8 @@ tracker_network_provider_get_type (void)
  *
  * Returns: a newly allocated string representing the name which must
  * be freed with g_free().
+ *
+ * Since: 0.10
  **/
 gchar *
 tracker_network_provider_get_name (TrackerNetworkProvider *provider)
@@ -127,6 +131,8 @@ tracker_network_provider_get_name (TrackerNetworkProvider *provider)
  *
  * Returns: a TrackerNetworkProviderStatus decribing the current network
  * status.
+ *
+ * Since: 0.10
  **/
 TrackerNetworkProviderStatus
 tracker_network_provider_get_status (TrackerNetworkProvider *provider)
diff --git a/src/libtracker-miner/tracker-password-provider.c b/src/libtracker-miner/tracker-password-provider.c
index 4a5f745..5c9dd58 100644
--- a/src/libtracker-miner/tracker-password-provider.c
+++ b/src/libtracker-miner/tracker-password-provider.c
@@ -84,6 +84,8 @@ tracker_password_provider_get_type (void)
  *
  * Returns: the #GQuark used to identify password provider errors in
  * GError structures.
+ *
+ * Since: 0.8
  **/
 GQuark
 tracker_password_provider_error_quark (void)
@@ -101,6 +103,8 @@ tracker_password_provider_error_quark (void)
  *
  * Returns: a newly allocated string representing the name which must
  * be freed with g_free().
+ *
+ * Since: 0.8
  **/
 gchar *
 tracker_password_provider_get_name (TrackerPasswordProvider *provider)
@@ -129,6 +133,8 @@ tracker_password_provider_get_name (TrackerPasswordProvider *provider)
  *
  * Returns: %TRUE if the password was saved, otherwise %FALSE is
  * returned and @error will be set.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_password_provider_store_password (TrackerPasswordProvider  *provider,
@@ -167,6 +173,8 @@ tracker_password_provider_store_password (TrackerPasswordProvider  *provider,
  * Returns: a newly allocated string representing a password which
  * must be freed with g_free(), otherwise %NULL is returned and @error
  * will be set.
+ *
+ * Since: 0.8
  **/
 gchar *
 tracker_password_provider_get_password (TrackerPasswordProvider  *provider,
@@ -198,6 +206,8 @@ tracker_password_provider_get_password (TrackerPasswordProvider  *provider,
  * implementation with @service.
  *
  * On failure @error will be set.
+ *
+ * Since: 0.8
  **/
 void
 tracker_password_provider_forget_password (TrackerPasswordProvider  *provider,
@@ -225,12 +235,14 @@ tracker_password_provider_forget_password (TrackerPasswordProvider  *provider,
  * This function calls mlock() to secure a memory region newly
  * allocated and @password is copied using memcpy() into the new
  * address.
- * 
+ *
  * Password can not be %NULL or an empty string ("").
  *
  * Returns: a newly allocated string which <emphasis>MUST</emphasis>
  * be freed with tracker_password_provider_unlock_password(). On
  * failure %NULL is returned.
+ *
+ * Since: 0.8
  **/
 gchar *
 tracker_password_provider_lock_password (const gchar *password)
@@ -260,13 +272,15 @@ tracker_password_provider_lock_password (const gchar *password)
  *
  * This function calls munlock() on @password which should be a
  * secured memory region. The @password is zeroed first with bzero()
- * and once unlocked it is freed with g_free(). 
+ * and once unlocked it is freed with g_free().
  *
  * The @password can not be %NULL or an empty string (""). In
  * addition, @password <emphasis>MUST</emphasis> be a string created
  * with tracker_password_provider_lock_password().
  *
  * Returns: %TRUE if munlock() succeeded, otherwise %FALSE is returned.
+ *
+ * Since: 0.8
  **/
 gboolean
 tracker_password_provider_unlock_password (gchar *password)
@@ -275,7 +289,7 @@ tracker_password_provider_unlock_password (gchar *password)
 
 	g_return_val_if_fail (password != NULL, FALSE);
 	g_return_val_if_fail (password[0] != '\0', FALSE);
-	
+
 	bzero (password, strlen (password));
 	retval = munlock (password, sizeof (password));
 	g_free (password);
diff --git a/src/libtracker-miner/tracker-password-provider.h b/src/libtracker-miner/tracker-password-provider.h
index 5d3d7dc..dab2a85 100644
--- a/src/libtracker-miner/tracker-password-provider.h
+++ b/src/libtracker-miner/tracker-password-provider.h
@@ -64,7 +64,7 @@ typedef enum {
  * @forget_password: forget any password associated with a given
  * service
  *
- * Since: 0.8.
+ * Since: 0.8
  **/
 typedef struct {
 	GTypeInterface parent_iface;
@@ -116,6 +116,8 @@ gboolean tracker_password_provider_unlock_password  (gchar                    *p
  * Only one implementation can exist at once.
  *
  * Returns: a %TrackerPasswordProvider.
+ *
+ * Since: 0.8
  **/
 TrackerPasswordProvider *
          tracker_password_provider_get             (void);
diff --git a/src/libtracker-miner/tracker-storage.c b/src/libtracker-miner/tracker-storage.c
index 625b4ca..edd316b 100644
--- a/src/libtracker-miner/tracker-storage.c
+++ b/src/libtracker-miner/tracker-storage.c
@@ -748,6 +748,8 @@ mount_removed_cb (GVolumeMonitor *monitor,
  * Creates a new instance of #TrackerStorage.
  *
  * Returns: The newly created #TrackerStorage.
+ *
+ * Since: 0.8
  **/
 TrackerStorage *
 tracker_storage_new (void)
@@ -799,6 +801,8 @@ get_mount_point_by_uuid_foreach (gpointer key,
  * Returns: a #GSList of strings containing the root directories for
  * devices with @type based on @exact_match. Each element must be
  * freed using g_free() and the list itself through g_slist_free().
+ *
+ * Since: 0.8
  **/
 GSList *
 tracker_storage_get_device_roots (TrackerStorage     *storage,
@@ -832,6 +836,8 @@ tracker_storage_get_device_roots (TrackerStorage     *storage,
  * Returns: a #GSList of strings containing the UUID for devices with
  * @type based on @exact_match. Each element must be freed using
  * g_free() and the list itself through g_slist_free().
+ *
+ * Since: 0.8
  **/
 GSList *
 tracker_storage_get_device_uuids (TrackerStorage     *storage,
@@ -879,6 +885,8 @@ tracker_storage_get_device_uuids (TrackerStorage     *storage,
  * @uuid: A string pointer to the UUID for the %GVolume.
  *
  * Returns: The mount point for @uuid, this should not be freed.
+ *
+ * Since: 0.8
  **/
 const gchar *
 tracker_storage_get_mount_point_for_uuid (TrackerStorage *storage,
@@ -910,6 +918,8 @@ tracker_storage_get_mount_point_for_uuid (TrackerStorage *storage,
  * @uuid: A string pointer to the UUID for the %GVolume.
  *
  * Returns: The type flags for @uuid.
+ *
+ * Since: 0.10
  **/
 TrackerStorageType
 tracker_storage_get_type_for_uuid (TrackerStorage     *storage,
@@ -951,6 +961,8 @@ tracker_storage_get_type_for_uuid (TrackerStorage     *storage,
  *
  * Returns: Returns the UUID of the removable device for @file, this
  * should not be freed.
+ *
+ * Since: 0.8
  **/
 const gchar *
 tracker_storage_get_uuid_for_file (TrackerStorage *storage,
diff --git a/src/libtracker-miner/tracker-storage.h b/src/libtracker-miner/tracker-storage.h
index 9970edf..f3101c0 100644
--- a/src/libtracker-miner/tracker-storage.h
+++ b/src/libtracker-miner/tracker-storage.h
@@ -35,6 +35,8 @@ G_BEGIN_DECLS
  * @TRACKER_STORAGE_OPTICAL: Storage is an optical disc
  *
  * Flags specifying properties of the type of storage.
+ *
+ * Since: 0.8
  */
 typedef enum {
 	TRACKER_STORAGE_REMOVABLE = 1 << 0,
@@ -48,6 +50,8 @@ typedef enum {
  * Check if the given storage type is marked as being removable media.
  *
  * Returns: %TRUE if the storage is marked as removable media, %FALSE otherwise
+ *
+ * Since: 0.10
  */
 #define TRACKER_STORAGE_TYPE_IS_REMOVABLE(type) ((type & TRACKER_STORAGE_REMOVABLE) ? TRUE : FALSE)
 
@@ -58,6 +62,8 @@ typedef enum {
  * Check if the given storage type is marked as being optical disc
  *
  * Returns: %TRUE if the storage is marked as optical disc, %FALSE otherwise
+ *
+ * Since: 0.10
  */
 #define TRACKER_STORAGE_TYPE_IS_OPTICAL(type) ((type & TRACKER_STORAGE_OPTICAL) ? TRUE : FALSE)
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]