You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by iv...@apache.org on 2016/08/17 16:07:47 UTC
svn commit: r1756647 - /subversion/trunk/subversion/include/svn_io.h
Author: ivan
Date: Wed Aug 17 16:07:47 2016
New Revision: 1756647
URL: http://svn.apache.org/viewvc?rev=1756647&view=rev
Log:
Follow-up to r1755486: Improve docstring.
Suggested by: danielsh
* subversion/include/svn_io.h
(svn_stream_checksum): Improve docstring.
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=1756647&r1=1756646&r2=1756647&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Wed Aug 17 16:07:47 2016
@@ -1254,13 +1254,14 @@ svn_stream_checksummed(svn_stream_t *str
svn_boolean_t read_all,
apr_pool_t *pool);
-/** Return in @a *checksum the checksum of type @a kind of @a stream.
+/** Read the contents of the readable stream @a stream and return its
+ * checksum of type @a kind in @a *checksum.
*
- * Stream will be closed before this function returns (regardless of
- * the result, or any possible error).
+ * The stream will be closed before this function returns (regardless
+ * of the result, or any possible error).
*
* Use @a scratch_pool for temporary allocations and @a result_pool
- * to allocate @a *checksum.
+ * to allocate @a *checksum.
*
* @since New in 1.10.
*/