OPENNLP-421 - Update JavaDoc

Author: rzo1

opennlp-tools/src/main/java/opennlp/tools/util/StringList.java

@@ -35,7 +35,7 @@ public class StringList implements Iterable<String> {
    * Initializes a {@link StringList} instance.
    * <p>
    * Note: <br>
-   * Token String will be interened via {@link StringInterners}.
+   * Token String will be interned via {@link StringInterners}.
    *
    * @param singleToken One single token
    */
@@ -47,7 +47,7 @@ public StringList(String singleToken) {
    * Initializes a {@link StringList} instance.
    * <p>
    * Note: <br>
-   * Token Strings will be interened via {@link StringInterners}.
+   * Token Strings will be interned via {@link StringInterners}.
    *
    * @param tokens The string parts of the new {@link StringList}.
    *               Must not be an empty tokens array or {@code null}.

opennlp-tools/src/main/java/opennlp/tools/util/jvm/CHMStringDeduplicator.java

@@ -32,14 +32,16 @@
  * Origin:
  * <a href="https://shipilev.net/talks/joker-Oct2014-string-catechism.pdf">
  * https://shipilev.net/talks/joker-Oct2014-string-catechism.pdf</a>
- * <p>
  */
 @Internal
 @ThreadSafe
 class CHMStringDeduplicator implements StringInterner {
   private final int prob;
   private final Map<String, String> map;
 
+  /**
+   * Creates a {@link CHMStringDeduplicator} with a probability of {@code 0.5}.
+   */
   public CHMStringDeduplicator() {
     this(0.5);
   }

opennlp-tools/src/main/java/opennlp/tools/util/jvm/CHMStringInterner.java

@@ -29,7 +29,6 @@
  * Origin:
  * <a href="https://shipilev.net/jvm/anatomy-quarks/10-string-intern/">
  * https://shipilev.net/jvm/anatomy-quarks/10-string-intern/</a>
- * <p>
  */
 @Internal
 @ThreadSafe

opennlp-tools/src/main/java/opennlp/tools/util/jvm/HMStringInterner.java

@@ -28,7 +28,6 @@
  * Origin:
  * <a href="https://shipilev.net/jvm/anatomy-quarks/10-string-intern/">
  * https://shipilev.net/jvm/anatomy-quarks/10-string-intern/</a>
- * <p>
  */
 @Internal
 class HMStringInterner implements StringInterner {

opennlp-tools/src/main/java/opennlp/tools/util/jvm/JvmStringInterner.java

@@ -26,7 +26,7 @@
  * <p>
  * Using this {@link StringInterner} brings back the default behaviour of OpenNLP before version
  * {@code 2.3.2}. You can use it by setting the system property {@code opennlp.interner.class} to
- * the full qualified classname of a {@link StringInterner} implementation.
+ * the fully qualified classname of a {@link StringInterner} implementation.
  * </p>
  */
 @Internal

opennlp-tools/src/main/java/opennlp/tools/util/jvm/StringInterner.java

@@ -24,10 +24,10 @@ public interface StringInterner {
 
   /**
    * Interns and returns a reference to the representative instance
-   * for any of a collection of string instances that are equal to each other.
+   * for any collection of string instances that are equal to each other.
    *
-   * @param s string instance to be interned
+   * @param sample string instance to be interned
    * @return reference to the interned string instance
    */
-  String intern(String s);
+  String intern(String sample);
 }

opennlp-tools/src/main/java/opennlp/tools/util/jvm/StringInterners.java

@@ -25,7 +25,7 @@
 /**
  * Provides string interning utility methods. Interning mechanism can be configured via the
  * system property {@code opennlp.interner.class} by specifying an implementation via its
- * full qualified classname. It needs to implement {@link StringInterner}.
+ * fully qualified classname. It needs to implement {@link StringInterner}.
  * <p>
  * If not specified by the user, the default interner is {@link CHMStringInterner}.
  */
@@ -53,7 +53,7 @@ public class StringInterners {
 
   /**
    * Interns and returns a reference to the representative instance
-   * for any of a collection of string instances that are equal to each other.
+   * for any collection of string instances that are equal to each other.
    *
    * @param sample string instance to be interned
    * @return reference to the interned string instance