improve javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1690139 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2015-07-09 18:49:28 +00:00
parent 28cfd161d2
commit 34320973ba
1 changed files with 5 additions and 2 deletions

View File

@ -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