luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-10-28 18:16:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

gio: Fix docs links to description of I/O priority

Browse Source 
There are a lot of links to the description of I/O priority in the GIO
docs, and they’re all currently broken since the docs build was ported
to gi-docgen.

Use a simple find and replace (see below) to fix them. This doesn’t port
any of the surrounding docs to gi-docgen format, but should still
improve things overall.
```sh
git search-replace --fix '\[I/O priority\]\[io-priority\]///[I/O priority](iface.AsyncResult.html#io-priority)'
```

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3250
This commit is contained in:
Philip Withnall 2024-03-22 00:51:44 +00:00
parent afcb839121
commit 7feeafd9db
10 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gio/gasyncinitable.c
View File

@ -160,7 +160,7 @@ g_async_initable_default_init (GAsyncInitableInterface *iface)
/**
* g_async_initable_init_async:
* @initable: a #GAsyncInitable.
* @io_priority: the [I/O priority][io-priority] of the operation
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: the data to pass to callback function
@ -313,7 +313,7 @@ g_async_initable_real_init_finish (GAsyncInitable *initable,
/**
* g_async_initable_new_async:
* @object_type: a #GType supporting #GAsyncInitable.
* @io_priority: the [I/O priority][io-priority] of the operation
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the initialization is
* finished
@ -356,7 +356,7 @@ g_async_initable_new_async (GType object_type,
* @object_type: a #GType supporting #GAsyncInitable.
* @n_parameters: the number of parameters in @parameters
* @parameters: the parameters to use to construct the object
* @io_priority: the [I/O priority][io-priority] of the operation
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the initialization is
* finished
@ -402,7 +402,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* @first_property_name: the name of the first property, followed by
* the value, and other property value pairs, and ended by %NULL.
* @var_args: The var args list generated from @first_property_name.
* @io_priority: the [I/O priority][io-priority] of the operation
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the initialization is
* finished

2
gio/gbufferedinputstream.c
View File

@ -455,7 +455,7 @@ async_fill_callback_wrapper (GObject *source_object,
* g_buffered_input_stream_fill_async:
* @stream: a #GBufferedInputStream
* @count: the number of bytes that will be read from the stream
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
* @user_data: a #gpointer

6
gio/gdatainputstream.c
View File

@ -1117,7 +1117,7 @@ g_data_input_stream_read_finish (GDataInputStream *stream,
/**
* g_data_input_stream_read_line_async:
* @stream: a given #GDataInputStream.
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async) (closure user_data): callback to call when the request is satisfied.
* @user_data: the data to pass to callback function.
@ -1149,7 +1149,7 @@ g_data_input_stream_read_line_async (GDataInputStream *stream,
* g_data_input_stream_read_until_async:
* @stream: a given #GDataInputStream.
* @stop_chars: characters to terminate the read.
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async): callback to call when the request is satisfied.
* @user_data: (closure): the data to pass to callback function.
@ -1397,7 +1397,7 @@ g_data_input_stream_read_upto (GDataInputStream *stream,
* @stop_chars: characters to terminate the read
* @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is
* nul-terminated
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
* @callback: (scope async): callback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function

6
gio/gdtlsconnection.c
View File

@ -755,7 +755,7 @@ g_dtls_connection_handshake (GDtlsConnection *conn,
/**
* g_dtls_connection_handshake_async:
* @conn: a #GDtlsConnection
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): a #GCancellable, or %NULL
* @callback: callback to call when the handshake is complete
* @user_data: the data to pass to the callback function
@ -863,7 +863,7 @@ g_dtls_connection_shutdown (GDtlsConnection *conn,
* @conn: a #GDtlsConnection
* @shutdown_read: %TRUE to stop reception of incoming datagrams
* @shutdown_write: %TRUE to stop sending outgoing datagrams
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): a #GCancellable, or %NULL
* @callback: callback to call when the shutdown operation is complete
* @user_data: the data to pass to the callback function
@ -971,7 +971,7 @@ g_dtls_connection_close (GDtlsConnection *conn,
/**
* g_dtls_connection_close_async:
* @conn: a #GDtlsConnection
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): a #GCancellable, or %NULL
* @callback: callback to call when the close operation is complete
* @user_data: the data to pass to the callback function

46
gio/gfile.c
View File

@ -1115,7 +1115,7 @@ g_file_enumerate_children (GFile *file,
* @file: input #GFile
* @attributes: an attribute query string
* @flags: a set of #GFileQueryInfoFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -1352,7 +1352,7 @@ g_file_query_info (GFile *file,
* @file: input #GFile
* @attributes: an attribute query string
* @flags: a set of #GFileQueryInfoFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -1489,7 +1489,7 @@ g_file_query_filesystem_info (GFile *file,
* g_file_query_filesystem_info_async:
* @file: input #GFile
* @attributes: an attribute query string
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -1611,7 +1611,7 @@ g_file_find_enclosing_mount (GFile *file,
/**
* g_file_find_enclosing_mount_async:
* @file: a #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2098,7 +2098,7 @@ g_file_replace_readwrite (GFile *file,
/**
* g_file_read_async:
* @file: input #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2166,7 +2166,7 @@ g_file_read_finish (GFile *file,
* g_file_append_to_async:
* @file: input #GFile
* @flags: a set of #GFileCreateFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2237,7 +2237,7 @@ g_file_append_to_finish (GFile *file,
* g_file_create_async:
* @file: input #GFile
* @flags: a set of #GFileCreateFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2311,7 +2311,7 @@ g_file_create_finish (GFile *file,
* or %NULL to ignore
* @make_backup: %TRUE if a backup should be created
* @flags: a set of #GFileCreateFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2385,7 +2385,7 @@ g_file_replace_finish (GFile *file,
/**
* g_file_open_readwrite_async
* @file: input #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2457,7 +2457,7 @@ g_file_open_readwrite_finish (GFile *file,
* g_file_create_readwrite_async:
* @file: input #GFile
* @flags: a set of #GFileCreateFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -2535,7 +2535,7 @@ g_file_create_readwrite_finish (GFile *file,
* or %NULL to ignore
* @make_backup: %TRUE if a backup should be created
* @flags: a set of #GFileCreateFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -3768,7 +3768,7 @@ g_file_copy (GFile *source,
* @source: input #GFile
* @destination: destination #GFile
* @flags: set of #GFileCopyFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @progress_callback: (nullable) (scope notified) (closure progress_callback_data):
@ -3984,7 +3984,7 @@ g_file_move (GFile *source,
* @source: #GFile pointing to the source location
* @destination: #GFile pointing to the destination location
* @flags: set of #GFileCopyFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @progress_callback: (nullable) (scope call) (closure progress_callback_data):
@ -4115,7 +4115,7 @@ g_file_make_directory (GFile *file,
/**
* g_file_make_directory_async: (virtual make_directory_async)
* @file: input #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: a #GAsyncReadyCallback to call
@ -4389,7 +4389,7 @@ g_file_real_make_symbolic_link_async (GFile *file,
* @file: a #GFile with the name of the symlink to create
* @symlink_value: (type filename): a string with the path for the target
* of the new symlink
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: a #GAsyncReadyCallback to call
@ -4522,7 +4522,7 @@ g_file_delete (GFile *file,
/**
* g_file_delete_async: (virtual delete_file_async)
* @file: input #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: a #GAsyncReadyCallback to call
@ -4630,7 +4630,7 @@ g_file_trash (GFile *file,
/**
* g_file_trash_async: (virtual trash_async)
* @file: input #GFile
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: a #GAsyncReadyCallback to call
@ -4746,7 +4746,7 @@ g_file_set_display_name (GFile *file,
* g_file_set_display_name_async:
* @file: input #GFile
* @display_name: a string
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -5080,7 +5080,7 @@ g_file_real_set_attributes_from_info (GFile *file,
* @file: input #GFile
* @info: a #GFileInfo
* @flags: a #GFileQueryInfoFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object,
* %NULL to ignore
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
@ -7176,7 +7176,7 @@ new_tmp_async_thread (GTask *task,
* g_file_new_tmp_async:
* @tmpl: (type filename) (nullable): Template for the file
* name, as in g_file_open_tmp(), or %NULL for a default template
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: optional #GCancellable object, %NULL to ignore
* @callback: (nullable): a #GAsyncReadyCallback to call when the request is done
* @user_data: (nullable): data to pass to @callback
@ -7299,7 +7299,7 @@ new_tmp_dir_async_thread (GTask *task,
* g_file_new_tmp_dir_async:
* @tmpl: (type filename) (nullable): Template for the file
* name, as in g_dir_make_tmp(), or %NULL for a default template
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: optional #GCancellable object, %NULL to ignore
* @callback: (nullable): a #GAsyncReadyCallback to call when the request is done
* @user_data: (nullable): data to pass to @callback
@ -7829,7 +7829,7 @@ on_query_default_handler_for_uri_cb (GObject *object,
/**
* g_file_query_default_handler_async:
* @file: a #GFile to open
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: optional #GCancellable object, %NULL to ignore
* @callback: (nullable): a #GAsyncReadyCallback to call when the request is done
* @user_data: (nullable): data to pass to @callback
@ -8895,7 +8895,7 @@ g_file_measure_disk_usage (GFile *file,
* g_file_measure_disk_usage_async:
* @file: a #GFile
* @flags: #GFileMeasureFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable
* @progress_callback: (nullable): a #GFileMeasureProgressCallback
* @progress_data: user_data for @progress_callback

4
gio/gfileenumerator.c
View File

@ -314,7 +314,7 @@ next_async_callback_wrapper (GObject *source_object,
* g_file_enumerator_next_files_async:
* @enumerator: a #GFileEnumerator.
* @num_files: the number of file info objects to request
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
* to call when the request is satisfied
@ -486,7 +486,7 @@ close_async_callback_wrapper (GObject *source_object,
/**
* g_file_enumerator_close_async:
* @enumerator: a #GFileEnumerator.
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async) (closure user_data): a #GAsyncReadyCallback
* to call when the request is satisfied

2
gio/gfileinputstream.c
View File

@ -172,7 +172,7 @@ async_ready_callback_wrapper (GObject *source_object,
* g_file_input_stream_query_info_async:
* @stream: a #GFileInputStream.
* @attributes: a file attribute query string.
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback
* to call when the request is satisfied

10
gio/ginputstream.c
View File

@ -586,7 +586,7 @@ async_ready_close_callback_wrapper (GObject *source_object,
* @buffer: (array length=count) (element-type guint8) (out caller-allocates):
* a buffer to read data into (which should be at least count bytes long).
* @count: (in): the number of bytes that will be read from the stream
* @io_priority: the [I/O priority][io-priority]
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority)
* of the request.
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback
@ -779,7 +779,7 @@ read_all_async_thread (GTask *task,
* @buffer: (array length=count) (element-type guint8) (out caller-allocates):
* a buffer to read data into (which should be at least count bytes long)
* @count: (in): the number of bytes that will be read from the stream
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
* @callback: (scope async): a #GAsyncReadyCallback
* to call when the request is satisfied
@ -915,7 +915,7 @@ read_bytes_callback (GObject *stream,
* g_input_stream_read_bytes_async:
* @stream: A #GInputStream.
* @count: the number of bytes that will be read from the stream
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback
* to call when the request is satisfied
@ -994,7 +994,7 @@ g_input_stream_read_bytes_finish (GInputStream *stream,
* g_input_stream_skip_async:
* @stream: A #GInputStream.
* @count: the number of bytes that will be skipped from the stream
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback
* to call when the request is satisfied
@ -1106,7 +1106,7 @@ g_input_stream_skip_finish (GInputStream *stream,
/**
* g_input_stream_close_async:
* @stream: A #GInputStream.
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): optional cancellable object
* @callback: (scope async): a #GAsyncReadyCallback
* to call when the request is satisfied

2
gio/gioscheduler.c
View File

@ -85,7 +85,7 @@ io_job_thread (GTask *task,
* @job_func: a #GIOSchedulerJobFunc.
* @user_data: data to pass to @job_func
* @notify: (nullable): a #GDestroyNotify for @user_data, or %NULL
* @io_priority: the [I/O priority][io-priority]
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority)
* of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore.
*

2
gio/gtlsconnection.c
View File

@ -980,7 +980,7 @@ g_tls_connection_handshake (GTlsConnection *conn,
/**
* g_tls_connection_handshake_async:
* @conn: a #GTlsConnection
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the [I/O priority](iface.AsyncResult.html#io-priority) of the request
* @cancellable: (nullable): a #GCancellable, or %NULL
* @callback: callback to call when the handshake is complete
* @user_data: the data to pass to the callback function