Skip to content

Commit

Permalink
gjs-util: Backport private closure annotations patch (#126)
Browse files Browse the repository at this point in the history
From: Philip Chimento <philip.chimento@gmail.com>
Date: Sat, 27 Jul 2024 20:17:39 -0700
Subject: GjsPrivate: Fix closure annotations

Apparently the closure annotation can be omitted if the parameter is named
user_data. If it is needed because the parameter is not named
user_data then the annotation should be on the callback argument and
refer to the user data argument.

Ref:
https://gitlab.gnome.org/GNOME/gjs/-/commit/1df5d72d8df383199dcd88cd1d16209617bf32ca

Co-authored-by: Fabio Fantoni <fantonifabio@tiscali.it>
  • Loading branch information
rcalixte and Fantu authored Nov 18, 2024
1 parent f81c19e commit a4d0b02
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions libgjs-private/gjs-util.c
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ void gjs_gtk_container_child_set_property(GObject* container, GObject* child,
* @store: a #GListStore
* @item: the new item
* @compare_func: (scope call): pairwise comparison function for sorting
* @user_data: (closure): user data for @compare_func
* @user_data: user data for @compare_func
*
* Inserts @item into @store at a position to be determined by the
* @compare_func.
Expand All @@ -258,7 +258,7 @@ unsigned int gjs_list_store_insert_sorted(GListStore *store, GObject *item,
* gjs_list_store_sort:
* @store: a #GListStore
* @compare_func: (scope call): pairwise comparison function for sorting
* @user_data: (closure): user data for @compare_func
* @user_data: user data for @compare_func
*
* Sort the items in @store according to @compare_func.
*/
Expand All @@ -270,7 +270,7 @@ void gjs_list_store_sort(GListStore *store, GjsCompareDataFunc compare_func,
/**
* gjs_gtk_custom_sorter_new:
* @sort_func: (nullable) (scope call): function to sort items
* @user_data: (closure): user data for @compare_func
* @user_data: user data for @sort_func
* @destroy: destroy notify for @user_data
*
* Creates a new `GtkSorter` that works by calling @sort_func to compare items.
Expand Down Expand Up @@ -305,7 +305,7 @@ GObject* gjs_gtk_custom_sorter_new(GjsCompareDataFunc sort_func,
* gjs_gtk_custom_sorter_set_sort_func:
* @sorter: a `GtkCustomSorter`
* @sort_func: (nullable) (scope call): function to sort items
* @user_data: (closure): user data to pass to @sort_func
* @user_data: user data to pass to @sort_func
* @destroy: destroy notify for @user_data
*
* Sets (or unsets) the function used for sorting items.
Expand Down Expand Up @@ -423,7 +423,7 @@ void gjs_log_set_writer_default() {
/**
* gjs_log_set_writer_func:
* @func: (scope notified): callback with log data
* @user_data: (closure): user data for @func
* @user_data: user data for @func
* @user_data_free: (destroy user_data_free): destroy for @user_data
*
* Sets a given function as the writer function for structured logging,
Expand Down
16 changes: 8 additions & 8 deletions libgjs-private/gjs-util.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,11 @@ typedef gboolean (*GjsBindingTransformFunc)(GBinding* binding,
* @target:
* @target_property:
* @flags:
* @to_callback: (scope notified) (nullable):
* @to_data: (closure to_callback):
* @to_callback: (scope notified) (nullable) (closure to_data):
* @to_data:
* @to_notify: (destroy to_data):
* @from_callback: (scope notified) (nullable):
* @from_data: (closure from_callback):
* @from_callback: (scope notified) (nullable) (closure from_data):
* @from_data:
* @from_notify: (destroy from_data):
*
* Returns: (transfer none):
Expand All @@ -149,11 +149,11 @@ GBinding* gjs_g_object_bind_property_full(
* @target:
* @target_property:
* @flags:
* @to_callback: (scope notified) (nullable):
* @to_data: (closure to_callback):
* @to_callback: (scope notified) (nullable) (closure to_data):
* @to_data:
* @to_notify: (destroy to_data):
* @from_callback: (scope notified) (nullable):
* @from_data: (closure from_callback):
* @from_callback: (scope notified) (nullable) (closure from_data):
* @from_data:
* @from_notify: (destroy from_data):
*/
GJS_EXPORT
Expand Down

0 comments on commit a4d0b02

Please sign in to comment.