Merge branch 'gio-doc-relative' into 'main'

gio: document GFile API when relative path is absolute

See merge request GNOME/glib!2305
This commit is contained in:
Philip Withnall 2021-10-25 12:25:19 +00:00
commit 7fde5a1f9f

View File

@ -863,6 +863,7 @@ g_file_get_child (GFile *file,
{
g_return_val_if_fail (G_IS_FILE (file), NULL);
g_return_val_if_fail (name != NULL, NULL);
g_return_val_if_fail (!g_path_is_absolute (name), NULL);
return g_file_resolve_relative_path (file, name);
}
@ -985,7 +986,10 @@ g_file_get_relative_path (GFile *parent,
*
* This call does no blocking I/O.
*
* Returns: (transfer full): #GFile to the resolved path.
* If the @relative_path is an absolute path name, the resolution
* is done absolutely (without taking @file path as base).
*
* Returns: (transfer full) (nullable): #GFile to the resolved path.
* %NULL if @relative_path is %NULL or if @file is invalid.
* Free the returned object with g_object_unref().
*/
@ -4425,7 +4429,7 @@ g_file_set_display_name_finish (GFile *file,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
* Returns: a #GFileAttributeInfoList describing the settable attributes.
* Returns: (transfer full): a #GFileAttributeInfoList describing the settable attributes.
* When you are done with it, release it with
* g_file_attribute_info_list_unref()
*/
@ -4480,7 +4484,7 @@ g_file_query_settable_attributes (GFile *file,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
* Returns: a #GFileAttributeInfoList describing the writable namespaces.
* Returns: (transfer full): a #GFileAttributeInfoList describing the writable namespaces.
* When you are done with it, release it with
* g_file_attribute_info_list_unref()
*/