GNOME.org
 

[rhythmbox] another round of GI annotation fixes

commit 6fa2c591e6994a1b868776f12c1cb471704670ab
Author: Jonathan Matthew <jonathan d14n org>
Date:   Tue Dec 29 15:58:32 2015 +1000

    another round of GI annotation fixes

 metadata/rb-ext-db.c               |   11 +++++++++++
 rhythmdb/rhythmdb-entry-type.c     |    4 ++--
 rhythmdb/rhythmdb-import-job.c     |    2 ++
 shell/rb-removable-media-manager.c |   24 +++++++++++++++++++++---
 shell/rb-shell.c                   |    1 +
 sources/rb-media-player-source.c   |   12 ++++++------
 sources/rb-media-player-source.h   |    4 ++--
 7 files changed, 45 insertions(+), 13 deletions(-)
---
diff --git a/metadata/rb-ext-db.c b/metadata/rb-ext-db.c
index b443ee1..4119c78 100644
--- a/metadata/rb-ext-db.c
+++ b/metadata/rb-ext-db.c
@@ -436,6 +436,10 @@ rb_ext_db_class_init (RBExtDBClass *klass)
 
        /**
         * RBExtDB::added:
+        * @store: the #RBExtDB
+        * @key: the #RBExtDBKey that was added
+        * @filename: the filename for the item that was added
+        * @data: the value that was stored
         *
         * Emitted when metadata is added to the store.  Metadata consumers
         * can use this to process metadata they did not specifically
@@ -452,6 +456,9 @@ rb_ext_db_class_init (RBExtDBClass *klass)
                              3, RB_TYPE_EXT_DB_KEY, G_TYPE_STRING, G_TYPE_VALUE);
        /**
         * RBExtDB::request:
+        * @store: the #RBExtDB
+        * @key: the #RBExtDBKey that was requested
+        * @last_time: the last time this item was requested
         *
         * Emitted when a metadata request cannot be satisfied from the local
         * store.  Metadata providers initiate searches in response to this
@@ -467,6 +474,8 @@ rb_ext_db_class_init (RBExtDBClass *klass)
                              2, RB_TYPE_EXT_DB_KEY, G_TYPE_ULONG);
        /**
         * RBExtDB::store:
+        * @store: the #RBExtDB instance
+        * @data: the data being stored
         *
         * Emitted when a metadata item needs to be written to a local file.
         * This only needs to be used for metadata that needs to be encoded
@@ -485,6 +494,8 @@ rb_ext_db_class_init (RBExtDBClass *klass)
                              1, G_TYPE_VALUE);
        /**
         * RBExtDB::load:
+        * @store: the #RBExtDB instance
+        * @data: the data being loaded
         *
         * Emitted when loading a metadata item from a local file or from a
         * URI.
diff --git a/rhythmdb/rhythmdb-entry-type.c b/rhythmdb/rhythmdb-entry-type.c
index 1fbfc3a..bd9fd02 100644
--- a/rhythmdb/rhythmdb-entry-type.c
+++ b/rhythmdb/rhythmdb-entry-type.c
@@ -222,7 +222,7 @@ rhythmdb_entry_sync_metadata (RhythmDBEntry *entry, GSList *changes, GError **er
  * rhythmdb_entry_type_fetch_metadata:
  * @etype: a #RhythmDBEntryType
  * @uri: uri of the item to fetch
- * @metadata: returns fetched metadata
+ * @metadata: (element-type RhythmDBEntryChange): returns fetched metadata
  *
  * Fetches metadata for a URI (not an entry yet, at this point) from a cache, if possible.
  *
@@ -284,7 +284,7 @@ static RhythmDBPropType default_unknown_properties[] = {
 /**
  * rhythmdb_entry_apply_cached_metadata:
  * @entry: a #RhythmDBEntry
- * @metadata: cached metadata to apply
+ * @metadata: (element-type RhythmDBEntryChange): cached metadata to apply
  *
  * Applies a set of metadata properties to @entry.  The metadata should be in the
  * form returned by @rhythmdb_entry_type_fetch_metadata.
diff --git a/rhythmdb/rhythmdb-import-job.c b/rhythmdb/rhythmdb-import-job.c
index 41746ab..c201716 100644
--- a/rhythmdb/rhythmdb-import-job.c
+++ b/rhythmdb/rhythmdb-import-job.c
@@ -822,6 +822,7 @@ rhythmdb_import_job_class_init (RhythmDBImportJobClass *klass)
        /**
         * RhythmDBImportJob::scan-complete:
         * @job: the #RhythmDBImportJob
+        * @total: the number of items scanned.
         *
         * Emitted when the directory scan is complete.  Once
         * the scan is complete, the total number of files to
@@ -839,6 +840,7 @@ rhythmdb_import_job_class_init (RhythmDBImportJobClass *klass)
        /**
         * RhythmDBImportJob::complete:
         * @job: the #RhythmDBImportJob
+        * @total: the number of items imported.
         *
         * Emitted when the whole import job is complete.
         */
diff --git a/shell/rb-removable-media-manager.c b/shell/rb-removable-media-manager.c
index 0e7c3cd..6d8f73a 100644
--- a/shell/rb-removable-media-manager.c
+++ b/shell/rb-removable-media-manager.c
@@ -861,6 +861,15 @@ rb_removable_media_manager_scan (RBRemovableMediaManager *manager)
 #endif
 }
 
