luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-26 12:12:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve the g_file_make_symbolic_link docs

Browse Source 
Following a proposal by Neil Williams in bug 619527.
This commit is contained in:
Matthias Clasen 2010-05-24 21:09:55 -04:00
parent 77b9a46461
commit 1b7f645492
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gio/gfile.c
View File

@ -3445,19 +3445,20 @@ g_file_make_directory_with_parents (GFile *file,
/** /**
* g_file_make_symbolic_link: * g_file_make_symbolic_link:
* @file: input #GFile. * @file: a #GFile with the name of the symlink to create
* @symlink_value: a string with the value of the new symlink. * @symlink_value: a string with the path for the target of the new symlink
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError. * @error: a #GError.
* *
* Creates a symbolic link. * Creates a symbolic link named @file which contains the string
* @symlink_value.
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* Returns: %TRUE on the creation of a new symlink, %FALSE otherwise. * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
**/ */
gboolean gboolean
g_file_make_symbolic_link (GFile *file, g_file_make_symbolic_link (GFile *file,
const char *symlink_value, const char *symlink_value,