LUCENE-2070: document how LengthFilter counts characters

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1000675 13f79535-47bb-0310-9956-ffa450edef68
2010-09-24 00:42:05 +00:00 · 2010-09-24 00:42:05 +00:00 · cce20cd820
parent f6d18fc349
commit cce20cd820
1 changed files with 3 additions and 0 deletions
--- a/modules/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/LengthFilter.java
+++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/LengthFilter.java
@ -25,6 +25,9 @@ import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;

 /**
 * Removes words that are too long or too short from the stream.
+ * <p>
+ * Note: Length is calculated as the number of UTF-16 code units.
+ * </p>
 */
 public final class LengthFilter extends TokenFilter {