svn commit: r1128861 - /subversion/trunk/subversion/libsvn_diff/diff.h

[st...@apache.org]

Author: stefan2
Date: Sun May 29 10:47:59 2011
New Revision: 1128861

URL: http://svn.apache.org/viewvc?rev=1128861&view=rev
Log:
* subversion/libsvn_diff/diff.h
  (svn_diff__lcs): add docstring

Modified:
    subversion/trunk/subversion/libsvn_diff/diff.h

Modified: subversion/trunk/subversion/libsvn_diff/diff.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_diff/diff.h?rev=1128861&r1=1128860&r2=1128861&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_diff/diff.h (original)
+++ subversion/trunk/subversion/libsvn_diff/diff.h Sun May 29 10:47:59 2011
@@ -88,6 +88,14 @@ typedef enum svn_diff__normalize_state_t
 } svn_diff__normalize_state_t;
 
 
+/*
+ * Calculate the Longest Common Subsequence (LCS) between two datasources,
+ * POSITION_LIST1 and POSITION_LIST2. From the beginning of each list, 
+ * PREFIX_LINES lines will be assumed to be equal and be excluded from the 
+ * comparison process. Similarly, SUFFIX_LINES at the end of both sequences
+ * will be skipped. The resulting lcs structure will be the return value
+ * of this function. Allocations will be made from POOL.
+ */
 svn_diff__lcs_t *
 svn_diff__lcs(svn_diff__position_t *position_list1, /* pointer to tail (ring) */
               svn_diff__position_t *position_list2, /* pointer to tail (ring) */