From 55fd3840caa4b10df2b8b498ede9fd21eddccfc8 Mon Sep 17 00:00:00 2001
From: "Chris M. Hostetter" <hossman@apache.org>
Date: Wed, 21 Jan 2009 19:49:50 +0000
Subject: [PATCH] note about SolrDocument and SolrDocumentList that should have
 been added prior to 1.3 release

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@736392 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/solr/request/SolrQueryResponse.java | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/java/org/apache/solr/request/SolrQueryResponse.java b/src/java/org/apache/solr/request/SolrQueryResponse.java
index 56c59f14ef5..38684572ccf 100644
--- a/src/java/org/apache/solr/request/SolrQueryResponse.java
+++ b/src/java/org/apache/solr/request/SolrQueryResponse.java
@@ -41,12 +41,18 @@ import java.util.*;
  *  <li>{@link Boolean}</li>
  *  <li>{@link Date}</li>
  *  <li>{@link org.apache.solr.search.DocList}</li>
+ *  <li>{@link org.apache.solr.common.SolrDocument} (since 1.3)</li>
+ *  <li>{@link org.apache.solr.common.SolrDocumentList} (since 1.3)</li>
  *  <li>{@link Map} containing any of the items in this list</li>
  *  <li>{@link NamedList} containing any of the items in this list</li>
  *  <li>{@link Collection} containing any of the items in this list</li>
  *  <li>Array containing any of the items in this list</li>
  *  <li>null</li>
  * </ul>
+ * <p>
+ * Other data types may be added to the SolrQueryResponse, but there is no garuntee
+ * that QueryResponseWriters will be able to deal with unexpected types.
+ * </p>
  *
  * @version $Id$
  * @since solr 0.9