fix a variety of introspection annotations

backends/gstreamer/rb-player-gst-helper.c

@@ -46,6 +46,15 @@ typedef struct {
 	gboolean linking;
 } RBGstPipelineOp;
 
+/**
+ * rb_player_gst_try_audio_sink:
+ * @plugin_name: audio sink plugin name
+ * @name: name to give to the element
+ *
+ * Creates and tests an instance of the specified audio sink.
+ *
+ * Return value: (transfer full): element instance, or NULL
+ */
 GstElement *
 rb_player_gst_try_audio_sink (const char *plugin_name, const char *name)
 {
@@ -115,6 +124,15 @@ find_property_element (const GValue * value, const char *property)
 	return res;
 }
 
+/**
+ * rb_player_gst_find_element_with_property:
+ * @element: element to search
+ * @property: name of property to search for
+ *
+ * Finds an element inside @element that has a property with the specified name.
+ *
+ * Return value: (transfer full): element instance, or NULL if not found
+ */
 GstElement *
 rb_player_gst_find_element_with_property (GstElement *element, const char *property)
 {
@@ -401,7 +419,7 @@ pipeline_op (GObject *player,
  * Creates an initial bin to use for dynamically plugging filter elements into the
  * pipeline.
  *
- * Return value: filter bin
+ * Return value: (transfer full): filter bin
  */
 GstElement *
 rb_gst_create_filter_bin ()

bindings/gi/Makefile.am

@@ -46,6 +46,8 @@ rb_introspection_sources = \
 		lib/rb-debug.c \
 		lib/rb-file-helpers.h \
 		lib/rb-file-helpers.c \
+		lib/rb-list-model.h \
+		lib/rb-list-model.c \
 		lib/rb-stock-icons.h \
 		lib/rb-stock-icons.c \
 		lib/rb-string-value-map.h \
@@ -66,6 +68,8 @@ rb_introspection_sources = \
 		podcast/rb-podcast-manager.c \
 		podcast/rb-podcast-parse.h \
 		podcast/rb-podcast-parse.c \
+		podcast/rb-podcast-search.h \
+		podcast/rb-podcast-search.c \
 		rhythmdb/rhythmdb.h \
 		rhythmdb/rhythmdb.c \
 		rhythmdb/rhythmdb-entry.h \

lib/rb-debug.c

@@ -307,7 +307,7 @@ struct RBProfiler
 };
 
 /**
- * rb_profiler_new: (skip):
+ * rb_profiler_new: (skip)
  * @name: profiler name
  *
  * Creates a new profiler instance.  This can be used to
@@ -333,7 +333,7 @@ rb_profiler_new (const char *name)
 }
 
 /**
- * rb_profiler_dump: (skip):
+ * rb_profiler_dump: (skip)
  * @profiler: profiler instance
  *
  * Produces debug output for the profiler instance,
@@ -357,7 +357,7 @@ rb_profiler_dump (RBProfiler *profiler)
 }
 
 /**
- * rb_profiler_reset: (skip):
+ * rb_profiler_reset: (skip)
  * @profiler: profiler instance
  *
  * Resets the elapsed time for the profiler
@@ -374,7 +374,7 @@ rb_profiler_reset (RBProfiler *profiler)
 }
 
 /**
- * rb_profiler_free: (skip):
+ * rb_profiler_free: (skip)
  * @profiler: profiler instance to destroy
  *
  * Frees the memory associated with a profiler instance.

lib/rb-list-model.c

@@ -148,7 +148,7 @@ rb_list_model_n_items (RBListModel *model)
  *
  * Returns an item from the list.
  *
- * Return value: item at the specified index
+ * Return value: (transfer none): item at the specified index
  */
 gpointer
 rb_list_model_get (RBListModel *model, int index)

lib/rb-util.c

@@ -52,7 +52,7 @@
 static GPrivate private_is_primary_thread;
 
 /**
- * rb_true_function: (skip):
+ * rb_true_function: (skip)
  * @dummy: unused
  *
  * Just returns %TRUE, useful as a callback function.
@@ -66,7 +66,7 @@ rb_true_function (gpointer dummy)
 }
 
 /**
- * rb_false_function: (skip):
+ * rb_false_function: (skip)
  * @dummy: unused
  *
  * Just returns %FALSE, useful as a callback function.
@@ -80,7 +80,7 @@ rb_false_function (gpointer dummy)
 }
 
 /**
- * rb_null_function: (skip):
+ * rb_null_function: (skip)
  * @dummy: unused
  *
  * Just returns NULL.  Useful as a callback function.
@@ -94,7 +94,7 @@ rb_null_function (gpointer dummy)
 }
 
 /**
- * rb_copy_function: (skip):
+ * rb_copy_function: (skip)
  * @data: generic argument
  *
  * Just returns its first argument.  Useful as a callback function.
@@ -109,7 +109,7 @@ rb_copy_function (gpointer data)
 
 
 /**
- * rb_gvalue_compare: (skip):
+ * rb_gvalue_compare: (skip)
  * @a: left hand side
  * @b: right hand size
  *
@@ -418,7 +418,7 @@ _threads_leave (void)
 
 
 /**
- * rb_assert_locked: (skip):
+ * rb_assert_locked: (skip)
  * @mutex: a #GMutex
  *
  * Asserts that @mutex is currently locked.  Does not work with all
@@ -432,7 +432,7 @@ rb_assert_locked (GMutex *mutex)
 }
 
 /**
- * rb_threads_init: (skip):
+ * rb_threads_init: (skip)
  *
  * Initializes various thread helpers.  Must be called on startup.
  */
@@ -752,7 +752,7 @@ rb_make_elapsed_time_string (guint elapsed, guint duration, gboolean show_remain
 }
 
 /**
- * rb_string_list_equal: (skip):
+ * rb_string_list_equal: (skip)
  * @a: (element-type utf8): list of strings to compare
  * @b: (element-type utf8): other list of strings to compare
  *
@@ -807,7 +807,7 @@ list_copy_cb (const char *s, GList **list)
 }
 
 /**
- * rb_string_list_copy: (skip):
+ * rb_string_list_copy: (skip)
  * @list: (element-type utf8): list of strings to copy
  *
  * Creates a deep copy of @list.
@@ -829,7 +829,7 @@ rb_string_list_copy (GList *list)
 }
 
 /**
- * rb_string_list_contains: (skip):
+ * rb_string_list_contains: (skip)
  * @list: (element-type utf8) list to check
  * @s: string to check for
  *
@@ -851,7 +851,7 @@ rb_string_list_contains (GList *list, const char *s)
 }
 
 /**
- * rb_list_destroy_free: (skip):
+ * rb_list_destroy_free: (skip)
  * @list: list to destroy
  * @destroyer: function to call to free elements of @list
  *
@@ -865,7 +865,7 @@ rb_list_destroy_free (GList *list, GDestroyNotify destroyer)
 }
 
 /**
- * rb_list_deep_free: (skip):
+ * rb_list_deep_free: (skip)
  * @list: (element-type any) (transfer full): list to free
  *
  * Frees each element of @list and @list itself.
@@ -877,7 +877,7 @@ rb_list_deep_free (GList *list)
 }
 
 /**
- * rb_slist_deep_free: (skip):
+ * rb_slist_deep_free: (skip)
  * @list: (element-type any) (transfer full): list to free
  *
  * Frees each element of @list and @list itself.
@@ -902,7 +902,7 @@ collate_values_cb (gpointer key, gpointer value, GList **list)
 }
 
 /**
- * rb_collate_hash_table_keys: (skip):
+ * rb_collate_hash_table_keys: (skip)
  * @table: #GHashTable to collate
  *
  * Returns a #GList containing all keys from @table.  The keys are
@@ -922,7 +922,7 @@ rb_collate_hash_table_keys (GHashTable *table)
 }
 
 /**
- * rb_collate_hash_table_values: (skip):
+ * rb_collate_hash_table_values: (skip)
  * @table: #GHashTable to collate
  *
  * Returns a #GList containing all values from @table.  The values are
@@ -993,7 +993,7 @@ rb_uri_list_parse (const char *uri_list)
 }
 
 /**
- * rb_signal_accumulator_object_handled: (skip):
+ * rb_signal_accumulator_object_handled: (skip)
  * @hint: a #GSignalInvocationHint
  * @return_accu: holds the accumulated return value
  * @handler_return: holds the return value to be accumulated
@@ -1025,7 +1025,7 @@ rb_signal_accumulator_object_handled (GSignalInvocationHint *hint,
 }
 
 /**
- * rb_signal_accumulator_value_handled: (skip):
+ * rb_signal_accumulator_value_handled: (skip)
  * @hint: a #GSignalInvocationHint
  * @return_accu: holds the accumulated return value
  * @handler_return: holds the return value to be accumulated
@@ -1057,7 +1057,7 @@ rb_signal_accumulator_value_handled (GSignalInvocationHint *hint,
 }
 
 /**
- * rb_signal_accumulator_value_array: (skip):
+ * rb_signal_accumulator_value_array: (skip)
  * @hint: a #GSignalInvocationHint
  * @return_accu: holds the accumulated return value
  * @handler_return: holds the return value to be accumulated
@@ -1104,7 +1104,7 @@ rb_signal_accumulator_value_array (GSignalInvocationHint *hint,
 }
 
 /**
- * rb_signal_accumulator_boolean_or: (skip):
+ * rb_signal_accumulator_boolean_or: (skip)
  * @hint: a #GSignalInvocationHint
  * @return_accu: holds the accumulated return value
  * @handler_return: holds the return value to be accumulated
@@ -1134,7 +1134,7 @@ rb_signal_accumulator_boolean_or (GSignalInvocationHint *hint,
 }
 
 /**
- * rb_value_array_append_data: (skip):
+ * rb_value_array_append_data: (skip)
  * @array: #GArray to append to
  * @type: #GType of the value being appended
  * @Varargs: value to append
@@ -1162,7 +1162,7 @@ rb_value_array_append_data (GArray *array, GType type, ...)
 }
 
 /**
- * rb_value_free: (skip):
+ * rb_value_free: (skip)
  * @val: (transfer full): a #GValue
  *
  * Unsets and frees @val.  @val must have been allocated using
@@ -1176,7 +1176,7 @@ rb_value_free (GValue *val)
 }
 
 /**
- * rb_str_in_strv: (skip):
+ * rb_str_in_strv: (skip)
  * @needle: string to search for
  * @haystack: array of strings to search
  *

metadata/rb-ext-db-key.c

@@ -541,9 +541,9 @@ create_store_key (RBExtDBKey *key, int option, TDB_DATA *data)
 }
 
 /**
- * rb_ext_db_key_lookups: (skip):
+ * rb_ext_db_key_lookups:
  * @key: a #RBExtDBKey
- * @callback: a callback to process lookup keys
+ * @callback: (scope call): a callback to process lookup keys
  * @user_data: data to pass to @callback
  *
  * Generates the set of possible lookup keys for @key and
@@ -577,7 +577,7 @@ rb_ext_db_key_lookups (RBExtDBKey *key,
 }
 
 /**
- * rb_ext_db_key_to_store_key: (skip):
+ * rb_ext_db_key_to_store_key: (skip)
  * @key: a @RBExtDBKey
  *
  * Generates the storage key for @key.  This is the value that should

metadata/rb-ext-db.c

@@ -467,6 +467,8 @@ rb_ext_db_class_init (RBExtDBClass *klass)
 	 * 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
 	 * or compressed, such as images.
+	 *
+	 * Return value: (transfer full): the value to write to a file
 	 */
 	signals[STORE] =
 		g_signal_new ("store",
@@ -482,6 +484,8 @@ rb_ext_db_class_init (RBExtDBClass *klass)
 	 *
 	 * Emitted when loading a metadata item from a local file or from a
 	 * URI.
+	 *
+	 * Return value: (transfer full): converted value
 	 */
 	signals[LOAD] =
 		g_signal_new ("load",

podcast/rb-podcast-manager.c

@@ -2279,6 +2279,14 @@ rb_podcast_manager_add_search (RBPodcastManager *pd, GType search_type)
 	pd->priv->searches = g_list_append (pd->priv->searches, GUINT_TO_POINTER (search_type));
 }
 
+/**
+ * rb_podcast_manager_get_searches:
+ * @pd: the #RBPodcastManager
+ *
+ * Returns the list of podcast searches
+ *
+ * Return value: (element-type RB.PodcastSearch) (transfer container): list of search instances
+ */
 GList *
 rb_podcast_manager_get_searches (RBPodcastManager *pd)
 {

rhythmdb/rhythmdb-entry-type.c

@@ -187,7 +187,7 @@ rhythmdb_entry_can_sync_metadata (RhythmDBEntry *entry)
 /**
  * rhythmdb_entry_sync_metadata:
  * @entry: a #RhythmDBEntry
- * @changes: a list of #RhythmDBEntryChange structures
+ * @changes: (element-type RB.RhythmDBEntryChange): a list of #RhythmDBEntryChange structures
  * @error: returns error information
  *
  * Calls the entry type's method to sync metadata changes for @entry.

rhythmdb/rhythmdb-query-model.c

@@ -800,7 +800,7 @@ rhythmdb_query_model_finalize (GObject *object)
 }
 
 /**
- * rhythmdb_query_model_new:
+ * rhythmdb_query_model_new: (skip)
  * @db: the #RhythmDB
  * @query: the query for the new model
  * @sort_func: the sort function for the new model

rhythmdb/rhythmdb-query-results.c

@@ -66,7 +66,7 @@ rhythmdb_query_results_get_type (void)
 }
 
 /**
- * rhythmdb_query_results_set_query:
+ * rhythmdb_query_results_set_query: (skip)
  * @results: the #RhythmDBQueryResults implementation
  * @query: the new query
  *
@@ -87,7 +87,7 @@ rhythmdb_query_results_set_query (RhythmDBQueryResults *results,
 /**
  * rhythmdb_query_results_add_results:
  * @results: the #RhythmDBQueryResults implementation
- * @entries: #GPtrArray containing #RhythmDBEntry results
+ * @entries: (element-type RB.RhythmDBEntry): #GPtrArray containing #RhythmDBEntry results
  *
  * Provides a new set of query results.  References must be taken on the
  * entries.