GNOME.org
 

[tracker/introspection: 16/17] libtracker-miner: Add introspection annotation to docs.

commit c048813086a9371beba5c2fe43b317152c4e3cfe
Author: Carlos Garnacho <carlosg gnome org>
Date:   Mon Apr 4 15:17:04 2011 +0200

    libtracker-miner: Add introspection annotation to docs.

 src/libtracker-miner/tracker-miner-fs.c          |    6 ++--
 src/libtracker-miner/tracker-miner-manager.c     |   24 +++++++++++-----------
 src/libtracker-miner/tracker-miner-object.c      |    6 ++--
 src/libtracker-miner/tracker-miner-web.c         |    8 +++---
 src/libtracker-miner/tracker-network-provider.c  |    4 +-
 src/libtracker-miner/tracker-password-provider.c |   14 ++++++------
 src/libtracker-miner/tracker-storage.c           |   14 +++++++-----
 7 files changed, 39 insertions(+), 37 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index 5d9ec79..cfe84da 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -4389,7 +4389,7 @@ tracker_miner_fs_get_throttle (TrackerMinerFS *fs)
  * If @file is not being currently processed by @fs, or doesn't
  * exist in the store yet, %NULL will be returned.
  *
- * Returns: The URN containing the data associated to @file,
+ * Returns: (transfer none): The URN containing the data associated to @file,
  *          or %NULL.
  *
  * Since: 0.8
