OPENNLP-1302: add missing param tags (#374)

* add missing param tags * OPENNLP-1302: add missing param tags
apache · May 14, 2020 · bc13b3d · bc13b3d
1 parent 918f42f
commit bc13b3d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/opennlp-uima/src/main/java/opennlp/uima/normalizer/Normalizer.java b/opennlp-uima/src/main/java/opennlp/uima/normalizer/Normalizer.java
@@ -113,6 +113,7 @@ public Normalizer() {
    * Initializes the current instance with the given context.
    * <p>
    * Note: Do all initialization in this method, do not use the constructor.
+   * @param context context to initialize
    */
   public void initialize(UimaContext context)
       throws ResourceInitializationException {
@@ -146,6 +147,7 @@ public void initialize(UimaContext context)
 
   /**
    * Initializes the type system.
+   * @param typeSystem type system to initialize
    */
   public void typeSystemInit(TypeSystem typeSystem)
       throws AnalysisEngineProcessException {

diff --git a/opennlp-uima/src/main/java/opennlp/uima/normalizer/StringDictionary.java b/opennlp-uima/src/main/java/opennlp/uima/normalizer/StringDictionary.java
@@ -50,10 +50,19 @@ public StringDictionary(InputStream in) throws IOException {
     });
   }
 
+  /**
+   * Returns a corresponding String value from hash map.
+   * @param key key to get value with
+   */
   public String get(StringList key) {
     return entries.get(key);
   }
 
+  /**
+   * Adds a new entry to hash map.
+   * @param key key to put
+   * @param value value to put
+   */
   public void put(StringList key, String value) {
     entries.put(key, value);
   }