svn commit: r955627 - /subversion/trunk/subversion/include/svn_io.h

[ju...@apache.org]

Author: julianfoad
Date: Thu Jun 17 15:11:02 2010
New Revision: 955627

URL: http://svn.apache.org/viewvc?rev=955627&view=rev
Log:
* subversion/include/svn_io.h
  (svn_io_open_unique_file3): In the doc string, mention that the file
    is not open if the 'file' parameter is NULL.

Modified:
    subversion/trunk/subversion/include/svn_io.h

Modified: subversion/trunk/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=955627&r1=955626&r2=955627&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Thu Jun 17 15:11:02 2010
@@ -188,10 +188,11 @@ svn_io_open_uniquely_named(apr_file_t **
                            apr_pool_t *scratch_pool);
 
 
-/** Create a writable file in the directory @a dirpath. The file will have
- * an arbitrary and unique name, and the full path will be returned in
- * @a temp_path. The file will be returned in @a file. Both will be
- * allocated from @a result_pool.
+/** Create a writable file, with an arbitrary and unique name, in the
+ * directory @a dirpath.  Set @a *temp_path to its full path, and set
+ * @a *file to the file handle, both allocated from @a result_pool.  Either
+ * @a file or @a unique_name may be @c NULL.  If @a file is @c NULL, the file
+ * will be created but not open.
  *
  * If @a dirpath is @c NULL, use the path returned from svn_io_temp_dir().
  * (Note that when using the system-provided temp directory, it may not