[29/52] [abbrv] lucene-solr:jira/solr-9858: repair analysis javadocs around synonyms

[ab...@apache.org]

repair analysis javadocs around synonyms


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/ec5ebb68
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/ec5ebb68
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/ec5ebb68

Branch: refs/heads/jira/solr-9858
Commit: ec5ebb6886f5e519194f5c4bd2a8f152eb214013
Parents: 88d2658
Author: Mike McCandless <mi...@apache.org>
Authored: Tue Feb 14 06:31:17 2017 -0500
Committer: Mike McCandless <mi...@apache.org>
Committed: Tue Feb 14 06:31:17 2017 -0500

----------------------------------------------------------------------
 .../java/org/apache/lucene/analysis/package-info.java   | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ec5ebb68/lucene/core/src/java/org/apache/lucene/analysis/package-info.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/analysis/package-info.java b/lucene/core/src/java/org/apache/lucene/analysis/package-info.java
index 81858df..a536f73 100644
--- a/lucene/core/src/java/org/apache/lucene/analysis/package-info.java
+++ b/lucene/core/src/java/org/apache/lucene/analysis/package-info.java
@@ -362,11 +362,13 @@
  * </p>
  * <ol>
  *   <li>Inhibiting phrase and proximity matches in sentence boundaries &ndash; for this, a tokenizer that 
- *     identifies a new sentence can add 1 to the position increment of the first token of the new sentence.</li>
- *   <li>Injecting synonyms &ndash; here, synonyms of a token should be added after that token, 
- *     and their position increment should be set to 0.
- *     As result, all synonyms of a token would be considered to appear in exactly the 
- *     same position as that token, and so would they be seen by phrase and proximity searches.</li>
+ *       identifies a new sentence can add 1 to the position increment of the first token of the new sentence.</li>
+ *   <li>Injecting synonyms &ndash; synonyms of a token should be created at the same position as the
+ *       original token, and the output order of the original token and the injected synonym is undefined
+ *       as long as they both leave from the same position.  As result, all synonyms of a token would be
+ *       considered to appear in exactly the same position as that token, and so would they be seen by
+ *       phrase and proximity searches.  For multi-token synonyms to work correctly, you should use
+ *       {@code SynoymGraphFilter} at search time only.</li>
  * </ol>
  * 
  * <h3>Token Position Length</h3>