svn commit: r957604 - /subversion/trunk/subversion/include/svn_wc.h

[ju...@apache.org]

Author: julianfoad
Date: Thu Jun 24 16:17:16 2010
New Revision: 957604

URL: http://svn.apache.org/viewvc?rev=957604&view=rev
Log:
* subversion/include/svn_wc.h
  (svn_wc_translated_stream2): Fix and clarify the doc string.

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

Modified: subversion/trunk/subversion/include/svn_wc.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=957604&r1=957603&r2=957604&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Thu Jun 24 16:17:16 2010
@@ -7073,16 +7073,17 @@ svn_wc_translated_file(const char **xlat
                        apr_pool_t *pool);
 
 
-/** Returns a @a stream allocated in @a result_pool with access to the given
- * @a local_abspath taking the file properties from @a versioned_abspath
- * using @a wc_ctx.
- *
- * When translation from normal form is requested
- * (#SVN_WC_TRANSLATE_FROM_NF is specified in @a flags), @a path
- * is used as target path and stream read operations are not supported.
- * Conversely, if translation to normal form is requested
- * (#SVN_WC_TRANSLATE_TO_NF is specified in @a flags), @a path is
- * used as source path and stream write operations are not supported.
+/** Set @a stream to a stream allocated in @a result_pool, that will
+ * translate *to* normal form while reading, or *from* normal form while
+ * writing @a local_abspath.  The translation will take the file properties
+ * from @a versioned_abspath using @a wc_ctx.
+ *
+ * If @a flags includes #SVN_WC_TRANSLATE_FROM_NF, the stream will
+ * translate from Normal Form to working copy form while writing to
+ * @a local_abspath; stream read operations are not supported.
+ * Conversely, if @a flags includes #SVN_WC_TRANSLATE_TO_NF, the stream will
+ * translate from working copy form to Normal Form while reading from
+ * @a local_abspath; stream write operations are not supported.
  *
  * The @a flags are the same constants as those used for
  * svn_wc_translated_file().