From 06afa5d24d361b73fba71d540f3528981fd38b71 Mon Sep 17 00:00:00 2001
From: Ryan McKinley <ryan@apache.org>
Date: Tue, 23 Dec 2008 16:51:04 +0000
Subject: [PATCH] adding javadoc for getLimitingFacets()

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@729035 13f79535-47bb-0310-9956-ffa450edef68
---
 .../solr/client/solrj/response/QueryResponse.java      | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java b/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
index 25a6ff5f97e..03dcaf7e7b0 100644
--- a/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
+++ b/src/solrj/org/apache/solr/client/solrj/response/QueryResponse.java
@@ -271,6 +271,9 @@ public class QueryResponse extends SolrResponseBase
     return _spellResponse;
   }
 
+  /**
+   * See also: {@link #getLimitingFacets()}
+   */
   public List<FacetField> getFacetFields() {
     return _facetFields;
   }
@@ -301,6 +304,13 @@ public class QueryResponse extends SolrResponseBase
     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;
   }