svn commit: r805149 - /lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java

[gs...@apache.org]

Author: gsingers
Date: Mon Aug 17 21:24:47 2009
New Revision: 805149

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

Modified:
    lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java

Modified: lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java?rev=805149&r1=805148&r2=805149&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/util/SolrPluginUtils.java Mon Aug 17 21:24:47 2009
@@ -893,9 +893,15 @@
    * The optional param "ids" is populated with the lucene document id 
    * for each SolrDocument.  
    * 
+   * @param docs The {@link org.apache.solr.search.DocList} to convert
+   * @param searcher The {@link org.apache.solr.search.SolrIndexSearcher} to use to load the docs from the Lucene index
+   * @param fields The names of the Fields to load
+   * @param ids A map to store the ids of the docs
+   * @return The new {@link org.apache.solr.common.SolrDocumentList} containing all the loaded docs
+   * @throws java.io.IOException if there was a problem loading the docs
    * @since solr 1.4
    */
-  public static SolrDocumentList docListToSolrDocumentList( 
+  public static SolrDocumentList docListToSolrDocumentList(
       DocList docs, 
       SolrIndexSearcher searcher, 
       Set<String> fields,