+/**
+ * rb_removable_media_manager_get_gudev_device:
+ * @manager: the #RBRemovableMediaManager
+ * @volume: the #GVolume
+ *
+ * Finds the #GUdevDevice for the volume.
+ *
+ * Return value: (transfer full): the #GUDevDevice instance, if any
+ */
 GObject *
 rb_removable_media_manager_get_gudev_device (RBRemovableMediaManager *manager, GVolume *volume)
 {
@@ -880,8 +889,17 @@ rb_removable_media_manager_get_gudev_device (RBRemovableMediaManager *manager, G
 #endif
 }
 
+/**
+ * rb_removable_media_manager_device_is_android:
+ * @manager: the #RBRemovableMediaManager
+ * @device: the #GUdevDevice to query
+ *
+ * Determines whether the specified device looks like an Android device.
+ *
+ * Return value: %TRUE if the device appears to be Android-based
+ */
 gboolean
-rb_removable_media_manager_device_is_android (RBRemovableMediaManager *manager, GObject *dev)
+rb_removable_media_manager_device_is_android (RBRemovableMediaManager *manager, GObject *device)
 {
 #if defined(HAVE_GUDEV)
        gboolean match;
@@ -900,7 +918,7 @@ rb_removable_media_manager_device_is_android (RBRemovableMediaManager *manager,
 
        match = FALSE;
 
-       model = g_udev_device_get_property (G_UDEV_DEVICE (dev), "ID_MODEL");
+       model = g_udev_device_get_property (G_UDEV_DEVICE (device), "ID_MODEL");
        if (model != NULL) {
                for (i = 0; i < G_N_ELEMENTS (androids); i++) {
                        if (strstr (model, androids[i]))
@@ -908,7 +926,7 @@ rb_removable_media_manager_device_is_android (RBRemovableMediaManager *manager,
                }
        }
 
-       vendor = g_udev_device_get_property (G_UDEV_DEVICE (dev), "ID_VENDOR");
+       vendor = g_udev_device_get_property (G_UDEV_DEVICE (device), "ID_VENDOR");
        if (vendor != NULL) {
                for (i = 0; i < G_N_ELEMENTS (android_vendors); i++) {
                        if (strstr (vendor, android_vendors[i]))
diff --git a/shell/rb-shell.c b/shell/rb-shell.c
index 7338d20..b69d01a 100644
--- a/shell/rb-shell.c
+++ b/shell/rb-shell.c
@@ -1367,6 +1367,7 @@ rb_shell_class_init (RBShellClass *klass)
        /**
         * RBShell::notify-playing-entry:
         * @shell: the #RBShell
+        * @requested: %TRUE if user requested
         *
         * Emitted when a notification should be displayed showing the current
         * playing entry.
diff --git a/sources/rb-media-player-source.c b/sources/rb-media-player-source.c
index 6c67fb5..c34ce49 100644
--- a/sources/rb-media-player-source.c
+++ b/sources/rb-media-player-source.c
@@ -475,15 +475,15 @@ rb_media_player_source_get_free_space (RBMediaPlayerSource *source)
  * rb_media_player_source_get_entries:
  * @source: the #RBMediaPlayerSource
  * @category: the sync category name
- * @entries: (element-type utf8 RB.RhythmDBEntry): map to hold the entries
+ * @map: (element-type utf8 RB.RhythmDBEntry): map to hold the entries
  */
 void
 rb_media_player_source_get_entries (RBMediaPlayerSource *source,
                                    const char *category,
-                                   GHashTable *entries)
+                                   GHashTable *map)
 {
        RBMediaPlayerSourceClass *klass = RB_MEDIA_PLAYER_SOURCE_GET_CLASS (source);
-       klass->get_entries (source, category, entries);
+       klass->get_entries (source, category, map);
 }
 
 /**
@@ -491,19 +491,19 @@ rb_media_player_source_get_entries (RBMediaPlayerSource *source,
  * @source: the #RBMediaPlayerSource
  * @entries: (element-type RB.RhythmDBEntry) (transfer full): list of entries to delete
  * @callback: callback to call on completion
- * @user_data: (closure) (scope notified): data for callback
+ * @data: (closure) (scope notified): data for callback
  * @destroy_data: callback to free the callback data
  */
 void
 rb_media_player_source_delete_entries  (RBMediaPlayerSource *source,
                                         GList *entries,
                                         RBMediaPlayerSourceDeleteCallback callback,
-                                        gpointer user_data,
+                                        gpointer data,
                                         GDestroyNotify destroy_data)
 {
        RBMediaPlayerSourceClass *klass = RB_MEDIA_PLAYER_SOURCE_GET_CLASS (source);
 
-       klass->delete_entries (source, entries, callback, user_data, destroy_data);
+       klass->delete_entries (source, entries, callback, data, destroy_data);
 }
 
 static void
diff --git a/sources/rb-media-player-source.h b/sources/rb-media-player-source.h
index ad0cf43..c24c93f 100644
--- a/sources/rb-media-player-source.h
+++ b/sources/rb-media-player-source.h
@@ -91,12 +91,12 @@ guint64 rb_media_player_source_get_capacity (RBMediaPlayerSource *source);
 guint64 rb_media_player_source_get_free_space  (RBMediaPlayerSource *source);
 void   rb_media_player_source_get_entries      (RBMediaPlayerSource *source,
                                                 const char *category,  /* defined in rb-sync-settings.h */
-                                                GHashTable *entries);
+                                                GHashTable *map);
 
 void   rb_media_player_source_delete_entries   (RBMediaPlayerSource *source,
                                                 GList *entries,
                                                 RBMediaPlayerSourceDeleteCallback callback,
-                                                gpointer user_data,
+                                                gpointer data,
                                                 GDestroyNotify destroy_data);
 
 void   rb_media_player_source_show_properties (RBMediaPlayerSource *source);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]