svn commit: r1670337 - /subversion/trunk/subversion/include/svn_diff.h

[st...@apache.org]

Author: stefan2
Date: Tue Mar 31 13:36:21 2015
New Revision: 1670337

URL: http://svn.apache.org/r1670337
Log:
Documentation fixes to the 1.9 svn_diff API.  No functional change.

* subversion/include/svn_diff.h
  (svn_diff_output2,
   svn_diff_file_output_unified4): Document cancelation functionality.
  (svn_diff_file_output_unified3): Fix reference to bumped API.
  (svn_diff_file_output_merge3: Document cancelation functionality.
  (svn_diff_output_binary): Same. Fix a typo.
  (svn_diff_mem_string_output_unified3,
   svn_diff_mem_string_output_merge3): Document cancelation functionality.

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

Modified: subversion/trunk/subversion/include/svn_diff.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_diff.h?rev=1670337&r1=1670336&r2=1670337&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_diff.h (original)
+++ subversion/trunk/subversion/include/svn_diff.h Tue Mar 31 13:36:21 2015
@@ -412,6 +412,9 @@ typedef enum svn_diff_conflict_display_s
 /** Given a vtable of @a output_fns/@a output_baton for consuming
  * differences, output the differences in @a diff.
  *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
+ *
  * @since New in 1.9.
  */
 svn_error_t *
@@ -628,6 +631,9 @@ svn_diff_file_diff4(svn_diff_t **diff,
  * will be used in the generated diff output. Otherwise the legacy compile
  * time default will be used.
  *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
+ *
  * @since New in 1.9.
  */
 svn_error_t *
@@ -645,7 +651,7 @@ svn_diff_file_output_unified4(svn_stream
                               void *cancel_baton,
                               apr_pool_t *scratch_pool);
 
-/** Similar to svn_diff_file_output_unified3(), but without cancel
+/** Similar to svn_diff_file_output_unified4(), but without cancel
  * support and with @a context_size set to -1.
  *
  * @since New in 1.5.
@@ -708,6 +714,9 @@ svn_diff_file_output_unified(svn_stream_
  * @a conflict_style dictates how conflicts are displayed. 
  * Uses @a scratch_pool for temporary allocations.
  *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
+ *
  * @since New in 1.9.
  */
 svn_error_t *
@@ -783,7 +792,10 @@ svn_diff_file_output_merge(svn_stream_t
  * Either @a original or @a latest may be NULL to describe that the version
  * didn't exist.
  *
- * Writes the ouput to @a output_stream.
+ * Writes the output to @a output_stream.
+ *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
  *
  * @since New in 1.9.
  */
@@ -859,6 +871,9 @@ svn_diff_mem_string_diff4(svn_diff_t **d
  * will be used in the generated diff output. Otherwise the legacy compile
  * time default will be used.
  *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
+ *
  * Uses @a scratch_pool for temporary allocations.
  *
  * @since New in 1.9
@@ -927,6 +942,9 @@ svn_diff_mem_string_output_unified(svn_s
  *
  * @a conflict_style dictates how conflicts are displayed.
  *
+ * If not @c NULL, call @a cancel_func with @a cancel_baton once or multiple
+ * times while processing larger diffs.
+ *
  * Uses @a scratch_pool for temporary allocations.
  *
  * @since New in 1.9.