svn commit: r1690140 - in /lucene/dev/branches/branch_5x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/util/fst/Builder.java

[mi...@apache.org]

Author: mikemccand
Date: Thu Jul  9 18:49:59 2015
New Revision: 1690140

URL: http://svn.apache.org/r1690140
Log:
improve javadocs

Modified:
    lucene/dev/branches/branch_5x/   (props changed)
    lucene/dev/branches/branch_5x/lucene/   (props changed)
    lucene/dev/branches/branch_5x/lucene/core/   (props changed)
    lucene/dev/branches/branch_5x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java

Modified: lucene/dev/branches/branch_5x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_5x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java?rev=1690140&r1=1690139&r2=1690140&view=diff
==============================================================================
--- lucene/dev/branches/branch_5x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java (original)
+++ lucene/dev/branches/branch_5x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java Thu Jul  9 18:49:59 2015
@@ -339,8 +339,11 @@ public class Builder<T> {
   }
   */
 
-  /** It's OK to add the same input twice in a row with
-   *  different outputs, as long as outputs impls the merge
+  /** Add the next input/output pair.  The provided input
+   *  must be sorted after the previous one according to
+   *  {@link IntsRef#compareTo}.  It's also OK to add the same
+   *  input twice in a row with different outputs, as long
+   *  as {@link Outputs} implements the {@link Outputs#merge}
    *  method. Note that input is fully consumed after this
    *  method is returned (so caller is free to reuse), but
    *  output is not.  So if your outputs are changeable (eg