You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opennlp.apache.org by jo...@apache.org on 2011/05/24 17:17:49 UTC

svn commit: r1127110 - in /incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat: DocumentCategorizerEvaluator.java DocumentCategorizerME.java

Author: joern
Date: Tue May 24 15:17:49 2011
New Revision: 1127110

URL: http://svn.apache.org/viewvc?rev=1127110&view=rev
Log:
OPENNLP-21 Fixed javadoc warnings

Modified:
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerEvaluator.java
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerME.java

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerEvaluator.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerEvaluator.java?rev=1127110&r1=1127109&r2=1127110&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerEvaluator.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerEvaluator.java Tue May 24 15:17:49 2011
@@ -54,7 +54,7 @@ public class DocumentCategorizerEvaluato
    * {@link DocumentSample}. The detected category is then used
    * to calculate and update the score.
    *
-   * @param reference the reference {@link TokenSample}.
+   * @param sample the reference {@link TokenSample}.
    */
   public void evaluteSample(DocumentSample sample) {
 
@@ -75,7 +75,7 @@ public class DocumentCategorizerEvaluato
   /**
    * Reads all {@link DocumentSample} objects from the stream
    * and evaluates each {@link DocumentSample} object with
-   * {@link #evaluateSample(POSSample)} method.
+   * {@link #evaluteSample(DocumentSample)} method.
    *
    * @param samples the stream of reference {@link POSSample} which
    * should be evaluated.

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerME.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerME.java?rev=1127110&r1=1127109&r2=1127110&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerME.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/doccat/DocumentCategorizerME.java Tue May 24 15:17:49 2011
@@ -165,7 +165,9 @@ public class DocumentCategorizerME imple
    * @param cutoff
    * @param iterations
    * @param featureGenerators
-   * @return
+   * 
+   * @return the trained doccat model
+   * 
    * @throws IOException
    */
   public static DoccatModel train(String languageCode, ObjectStream<DocumentSample> samples, int cutoff, int iterations, FeatureGenerator... featureGenerators)
@@ -184,7 +186,9 @@ public class DocumentCategorizerME imple
    * 
    * @param languageCode
    * @param samples
-   * @return
+   * 
+   * @return the trained doccat model
+   * 
    * @throws IOException
    * @throws ObjectStreamException 
    */
@@ -197,7 +201,9 @@ public class DocumentCategorizerME imple
    * 
    * @param languageCode
    * @param samples
-   * @return
+   * 
+   * @return the trained doccat model
+   * 
    * @throws IOException
    * @throws ObjectStreamException 
    */