clarified javadoc

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@478302 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Wolfgang Hoschek 2006-11-22 19:42:25 +00:00
parent a01711b245
commit e7ed9203c0
1 changed files with 6 additions and 3 deletions

View File

@ -223,9 +223,12 @@ public class MemoryIndex {
/**
* Convenience method; Tokenizes the given field text and adds the resulting
* terms to the index; Equivalent to adding a tokenized, indexed,
* termVectorStored, unstored, non-keyword Lucene
* {@link org.apache.lucene.document.Field}.
* terms to the index; Equivalent to adding an indexed non-keyword Lucene
* {@link org.apache.lucene.document.Field} that is
* {@link org.apache.lucene.document.Field.Index#TOKENIZED tokenized},
* {@link org.apache.lucene.document.Field.Store#NO not stored},
* {@link org.apache.lucene.document.Field.TermVector#WITH_POSITIONS termVectorStored with positions} (or
* {@link org.apache.lucene.document.Field.TermVector#WITH_POSITIONS termVectorStored with positions and offsets}),
*
* @param fieldName
* a name to be associated with the text