svn commit: r1401692 - in /lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification: ClassificationResult.java KNearestNeighborClassifier.java

[to...@apache.org]

Author: tommaso
Date: Wed Oct 24 13:59:06 2012
New Revision: 1401692

URL: http://svn.apache.org/viewvc?rev=1401692&view=rev
Log:
[LUCENE-4345] - fixed javadoc

Modified:
    lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/ClassificationResult.java
    lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/KNearestNeighborClassifier.java

Modified: lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/ClassificationResult.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/ClassificationResult.java?rev=1401692&r1=1401691&r2=1401692&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/ClassificationResult.java (original)
+++ lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/ClassificationResult.java Wed Oct 24 13:59:06 2012
@@ -19,21 +19,35 @@ package org.apache.lucene.classification
 
 /**
  * The result of a call to {@link Classifier#assignClass(String)} holding an assigned class and a score.
+ * @lucene.experimental
  */
 public class ClassificationResult {
 
   private String assignedClass;
   private double score;
 
+  /**
+   * Constructor
+   * @param assignedClass the class <code>String</code> assigned by a {@link Classifier}
+   * @param score the score for the assignedClass as a <code>double</code>
+   */
   public ClassificationResult(String assignedClass, double score) {
     this.assignedClass = assignedClass;
     this.score = score;
   }
 
+  /**
+   * retrieve the result class
+   * @return a <code>String</code> representing an assigned class
+   */
   public String getAssignedClass() {
     return assignedClass;
   }
 
+  /**
+   * retrieve the result score
+   * @return a <code>double</code> representing a result score
+   */
   public double getScore() {
     return score;
   }

Modified: lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/KNearestNeighborClassifier.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/KNearestNeighborClassifier.java?rev=1401692&r1=1401691&r2=1401692&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/KNearestNeighborClassifier.java (original)
+++ lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/KNearestNeighborClassifier.java Wed Oct 24 13:59:06 2012
@@ -43,6 +43,10 @@ public class KNearestNeighborClassifier 
   private IndexSearcher indexSearcher;
   private int k;
 
+  /**
+   * Create a {@link Classifier} using kNN algorithm
+   * @param k the number of neighbors to analyze as an <code>int</code>
+   */
   public KNearestNeighborClassifier(int k) {
     this.k = k;
   }