[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

New svn_stream APIs - doc strings

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2006-01-31 01:30:25 CET

Index: subversion/include/svn_io.h
===================================================================
--- subversion/include/svn_io.h (revision 18300)
+++ subversion/include/svn_io.h (working copy)
@@ -552,8 +552,9 @@

  /** Return a stream allocated in @a pool which forwards all requests
   * to @a stream. Destruction is explicitly excluded from forwarding.
+ * ### It's not clear that "Destruction" means closing the stream. To me,
"destruction" implies clearing the pool that it's in.
   *
- * @see notes/destruction-of-stacked-resources
+ * @see notes/destruction-of-stacked-resources ### File doesn't exist
   *
   * @since New in 1.4.
   */
svn_stream_t *svn_stream_disown (svn_stream_t *stream, apr_pool_t *pool);

@@ -571,11 +572,11 @@

-/** Function to create a stream from an APR file. For convenience, if @a
+/** Create a stream from an APR file. For convenience, if @a
   * file is @c NULL an empty stream created by svn_stream_empty() is returned.
   *
   * @note The stream is considered to own the underlying file, meaning that
- * svn_stream_close() will close the file.
+ * svn_stream_close() will close the file. ### What about the "disown"
flag?
   *
   * @since New in 1.4.
   */
svn_stream_t * svn_stream_from_aprfile2 (apr_file_t *file,
                                          svn_boolean_t disown,
                                          apr_pool_t *pool);

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Jan 31 01:30:49 2006

This is an archived mail posted to the Subversion Dev mailing list.