luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-21 22:59:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

gfileutils: Add missing (type filename) annotations

Browse Source 
These differentiate between strings in the GLib filename encoding, and
strings in UTF-8.

https://bugzilla.gnome.org/show_bug.cgi?id=700756
This commit is contained in:
Nikita Churaev 2014-11-27 09:11:25 +00:00 committed by Philip Withnall
parent ac1166626c
commit ec40e9d921
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
glib/gfileutils.c
View File

@ -1366,8 +1366,8 @@ wrap_g_open (const gchar *filename,
* in the GLib file name encoding. Most importantly, on Windows it * in the GLib file name encoding. Most importantly, on Windows it
* should be in UTF-8. * should be in UTF-8.
* *
* Returns: (type filename): A pointer to @tmpl, which has been modified * Returns: (nullable) (type filename): A pointer to @tmpl, which has been
* to hold the directory name. In case of errors, %NULL is * modified to hold the directory name. In case of errors, %NULL is
* returned, and %errno will be set. * returned, and %errno will be set.
* *
* Since: 2.30 * Since: 2.30
@ -1398,8 +1398,8 @@ g_mkdtemp_full (gchar *tmpl,
* The string should be in the GLib file name encoding. Most importantly, * The string should be in the GLib file name encoding. Most importantly,
* on Windows it should be in UTF-8. * on Windows it should be in UTF-8.
* *
* Returns: (type filename): A pointer to @tmpl, which has been modified * Returns: (nullable) (type filename): A pointer to @tmpl, which has been
* to hold the directory name. In case of errors, %NULL is * modified to hold the directory name. In case of errors, %NULL is
* returned and %errno will be set. * returned and %errno will be set.
* *
* Since: 2.30 * Since: 2.30
@ -1771,8 +1771,8 @@ g_build_pathv (const gchar *separator,
/** /**
* g_build_path: * g_build_path:
* @separator: a string used to separator the elements of the path. * @separator: (type filename): a string used to separator the elements of the path.
* @first_element: the first element in the path * @first_element: (type filename): the first element in the path
* @...: remaining elements in path, terminated by %NULL * @...: remaining elements in path, terminated by %NULL
* *
* Creates a path from a series of elements using @separator as the * Creates a path from a series of elements using @separator as the
@ -1802,7 +1802,8 @@ g_build_pathv (const gchar *separator,
* copies of the separator, elements consisting only of copies * copies of the separator, elements consisting only of copies
* of the separator are ignored. * of the separator are ignored.
* *
* Returns: a newly-allocated string that must be freed with g_free(). * Returns: (type filename): a newly-allocated string that must be freed with
* g_free().
**/ **/
gchar * gchar *
g_build_path (const gchar *separator, g_build_path (const gchar *separator,
@ -1967,7 +1968,7 @@ g_build_filenamev (gchar **args)
/** /**
* g_build_filename: * g_build_filename:
* @first_element: the first element in the path * @first_element: (type filename): the first element in the path
* @...: remaining elements in path, terminated by %NULL * @...: remaining elements in path, terminated by %NULL
* *
* Creates a filename from a series of elements using the correct * Creates a filename from a series of elements using the correct
@ -1986,7 +1987,8 @@ g_build_filenamev (gchar **args)
* path. If the first element is a relative path, the result will * path. If the first element is a relative path, the result will
* be a relative path. * be a relative path.
* *
* Returns: a newly-allocated string that must be freed with g_free(). * Returns: (type filename): a newly-allocated string that must be freed with
* g_free().
**/ **/
gchar * gchar *
g_build_filename (const gchar *first_element, g_build_filename (const gchar *first_element,
@ -2295,14 +2297,14 @@ g_path_get_basename (const gchar *file_name)
/** /**
* g_dirname: * g_dirname:
* @file_name: the name of the file * @file_name: (type filename): the name of the file
* *
* Gets the directory components of a file name. * Gets the directory components of a file name.
* *
* If the file name has no directory components "." is returned. * If the file name has no directory components "." is returned.
* The returned string should be freed when no longer needed. * The returned string should be freed when no longer needed.
* *
* Returns: the directory components of the file * Returns: (type filename): the directory components of the file
* *
* Deprecated: use g_path_get_dirname() instead * Deprecated: use g_path_get_dirname() instead
*/ */