javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1374009 13f79535-47bb-0310-9956-ffa450edef68

lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java

@@ -398,12 +398,17 @@ public class FuzzyTermsEnum extends TermsEnum {
     return scale_factor;
   }
   
-  /** @lucene.internal */
+  /**
+   * reuses compiled automata across different segments,
+   * because they are independent of the index
+   * @lucene.internal */
   public static interface LevenshteinAutomataAttribute extends Attribute {
     public List<CompiledAutomaton> automata();
   }
     
-  /** @lucene.internal */
+  /** 
+   * Stores compiled automata as a list (indexed by edit distance)
+   * @lucene.internal */
   public static final class LevenshteinAutomataAttributeImpl extends AttributeImpl implements LevenshteinAutomataAttribute {
     private final List<CompiledAutomaton> automata = new ArrayList<CompiledAutomaton>();
       

lucene/core/src/java/org/apache/lucene/util/FuzzySet.java

@@ -48,6 +48,11 @@ public class FuzzySet {
   
   public static final int FUZZY_SERIALIZATION_VERSION=1;
   
+  /**
+   * Result from {@link FuzzySet#contains(BytesRef)}:
+   * can never return definitively YES (always MAYBE), 
+   * but can sometimes definitely return NO.
+   */
   public enum ContainsResult {
     MAYBE, NO
   };