You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@mahout.apache.org by gs...@apache.org on 2010/11/19 15:49:34 UTC

svn commit: r1036877 - /mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java

Author: gsingers
Date: Fri Nov 19 14:49:33 2010
New Revision: 1036877

URL: http://svn.apache.org/viewvc?rev=1036877&view=rev
Log:
javadocs

Modified:
    mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java

Modified: mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java
URL: http://svn.apache.org/viewvc/mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java?rev=1036877&r1=1036876&r2=1036877&view=diff
==============================================================================
--- mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java (original)
+++ mahout/trunk/utils/src/main/java/org/apache/mahout/utils/vectors/io/VectorWriter.java Fri Nov 19 14:49:33 2010
@@ -24,6 +24,7 @@ import org.apache.mahout.math.Vector;
 public interface VectorWriter {
   /**
    * Write all values in the Iterable to the output
+   * @param iterable The {@link Iterable} to loop over
    * @return the number of docs written
    * @throws IOException if there was a problem writing
    *
@@ -32,6 +33,7 @@ public interface VectorWriter {
   
   /**
    * Write the first <code>maxDocs</code> to the output.
+   * @param iterable The {@link Iterable} to loop over
    * @param maxDocs the maximum number of docs to write
    * @return The number of docs written
    * @throws IOException if there was a problem writing