AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2025-01-13 05:50:10 +00:00
Code Issues Projects Releases Wiki Activity

docs: Drop _finish blobs

Browse Source 
As they are generated by gi-docgen thanks to the newly added async annotations.
It allows bindings that don't expose the _finish
functions to propose less-confusing docs
This commit is contained in:
Bilal Elmoussaoui 2024-05-23 20:39:50 +02:00
parent 7372a845fb
commit 9b42377347
14 changed files with 12 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gdk/gdkclipboard.c
View File

@ -522,8 +522,6 @@ gdk_clipboard_get_content (GdkClipboard *clipboard)
*
* If the clipboard is not local, this function does nothing but report success.
*
* The @callback must call [method@Gdk.Clipboard.store_finish].
*
* The purpose of this call is to preserve clipboard contents beyond the
* lifetime of an application, so this function is typically called on
* exit. Depending on the platform, the functionality may not be available
@ -638,9 +636,6 @@ gdk_clipboard_read_internal (GdkClipboard *clipboard,
* Asynchronously requests an input stream to read the @clipboard's
* contents from.
*
* When the operation is finished @callback will be called. You must then
* call [method@Gdk.Clipboard.read_finish] to get the result of the operation.
*
* The clipboard will choose the most suitable mime type from the given list
* to fulfill the request, preferring the ones listed first.
*/
@ -834,9 +829,6 @@ gdk_clipboard_read_value_internal (GdkClipboard *clipboard,
* Asynchronously request the @clipboard contents converted to the given
* @type.
*
* When the operation is finished @callback will be called. You must then call
* [method@Gdk.Clipboard.read_value_finish] to get the resulting `GValue`.
*
* For local clipboard contents that are available in the given `GType`,
* the value will be copied directly. Otherwise, GDK will try to use
* [func@content_deserialize_async] to convert the clipboard's data.
@ -895,9 +887,6 @@ gdk_clipboard_read_value_finish (GdkClipboard *clipboard,
*
* Asynchronously request the @clipboard contents converted to a `GdkPixbuf`.
*
* When the operation is finished @callback will be called. You must then
* call [method@Gdk.Clipboard.read_texture_finish] to get the result.
*
* This is a simple wrapper around [method@Gdk.Clipboard.read_value_async].
* Use that function or [method@Gdk.Clipboard.read_async] directly if you
* need more control over the operation.
@ -960,9 +949,6 @@ gdk_clipboard_read_texture_finish (GdkClipboard *clipboard,
*
* Asynchronously request the @clipboard contents converted to a string.
*
* When the operation is finished @callback will be called. You must then
* call [method@Gdk.Clipboard.read_text_finish] to get the result.
*
* This is a simple wrapper around [method@Gdk.Clipboard.read_value_async].
* Use that function or [method@Gdk.Clipboard.read_async] directly if you
* need more control over the operation.

3
gdk/gdkcontentdeserializer.c
View File

@ -540,9 +540,6 @@ deserialize_not_found (GdkContentDeserializer *deserializer)
*
* The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers
* indicate a higher priority.
*
* When the operation is finished, @callback will be called. You must then
* call [func@Gdk.content_deserialize_finish] to get the result of the operation.
*/
void
gdk_content_deserialize_async (GInputStream *stream,

4
gdk/gdkcontentprovider.c
View File

@ -279,10 +279,6 @@ gdk_content_provider_content_changed (GdkContentProvider *provider)
* Asynchronously writes the contents of @provider to @stream in the given
* @mime_type.
*
* When the operation is finished @callback will be called. You must then call
* [method@Gdk.ContentProvider.write_mime_type_finish] to get the result
* of the operation.
*
* The given mime type does not need to be listed in the formats returned by
* [method@Gdk.ContentProvider.ref_formats]. However, if the given `GType` is
* not supported, `G_IO_ERROR_NOT_SUPPORTED` will be reported.

3
gdk/gdkcontentserializer.c
View File

@ -546,9 +546,6 @@ serialize_not_found (GdkContentSerializer *serializer)
*
* The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers
* indicate a higher priority.
*
* When the operation is finished, @callback will be called. You must then
* call [func@Gdk.content_serialize_finish] to get the result of the operation.
*/
void
gdk_content_serialize_async (GOutputStream *stream,

8
gdk/gdkdrop.c
View File

@ -134,7 +134,7 @@ gdk_drop_read_local_async (GdkDrop *self,
g_object_get (priv->drag, "content", &content, NULL);
content_formats = gdk_content_provider_ref_formats (content);
g_object_unref (content);
g_object_unref (content);
content_formats = gdk_content_formats_union_serialize_mime_types (content_formats);
mime_type = gdk_content_formats_match_mime_type (content_formats, formats);
@ -784,7 +784,7 @@ gdk_drop_read_value_internal (GdkDrop *self,
GdkContentFormats *formats;
GValue *value;
GTask *task;
g_return_if_fail (priv->state != GDK_DROP_STATE_FINISHED);
task = g_task_new (self, cancellable, callback, user_data);
@ -849,10 +849,6 @@ gdk_drop_read_value_internal (GdkDrop *self,
* Asynchronously request the drag operation's contents converted
* to the given @type.
*
* When the operation is finished @callback will be called. You must
* then call [method@Gdk.Drop.read_value_finish] to get the resulting
* `GValue`.
*
* For local drag-and-drop operations that are available in the given
* `GType`, the value will be copied directly. Otherwise, GDK will
* try to use [func@Gdk.content_deserialize_async] to convert the data.

3
gdk/gdktoplevel.c
View File

@ -767,9 +767,6 @@ gdk_toplevel_titlebar_gesture (GdkToplevel *toplevel,
* This function asynchronously obtains a handle for a toplevel surface
* that can be passed to other processes.
*
* When a handle has been obtained, @callback will be called, and can
* receive the handle via [method@Gdk.Toplevel.export_handle_finish].
*
* It is an error to call this function on a surface that is already
* exported.
*

5
gtk/deprecated/gtkshow.c
View File

@ -99,7 +99,6 @@ window_handle_exported (GtkWindow *window,
* a given uri.
*
* The @callback will be called when the launch is completed.
* It should call gtk_show_uri_full_finish() to obtain the result.
*
* This is the recommended call to be used as it passes information
* necessary for sandbox helpers to parent their dialogs properly.
@ -153,8 +152,8 @@ gtk_show_uri_full (GtkWindow *parent,
* Returns: %TRUE if the URI was shown successfully.
* Otherwise, %FALSE is returned and @error is set
*
* Deprecated: 4.10: Use [method@Gtk.FileLauncher.launch_finish] or
* [method@Gtk.UriLauncher.launch_finish] instead
* Deprecated: 4.10: Use [method@Gtk.FileLauncher.launch] or
* [method@Gtk.UriLauncher.launch] instead
*/
gboolean
gtk_show_uri_full_finish (GtkWindow *parent,

7
gtk/gtkalertdialog.c
View File

@ -33,8 +33,7 @@
* are needed to present a message to the user.
*
* The message is shown with the [method@Gtk.AlertDialog.choose]
* function. This API follows the GIO async pattern, and the result can
* be obtained by calling [method@Gtk.AlertDialog.choose_finish].
* function.
*
* If you don't need to wait for a button to be clicked, you can use
* [method@Gtk.AlertDialog.show].
@ -687,10 +686,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS
*
* This function shows the alert to the user.
*
* The @callback will be called when the alert is dismissed.
* It should call [method@Gtk.AlertDialog.choose_finish]
* to obtain the result.
*
* It is ok to pass `NULL` for the callback if the alert
* does not have more than one button. A simpler API for
* this case is [method@Gtk.AlertDialog.show].

8
gtk/gtkcolordialog.c
View File

@ -36,9 +36,7 @@
* should be modal.
*
* The dialog is shown with the [method@Gtk.ColorDialog.choose_rgba]
* function. This API follows the GIO async pattern, and the
* result can be obtained by calling
* [method@Gtk.ColorDialog.choose_rgba_finish].
* function.
*
* See [class@Gtk.ColorDialogButton] for a convenient control
* that uses `GtkColorDialog` and presents the results.
@ -436,10 +434,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* This function initiates a color choice operation by
* presenting a color chooser dialog to the user.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.ColorDialog.choose_rgba_finish]
* to obtain the result.
*
* Since: 4.10
*/
void

17
gtk/gtkfiledialog.c
View File

@ -37,10 +37,7 @@
* should be modal.
*
* The dialog is shown with [method@Gtk.FileDialog.open],
* [method@Gtk.FileDialog.save], etc. These APIs follow the
* GIO async pattern, and the result can be obtained by calling
* the corresponding finish function, for example
* [method@Gtk.FileDialog.open_finish].
* [method@Gtk.FileDialog.save], etc.
*
* Since: 4.10
*/
@ -693,7 +690,7 @@ gtk_file_dialog_set_initial_file (GtkFileDialog *self,
{
GFile *folder;
GFileInfo *info;
if (self->initial_file && g_file_equal (self->initial_file, file))
return;
@ -927,8 +924,6 @@ finish_multiple_files_op (GtkFileDialog *self,
* presenting a file chooser dialog to the user.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FileDialog.open_finish]
* to obtain the result.
*
* Since: 4.10
*/
@ -1001,8 +996,6 @@ gtk_file_dialog_open_finish (GtkFileDialog *self,
* will be in the directory [property@Gtk.FileDialog:initial-folder].
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FileDialog.select_folder_finish]
* to obtain the result.
*
* Since: 4.10
*/
@ -1071,8 +1064,6 @@ gtk_file_dialog_select_folder_finish (GtkFileDialog *self,
* presenting a file chooser dialog to the user.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FileDialog.save_finish]
* to obtain the result.
*
* Since: 4.10
*/
@ -1144,8 +1135,6 @@ gtk_file_dialog_save_finish (GtkFileDialog *self,
* [property@Gtk.FileDialog:initial-folder].
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FileDialog.open_multiple_finish]
* to obtain the result.
*
* Since: 4.10
*/
@ -1218,8 +1207,6 @@ gtk_file_dialog_open_multiple_finish (GtkFileDialog *self,
* [property@Gtk.FileDialog:initial-folder].
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FileDialog.select_multiple_folders_finish]
* to obtain the result.
*
* Since: 4.10
*/

10
gtk/gtkfilelauncher.c
View File

@ -37,8 +37,6 @@
* right away.
*
* The operation is started with the [method@Gtk.FileLauncher.launch] function.
* This API follows the GIO async pattern, and the result can be obtained by
* calling [method@Gtk.FileLauncher.launch_finish].
*
* To launch uris that don't represent files, use [class@Gtk.UriLauncher].
*
@ -464,10 +462,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS
*
* This may present an app chooser dialog to the user.
*
* The @callback will be called when the operation is completed.
* It should call [method@Gtk.FileLauncher.launch_finish] to obtain
* the result.
*
* Since: 4.10
*/
void
@ -558,10 +552,6 @@ gtk_file_launcher_launch_finish (GtkFileLauncher *self,
* This is only supported native files. It will fail if @file
* is e.g. a http:// uri.
*
* The @callback will be called when the operation is completed.
* It should call [method@Gtk.FileLauncher.open_containing_folder_finish]
* to obtain the result.
*
* Since: 4.10
*/
void

20
gtk/gtkfontdialog.c
View File

@ -37,9 +37,7 @@
* should be modal.
*
* The dialog is shown with the [method@Gtk.FontDialog.choose_font]
* function or its variants. This API follows the GIO async pattern,
* and the result can be obtained by calling the corresponding
* finish function, such as [method@Gtk.FontDialog.choose_font_finish].
* function or its variants.
*
* See [class@Gtk.FontDialogButton] for a convenient control
* that uses `GtkFontDialog` and presents the results.
@ -627,10 +625,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* This function initiates a font selection operation by
* presenting a dialog to the user for selecting a font family.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FontDialog.choose_family_finish]
* to obtain the result.
*
* Since: 4.10
*/
void
@ -716,10 +710,6 @@ gtk_font_dialog_choose_family_finish (GtkFontDialog *self,
* presenting a dialog to the user for selecting a font face
* (i.e. a font family and style, but not a specific font size).
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FontDialog.choose_face_finish]
* to obtain the result.
*
* Since: 4.10
*/
void
@ -798,10 +788,6 @@ gtk_font_dialog_choose_face_finish (GtkFontDialog *self,
* This function initiates a font selection operation by
* presenting a dialog to the user for selecting a font.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FontDialog.choose_font_finish]
* to obtain the result.
*
* If you want to let the user select font features as well,
* use [method@Gtk.FontDialog.choose_font_and_features] instead.
*
@ -883,10 +869,6 @@ gtk_font_dialog_choose_font_finish (GtkFontDialog *self,
* Font features affect how the font is rendered, for example
* enabling glyph variants or ligatures.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.FontDialog.choose_font_and_features_finish]
* to obtain the result.
*
* Since: 4.10
*/
void

12
gtk/gtkprintdialog.c
View File

@ -1430,10 +1430,8 @@ print_response_cb (GtkPrintUnixDialog *window,
* and set up print settings and page setup.
*
* The @callback will be called when the dialog is dismissed.
* It should call [method@Gtk.PrintDialog.setup_finish]
* to obtain the results in the form of a [struct@Gtk.PrintSetup],
* that can then be passed to [method@Gtk.PrintDialog.print]
* or [method@Gtk.PrintDialog.print_file].
* The obtained [struct@Gtk.PrintSetup] can then be passed
* to [method@Gtk.PrintDialog.print] or [method@Gtk.PrintDialog.print_file].
*
* One possible use for this method is to have the user select a printer,
* then show a page setup UI in the application (e.g. to arrange images
@ -1533,8 +1531,7 @@ gtk_print_dialog_setup_finish (GtkPrintDialog *self,
* If you pass `NULL` as @setup, then this method will present a print dialog.
* Otherwise, it will attempt to print directly, without user interaction.
*
* The @callback will be called when the printing is done. It should call
* [method@Gtk.PrintDialog.print_finish] to obtain the results.
* The @callback will be called when the printing is done.
*
* Since: 4.14
*/
@ -1659,9 +1656,6 @@ gtk_print_dialog_print_finish (GtkPrintDialog *self,
* If you pass `NULL` as @setup, then this method will present a print dialog.
* Otherwise, it will attempt to print directly, without user interaction.
*
* The @callback will be called when the printing is done. It should call
* [method@Gtk.PrintDialog.print_file_finish] to obtain the results.
*
* Since: 4.14
*/
void

6
gtk/gtkurilauncher.c
View File

@ -37,8 +37,6 @@
* right away.
*
* The operation is started with the [method@Gtk.UriLauncher.launch] function.
* This API follows the GIO async pattern, and the result can be obtained by
* calling [method@Gtk.UriLauncher.launch_finish].
*
* To launch a file, use [class@Gtk.FileLauncher].
*
@ -270,10 +268,6 @@ G_GNUC_END_IGNORE_DEPRECATIONS
*
* This may present an app chooser dialog to the user.
*
* The @callback will be called when the operation is completed.
* It should call [method@Gtk.UriLauncher.launch_finish] to obtain
* the result.
*
* Since: 4.10
*/
void