[epiphany] e-file-helpers: improve ephy_file_tmp_filename comment



commit a101be10c2bcdbd5ca8d5d22b1315237d54f54f4
Author: Diego Escalante Urrelo <diegoe igalia com>
Date:   Fri Apr 6 12:09:49 2012 -0500

    e-file-helpers: improve ephy_file_tmp_filename comment
    
    https://bugzilla.gnome.org/show_bug.cgi?id=673337

 lib/ephy-file-helpers.c |   13 ++++++++-----
 1 files changed, 8 insertions(+), 5 deletions(-)
---
diff --git a/lib/ephy-file-helpers.c b/lib/ephy-file-helpers.c
index d34545a..5b255fe 100644
--- a/lib/ephy-file-helpers.c
+++ b/lib/ephy-file-helpers.c
@@ -164,14 +164,17 @@ ephy_file_desktop_dir (void)
 
 /**
  * ephy_file_tmp_filename:
- * @base: the base name of the temp file to create
+ * @base: the base name of the temp file to create, containing "XXXXXX"
  * @extension: an optional extension for @base or %NULL
  *
- * Creates a temp file with mkstemp() using @base as the name with an optional
- * @extension.
+ * Gets a usable temp filename with g_mkstemp() using @base as the name
+ * with an optional @extension. @base should contain "XXXXXX" in it.
  *
- * Returns: a newly-allocated string containing the name of the created temp
- * file or %NULL.
+ * Notice that this does not create the file. It only gets a valid
+ * filename.
+ *
+ * Returns: a newly-allocated string containing the name of the temp
+ * file name or %NULL.
  **/
 char *
 ephy_file_tmp_filename (const char *base,



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