[glib] gfileutils: Fix g_mkdtemp*() API docs



commit bc8361262bf15ce4d13bc7832a25af37fa375294
Author: Bastien Nocera <hadess hadess net>
Date:   Mon Jan 23 05:44:35 2017 +0100

    gfileutils: Fix g_mkdtemp*() API docs
    
    Don't refer to g_mkdtemp() when documenting g_mkdtemp_full() and
    speaking about the function itself, and remove mention of flags in
    aforementioned g_mkdtemp_full(), as it doesn't have such an argument
    (but g_mkstemp_full() does).
    
    https://bugzilla.gnome.org/show_bug.cgi?id=777493

 glib/gfileutils.c |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 2e9655f..c78d2b7 100644
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -1358,7 +1358,7 @@ wrap_g_open (const gchar *filename,
  *
  * The parameter is a string that should follow the rules for
  * mkdtemp() templates, i.e. contain the string "XXXXXX".
- * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
+ * g_mkdtemp_full() is slightly more flexible than mkdtemp() in that the
  * sequence does not have to occur at the very end of the template
  * and you can pass a @mode. The X string will be modified to form
  * the name of a directory that didn't exist. The string should be
@@ -1391,9 +1391,9 @@ g_mkdtemp_full (gchar *tmpl,
  * The parameter is a string that should follow the rules for
  * mkdtemp() templates, i.e. contain the string "XXXXXX".
  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
- * sequence does not have to occur at the very end of the template
- * and you can pass a @mode and additional @flags. The X string will
- * be modified to form the name of a directory that didn't exist.
+ * sequence does not have to occur at the very end of the template.
+ * The X string will be modified to form the name of a directory that
+ * didn't exist.
  * The string should be in the GLib file name encoding. Most importantly,
  * on Windows it should be in UTF-8.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]