@@ -4448,7 +4448,7 @@ tracker_miner_fs_get_urn (TrackerMinerFS *fs,
 
  * If @file doesn't exist in the store yet, %NULL will be returned.
  *
- * Returns: A newly allocated string with the URN containing the data associated
+ * Returns: (transfer full): A newly allocated string with the URN containing the data associated
  *          to @file, or %NULL.
  *
  * Since: 0.10
@@ -4482,7 +4482,7 @@ tracker_miner_fs_query_urn (TrackerMinerFS *fs,
  * children is processed, so most usually this function should
  * return non-%NULL.
  *
- * Returns: The parent folder URN, or %NULL.
+ * Returns: (transfer none): The parent folder URN, or %NULL.
  *
  * Since: 0.8
  **/
diff --git a/src/libtracker-miner/tracker-miner-manager.c b/src/libtracker-miner/tracker-miner-manager.c
index 46e483c..e1cb7dd 100644
--- a/src/libtracker-miner/tracker-miner-manager.c
+++ b/src/libtracker-miner/tracker-miner-manager.c
@@ -999,9 +999,9 @@ tracker_miner_manager_is_active (TrackerMinerManager *manager,
  * tracker_miner_manager_get_status:
  * @manager: a #TrackerMinerManager
  * @miner: miner reference
- * @status: return location for status
- * @progress: return location for progress
- * @remaining_time: return location for remaining time
+ * @status: (out) (allow-none): return location for status
+ * @progress: (out) (allow-none): return location for progress
+ * @remaining_time: (out) (allow-none): return location for remaining time
  *
  * Returns the current status, progress and remaining time for @miner.
  * @remaining_time will be 0 if not possible to compute it yet,
@@ -1116,8 +1116,8 @@ tracker_miner_manager_get_status (TrackerMinerManager  *manager,
  * tracker_miner_manager_is_paused:
  * @manager: a #TrackerMinerManager
  * @miner: miner reference
- * @applications: return location for application names.
- * @reasons: return location for pause reasons.
+ * @applications: (out callee-allocates) (allow-none) (transfer full): return location for application names.
+ * @reasons: (out callee-allocates) (allow-none) (transfer full): return location for pause reasons.
  *
  * This function either returns %FALSE if the miner is not paused,
  * or returns %TRUE and fills in @applications and @reasons with
@@ -1201,7 +1201,7 @@ tracker_miner_manager_is_paused (TrackerMinerManager *manager,
  *
  * Returns a translated display name for @miner.
  *
- * Returns: A string which should not be freed or %NULL.
+ * Returns: (transfer none): A string which should not be freed or %NULL.
  *
  * Since: 0.8
  **/
@@ -1235,7 +1235,7 @@ 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.
+ * Returns: (transfer none): A string which should not be freed or %NULL if none is specified.
  *
  * Since: 0.8
  **/
@@ -1267,7 +1267,7 @@ tracker_miner_manager_get_description (TrackerMinerManager *manager,
  * tracker_miner_manager_ignore_next_update:
  * @manager: a #TrackerMinerManager
  * @miner: miner reference
- * @urls: the subjects to ignore the next updates of
+ * @urls: (in): the subjects to ignore the next updates of
  *
  * Tells the @miner to ignore any events for the next @urls. This is
  * used for cases where a file is updated by Tracker by the
@@ -1317,7 +1317,7 @@ tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
 }
 
 /**
- * tracker_miner_manager_error_quark:
+ * tracker_miner_manager_error_quark (skip):
  *
  * Returns: the #GQuark used to identify miner manager errors in
  * GError structures.
@@ -1339,9 +1339,9 @@ tracker_miner_manager_error_quark (void)
 /**
  * tracker_miner_manager_reindex_by_mimetype:
  * @manager: a #TrackerMinerManager
- * @mimetypes: an array of mimetypes (E.G. "text/plain"). All items
+ * @mimetypes: (in): an array of mimetypes (E.G. "text/plain"). All items
  * with a mimetype in that list will be reindexed.
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Tells the filesystem miner to reindex any file with a mimetype in
  * the @mimetypes list.
@@ -1401,7 +1401,7 @@ tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager  *manager,
  * tracker_miner_manager_index_file:
  * @manager: a #TrackerMinerManager
  * @file: a URL valid in GIO of a file to give to the miner for processing
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Tells the filesystem miner to index the @file.
  *
diff --git a/src/libtracker-miner/tracker-miner-object.c b/src/libtracker-miner/tracker-miner-object.c
index ef17003..34e4f5d 100644
--- a/src/libtracker-miner/tracker-miner-object.c
+++ b/src/libtracker-miner/tracker-miner-object.c
@@ -720,7 +720,7 @@ tracker_miner_stop (TrackerMiner *miner)
 /**
  * tracker_miner_ignore_next_update:
  * @miner: a #TrackerMiner
- * @urls: the urls to mark as to ignore on next update
+ * @urls: (in): the urls to mark as to ignore on next update
  *
  * Tells the miner to mark @urls are to ignore on next update.
  *
@@ -824,7 +824,7 @@ tracker_miner_pause_internal (TrackerMiner  *miner,
  * tracker_miner_pause:
  * @miner: a #TrackerMiner
  * @reason: reason to pause
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Asks @miner to pause. On success the cookie ID is returned,
  * this is what must be used in tracker_miner_resume() to resume
@@ -857,7 +857,7 @@ tracker_miner_pause (TrackerMiner  *miner,
  * tracker_miner_resume:
  * @miner: a #TrackerMiner
  * @cookie: pause cookie
- * @error: return location for errors
+ * @error: (out) (transfer full) (allow-none): return location for errors
  *
  * Asks the miner to resume processing. The cookie must be something
  * returned by tracker_miner_pause(). The miner won't actually resume
diff --git a/src/libtracker-miner/tracker-miner-web.c b/src/libtracker-miner/tracker-miner-web.c
index 5617973..41f18d7 100644
--- a/src/libtracker-miner/tracker-miner-web.c
+++ b/src/libtracker-miner/tracker-miner-web.c
@@ -488,7 +488,7 @@ tracker_miner_web_error_quark (void)
 /**
  * tracker_miner_web_authenticate:
  * @miner: a #TrackerMinerWeb
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Asks @miner to authenticate with a remote service. On failure
  * @error will be set.
@@ -507,7 +507,7 @@ tracker_miner_web_authenticate (TrackerMinerWeb  *miner,
 /**
  * tracker_miner_web_get_association_data:
  * @miner: a #TrackerMinerWeb
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Asks @miner to retrieve association_data for. The data returned in
  * the %GHashTable depends on the @miner implementation and the type
@@ -533,7 +533,7 @@ tracker_miner_web_get_association_data (TrackerMinerWeb  *miner,
  * @miner: a #TrackerMinerWeb
  * @association_data: a %GHashTable with the data to use for
  * associating with a remote service.
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Asks @miner to associate with a remote service using
  * @association_data. To know what data to put into @association_data,
@@ -558,7 +558,7 @@ tracker_miner_web_associate (TrackerMinerWeb  *miner,
 /**
  * tracker_miner_web_dissociate:
  * @miner: a #TrackerMinerWeb
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * Asks @miner to dissociate from a remote service. At this point, the
  * miner should stop storing any credentials or sensitive information
diff --git a/src/libtracker-miner/tracker-network-provider.c b/src/libtracker-miner/tracker-network-provider.c
index 5c6d7b9..561bc96 100644
--- a/src/libtracker-miner/tracker-network-provider.c
+++ b/src/libtracker-miner/tracker-network-provider.c
@@ -106,8 +106,8 @@ tracker_network_provider_get_type (void)
  * "NetworkManager". Either of these is what will be returned unless new
  * providers are written.
  *
- * Returns: a newly allocated string representing the name which must
- * be freed with g_free().
+ * Returns: (transfer full): a newly allocated string representing the name
+ * which must be freed with g_free().
  *
  * Since: 0.10
  **/
diff --git a/src/libtracker-miner/tracker-password-provider.c b/src/libtracker-miner/tracker-password-provider.c
index 5c9dd58..e908d52 100644
--- a/src/libtracker-miner/tracker-password-provider.c
+++ b/src/libtracker-miner/tracker-password-provider.c
@@ -80,7 +80,7 @@ tracker_password_provider_get_type (void)
 }
 
 /**
- * tracker_password_provider_error_quark:
+ * tracker_password_provider_error_quark (skip):
  *
  * Returns: the #GQuark used to identify password provider errors in
  * GError structures.
@@ -101,7 +101,7 @@ tracker_password_provider_error_quark (void)
  * "GKeyFile". Either of these is what will be returned unless new
  * providers are written.
  *
- * Returns: a newly allocated string representing the name which must
+ * Returns: (out) (transfer full): a newly allocated string representing the name which must
  * be freed with g_free().
  *
  * Since: 0.8
@@ -126,7 +126,7 @@ tracker_password_provider_get_name (TrackerPasswordProvider *provider)
  * @description: the description for @service
  * @username: the username to store
  * @password: the password to store
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * This function calls the password provider's "store_password"
  * implementation with @service, @description, @username and @password.
@@ -164,8 +164,8 @@ tracker_password_provider_store_password (TrackerPasswordProvider  *provider,
  * tracker_password_provider_get_password:
  * @provider: a TrackerPasswordProvider
  * @service: the name of the remote service associated with @username
- * @username: the username associated with the password we are returning
- * @error: return location for errors
+ * @username: (out): the username associated with the password we are returning
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * This function calls the password provider's "get_password"
  * implementation with @service and @username.
@@ -200,7 +200,7 @@ tracker_password_provider_get_password (TrackerPasswordProvider  *provider,
  * tracker_password_provider_forget_password:
  * @provider: a TrackerPasswordProvider
  * @service: the name of the remote service associated with @username
- * @error: return location for errors
+ * @error: (out callee-allocates) (transfer full) (allow-none): return location for errors
  *
  * This function calls the password provider's "forget_password"
  * implementation with @service.
@@ -238,7 +238,7 @@ tracker_password_provider_forget_password (TrackerPasswordProvider  *provider,
  *
  * Password can not be %NULL or an empty string ("").
  *
- * Returns: a newly allocated string which <emphasis>MUST</emphasis>
+ * Returns: (transfer full): a newly allocated string which <emphasis>MUST</emphasis>
  * be freed with tracker_password_provider_unlock_password(). On
  * failure %NULL is returned.
  *
diff --git a/src/libtracker-miner/tracker-storage.c b/src/libtracker-miner/tracker-storage.c
index 0630f2a..f874aba 100644
--- a/src/libtracker-miner/tracker-storage.c
+++ b/src/libtracker-miner/tracker-storage.c
@@ -820,9 +820,10 @@ get_mount_point_by_uuid_foreach (gpointer key,
  * @type: A #TrackerStorageType
  * @exact_match: if all devices should exactly match the types
  *
- * 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().
+ * Returns: (transfer full) (element-type utf8): 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
  **/
@@ -855,9 +856,10 @@ tracker_storage_get_device_roots (TrackerStorage     *storage,
  * @type: A #TrackerStorageType
  * @exact_match: if all devices should exactly match the types
  *
- * 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().
+ * Returns: (transfer full) (element-type utf8): 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
  **/
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]