luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-13 04:46:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

gfileutils: fix docs/annotations for temp file methods

Browse Source 
https://bugzilla.gnome.org/show_bug.cgi?id=657084
This commit is contained in:
Dan Winship 2011-08-22 11:37:48 -04:00 committed by Jasper St. Pierre
parent 24e03ed409
commit 2cd3c20068
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
glib/gfileutils.c
View File

@ -1253,7 +1253,7 @@ wrap_mkdir (gchar *tmpl,
/** /**
* g_mkdtemp_full: * g_mkdtemp_full:
* @tmpl: template directory name * @tmpl: (type filename): template directory name
* @mode: permissions to create the temporary directory with * @mode: permissions to create the temporary directory with
* *
* Creates a temporary directory. See the mkdtemp() documentation * Creates a temporary directory. See the mkdtemp() documentation
@ -1269,7 +1269,8 @@ wrap_mkdir (gchar *tmpl,
* should be in UTF-8. * should be in UTF-8.
* *
* Return value: A pointer to @tmpl, which has been modified * Return value: A pointer to @tmpl, which has been modified
* to hold the directory name. In case of errors, %NULL is returned. * to hold the directory name. In case of errors, %NULL is
* returned, and %errno will be set.
* *
* Since: 2.26 * Since: 2.26
*/ */
@ -1285,7 +1286,7 @@ g_mkdtemp_full (gchar *tmpl,
/** /**
* g_mkdtemp: * g_mkdtemp:
* @tmpl: template directory name * @tmpl: (type filename): template directory name
* *
* Creates a temporary directory. See the mkdtemp() documentation * Creates a temporary directory. See the mkdtemp() documentation
* on most UNIX-like systems. * on most UNIX-like systems.
@ -1300,7 +1301,8 @@ g_mkdtemp_full (gchar *tmpl,
* on Windows it should be in UTF-8. * on Windows it should be in UTF-8.
* *
* Return value: A pointer to @tmpl, which has been modified * Return value: A pointer to @tmpl, which has been modified
* to hold the directory name. In case of errors, NULL is returned. * to hold the directory name. In case of errors, %NULL is
* returned and %errno will be set.
* *
* Since: 2.26 * Since: 2.26
*/ */
@ -1312,7 +1314,7 @@ g_mkdtemp (gchar *tmpl)
/** /**
* g_mkstemp_full: * g_mkstemp_full:
* @tmpl: template filename * @tmpl: (type filename): template filename
* @flags: flags to pass to an open() call in addition to O_EXCL * @flags: flags to pass to an open() call in addition to O_EXCL
* and O_CREAT, which are passed automatically * and O_CREAT, which are passed automatically
* @mode: permissions to create the temporary file with * @mode: permissions to create the temporary file with
@ -1331,7 +1333,8 @@ g_mkdtemp (gchar *tmpl)
* *
* Return value: A file handle (as from open()) to the file * Return value: A file handle (as from open()) to the file
* opened for reading and writing. The file handle should be * opened for reading and writing. The file handle should be
* closed with close(). In case of errors, -1 is returned. * closed with close(). In case of errors, -1 is returned
* and %errno will be set.
* *
* Since: 2.22 * Since: 2.22
*/ */
@ -1347,7 +1350,7 @@ g_mkstemp_full (gchar *tmpl,
/** /**
* g_mkstemp: * g_mkstemp:
* @tmpl: template filename * @tmpl: (type filename): template filename
* *
* Opens a temporary file. See the mkstemp() documentation * Opens a temporary file. See the mkstemp() documentation
* on most UNIX-like systems. * on most UNIX-like systems.
@ -1363,7 +1366,8 @@ g_mkstemp_full (gchar *tmpl,
* Return value: A file handle (as from open()) to the file * Return value: A file handle (as from open()) to the file
* opened for reading and writing. The file is opened in binary * opened for reading and writing. The file is opened in binary
* mode on platforms where there is a difference. The file handle * mode on platforms where there is a difference. The file handle
* should be closed with close(). In case of errors, -1 is returned. * should be closed with close(). In case of errors, -1 is
* returned and %errno will be set.
*/ */
gint gint
g_mkstemp (gchar *tmpl) g_mkstemp (gchar *tmpl)
@ -1453,9 +1457,10 @@ g_get_tmp_name (const gchar *tmpl,
/** /**
* g_file_open_tmp: * g_file_open_tmp:
* @tmpl: Template for file name, as in g_mkstemp(), basename only, * @tmpl: (type filename) (allow-none): Template for file name, as in
* or %NULL, to a default template * g_mkstemp(), basename only, or %NULL for a default template
* @name_used: location to store actual name used, or %NULL * @name_used: (out) (type filename): location to store actual name used,
* or %NULL
* @error: return location for a #GError * @error: return location for a #GError
* *
* Opens a file for writing in the preferred directory for temporary * Opens a file for writing in the preferred directory for temporary
@ -1506,9 +1511,8 @@ g_file_open_tmp (const gchar *tmpl,
/** /**
* g_dir_make_tmp: * g_dir_make_tmp:
* @tmpl: Template for directory name, as in g_mkdtemp(), basename only, * @tmpl: (type filename) (allow-none): Template for directory name,
* or %NULL, to a default template * as in g_mkdtemp(), basename only, or %NULL for a default template
* @name_used: location to store actual name used, or %NULL
* @error: return location for a #GError * @error: return location for a #GError
* *
* Creates a subdirectory in the preferred directory for temporary * Creates a subdirectory in the preferred directory for temporary
@ -1523,10 +1527,10 @@ g_file_open_tmp (const gchar *tmpl,
* Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
* modified, and might thus be a read-only literal string. * modified, and might thus be a read-only literal string.
* *
* Return value: The actual name used. This string should be freed * Return value: (type filename): The actual name used. This string
* with g_free() when not needed any longer and is is in the GLib * should be freed with g_free() when not needed any longer and is
* file name encoding. In case of errors, %NULL is returned * is in the GLib file name encoding. In case of errors, %NULL is
* and @error will be set. * returned and @error will be set.
* *
* Since: 2.30 * Since: 2.30
*/ */