Add breif descriptions for supported parameters

This commit is contained in:
Tomoko Uchida 2018-08-11 10:33:37 +09:00
parent 4c45557826
commit 4c27b839e5
2 changed files with 17 additions and 1 deletions

View File

@ -34,6 +34,12 @@ import org.apache.lucene.analysis.util.TokenFilterFactory;
* </analyzer>
* </fieldType>
* </pre>
*
* <p>
* Supports the following attributes:
* <ul>
* <li>tags: List of stop tags. if not specified, {@link KoreanPartOfSpeechStopFilter#DEFAULT_STOP_TAGS} is used.</li>
* </ul>
* @lucene.experimental
*/
public class KoreanPartOfSpeechStopFilterFactory extends TokenFilterFactory {

View File

@ -32,6 +32,7 @@ import org.apache.lucene.util.AttributeFactory;
import org.apache.lucene.util.IOUtils;
import org.apache.lucene.analysis.util.ResourceLoader;
import org.apache.lucene.analysis.util.ResourceLoaderAware;
import org.apache.lucene.analysis.ko.KoreanTokenizer.DecompoundMode;
/**
* Factory for {@link KoreanTokenizer}.
@ -46,7 +47,16 @@ import org.apache.lucene.analysis.util.ResourceLoaderAware;
* /&gt;
* &lt;/analyzer&gt;
* &lt;/fieldType&gt;
</pre>
* </pre>
*
* <p>
* Supports the following attributes:
* <ul>
* <li>userDictionary: User dictionary path.</li>
* <li>userDictionaryEncoding: User dictionary encoding.</li>
* <li>decompoundMode: Decompound mode. Either 'none', 'discard', 'mixed'. Default is discard. See {@link DecompoundMode}</li>
* <li>outputUnknownUnigrams: If true outputs unigrams for unknown words.</li>
* </ul>
* @lucene.experimental
*/
public class KoreanTokenizerFactory extends TokenizerFactory implements ResourceLoaderAware {