svn commit: r1631916 - /opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java

[jo...@apache.org]

Author: joern
Date: Tue Oct 14 22:24:32 2014
New Revision: 1631916

URL: http://svn.apache.org/r1631916
Log:
OPENNLP-720 Fixed javadoc error

Modified:
    opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java

Modified: opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java
URL: http://svn.apache.org/viewvc/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java?rev=1631916&r1=1631915&r2=1631916&view=diff
==============================================================================
--- opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java (original)
+++ opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java Tue Oct 14 22:24:32 2014
@@ -66,8 +66,11 @@ public final class TokenizerModel extend
   /**
    * Initializes the current instance.
    *
-   * @param tokenizerMaxentModel
-   * @param useAlphaNumericOptimization
+   * @param language the language the tokenizer should use
+   * @param tokenizerMaxentModel the statistical model of the tokenizer
+   * @param abbreviations the dictionary containing the abbreviations
+   * @param useAlphaNumericOptimization if true alpha numeric optimization is enabled, otherwise not
+   * @param manifestInfoEntries the additional meta data which should be written into manifest
    *
    * @deprecated Use
    *             {@link TokenizerModel#TokenizerModel(MaxentModel, Map, TokenizerFactory)}
@@ -83,10 +86,10 @@ public final class TokenizerModel extend
   /**
    * Initializes the current instance.
    *
-   * @param language
-   * @param tokenizerMaxentModel
-   * @param useAlphaNumericOptimization
-   * @param manifestInfoEntries
+   * @param language the language the tokenizer should use
+   * @param tokenizerMaxentModel the statistical model of the tokenizer
+   * @param useAlphaNumericOptimization if true alpha numeric optimization is enabled, otherwise not
+   * @param manifestInfoEntries the additional meta data which should be written into manifest
    *
    * @deprecated Use
    *             {@link TokenizerModel#TokenizerModel(MaxentModel, Map, TokenizerFactory)}
@@ -100,9 +103,9 @@ public final class TokenizerModel extend
   /**
    * Initializes the current instance.
    *
-   * @param language
-   * @param tokenizerMaxentModel
-   * @param useAlphaNumericOptimization
+   * @param language the language the tokenizer should use
+   * @param tokenizerMaxentModel the statistical model of the tokenizer
+   * @param useAlphaNumericOptimization if true alpha numeric optimization is enabled, otherwise not
    *
    * @deprecated Use
    *             {@link TokenizerModel#TokenizerModel(MaxentModel, Map, TokenizerFactory)}
@@ -116,19 +119,35 @@ public final class TokenizerModel extend
   /**
    * Initializes the current instance.
    *
-   * @param in
+   * @param in the Input Stream to load the model from
    *
-   * @throws IOException
-   * @throws InvalidFormatException
+   * @throws IOException if reading from the stream fails in anyway
+   * @throws InvalidFormatException if the stream doesn't have the expected format
    */
   public TokenizerModel(InputStream in) throws IOException, InvalidFormatException {
     super(COMPONENT_NAME, in);
   }
 
+  /**
+   * Initializes the current instance.
+   *
+   * @param modelFile the file containing the tokenizer model
+   *
+   * @throws IOException if reading from the stream fails in anyway
+   * @throws InvalidFormatException if the stream doesn't have the expected format
+   */
   public TokenizerModel(File modelFile) throws IOException, InvalidFormatException {
     super(COMPONENT_NAME, modelFile);
   }
 
+  /**
+   * Initializes the current instance.
+   *
+   * @param modelURL the URL pointing to the tokenizer model
+   *
+   * @throws IOException if reading from the stream fails in anyway
+   * @throws InvalidFormatException if the stream doesn't have the expected format
+   */
   public TokenizerModel(URL modelURL) throws IOException, InvalidFormatException {
     super(COMPONENT_NAME, modelURL);
   }