svn commit: r729035 - /lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java

[ryan]

Author: ryan
Date: Tue Dec 23 08:51:04 2008
New Revision: 729035

URL: http://svn.apache.org/viewvc?rev=729035&view=rev
Log:
adding javadoc for getLimitingFacets()

Modified:
    
lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java

Modified: 
lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
URL: 
http://svn.apache.org/viewvc/lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java?rev=729035&r1=729034&r2=729035&view=diff
==============================================================================
--- 
lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
 (original)
+++ 
lucene/solr/trunk/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
 Tue Dec 23 08:51:04 2008
@@ -271,6 +271,9 @@
     return _spellResponse;
   }
 
+  /**
+   * See also: {...@link #getLimitingFacets()}
+   */
   public List<FacetField> getFacetFields() {
     return _facetFields;
   }
@@ -301,6 +304,13 @@
     return null;
   }
   
+  /**
+   * @return a list of FacetFields where the count is less then
+   * then #getResults() {...@link SolrDocumentList#getNumFound()}
+   * 
+   * If you want all results exactly as returned by solr, use:
+   * {...@link #getFacetFields()}
+   */
   public List<FacetField> getLimitingFacets() {
     return _limitingFacets;
   }