Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-10102: Fix JapaneseCompletionFilter javadoc

This commit is contained in:
Tomoko Uchida 2021-09-18 14:40:47 +09:00
parent deff5a1f5a
commit 5dfbef313c
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionFilter.java
View File

@ -36,13 +36,14 @@ import org.apache.lucene.util.CharsRefBuilder;
* attribute. Also, this keeps original tokens (surface forms). Main usage of this filter is Query
* Auto-Completion.
*
* <p>Supported romanization form: (modified) Hepburn-shiki, Kunrei-shiki (Nihon-shiki) and Wāpuro
* shiki.
* <p>Supported romanization systems: (modified) Hepburn-shiki, Kunrei-shiki (Nihon-shiki) and
* Wāpuro shiki.
*
* <p>This does NOT support some romanji forms which are official but not commonly used with
* Japanese <a href="https://en.wikipedia.org/wiki/Input_method">Input Methods</a>. e.g.: circumflex
* or macron representing <a href="https://en.wikipedia.org/wiki/Ch%C5%8Donpu">Chōonpu (長音符)</a> are
* not supported.
* <p>This does not strictly comply with the romanization systems listed above, but tries to cover
* possible keystroke supported by various <a
* href="https://en.wikipedia.org/wiki/Input_method">Input Methods</a>. e.g.: Circumflex / Macron
* representing <a href="https://en.wikipedia.org/wiki/Ch%C5%8Donpu">Chōonpu (長音符)</a> are not
* supported.
*
* <p>The romanization behaviour changes according to its {@link Mode}. The default mode is {@link
* Mode#INDEX}.