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

[br...@apache.org]

Author: breser
Date: Fri Dec  6 19:12:27 2013
New Revision: 1548673

URL: http://svn.apache.org/r1548673
Log:
Fix the documentation for svn_diff_hunk_readline_diff_text().

This function has never returned the hunk header lines, despite several
significant refactorings.

* subversion/include/svn_diff.h
  (svn_diff_hunk_readline_diff_text): Correctly identify that the hunk header
    is not returned and direct users to the functions that can provide the
    data in the hunk header.

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=1548673&r1=1548672&r2=1548673&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_diff.h (original)
+++ subversion/trunk/subversion/include/svn_diff.h Fri Dec  6 19:12:27 2013
@@ -911,8 +911,8 @@ typedef struct svn_diff_hunk_t svn_diff_
 
 /**
  * Allocate @a *stringbuf in @a result_pool, and read into it one line
- * of the diff text of @a hunk. The first line returned is the hunk header.
- * Any subsequent lines are unidiff data (starting with '+', '-', or ' ').
+ * of the diff text of @a hunk. The hunk header is not returned only the
+ * unidiff data lines (starting with '+', '-', or ' ') are returned.  
  * If the @a hunk is being interpreted in reverse (i.e. the reverse
  * parameter of svn_diff_parse_next_patch() was @c TRUE), the diff
  * text will be returned in reversed form.
@@ -922,6 +922,13 @@ typedef struct svn_diff_hunk_t svn_diff_
  * hunk does not end with a newline character and @a eol is not NULL.
  * Temporary allocations will be performed in @a scratch_pool.
  *
+ * @note The hunk header information can be retrievied with the following
+ * functions: 
+ * @see svn_diff_hunk_get_original_start()
+ * @see svn_diff_hunk_get_original_length()
+ * @see svn_diff_hunk_get_modified_start()
+ * @see svn_diff_hunk_get_modified_length()
+ *
  * @since New in 1.7.
  */
 svn_error_t *