[lucene] branch main updated: LUCENE-10102: Fix JapaneseCompletionFilter javadoc

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomoko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new 5dfbef3  LUCENE-10102: Fix JapaneseCompletionFilter javadoc
5dfbef3 is described below

commit 5dfbef313cfccbdc26e05647ef7a92a7d312d123
Author: Tomoko Uchida <to...@gmail.com>
AuthorDate: Sat Sep 18 14:40:47 2021 +0900

    LUCENE-10102: Fix JapaneseCompletionFilter javadoc
---
 .../apache/lucene/analysis/ja/JapaneseCompletionFilter.java | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionFilter.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionFilter.java
index 041a7c1..aed199f 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionFilter.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionFilter.java
@@ -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}.