summaryrefslogtreecommitdiff
path: root/glib/gfileutils.c
diff options
context:
space:
mode:
authorPhilip Withnall <withnall@endlessm.com>2018-10-23 14:38:13 +1300
committerPhilip Withnall <withnall@endlessm.com>2018-10-23 14:38:13 +1300
commitec5d6ab63dc066df5522747ce59c6a06763f999c (patch)
tree55ad4129fd28c506ae8879a57b79a3bd507f2449 /glib/gfileutils.c
parentda512adc34926d20bac929e51acefcb4d2c92a72 (diff)
downloadglib-ec5d6ab63dc066df5522747ce59c6a06763f999c.tar.gz
gfileutils: Add examples to g_path_get_dirname() documentation
See https://gitlab.gnome.org/GNOME/glib/merge_requests/326. Signed-off-by: Philip Withnall <withnall@endlessm.com>
Diffstat (limited to 'glib/gfileutils.c')
-rw-r--r--glib/gfileutils.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 1e7a771a9..d6beaa5c0 100644
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -2387,7 +2387,9 @@ g_path_get_basename (const gchar *file_name)
* g_path_get_dirname:
* @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. For example, the directory
+ * component of `/usr/bin/test` is `/usr/bin`. The directory component of `/`
+ * is `/`.
*
* If the file name has no directory components "." is returned.
* The returned string should be freed when no longer needed.