From 0b3b1fa69ee8a2ec866176446aee5c42397dd2b5 Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Sun, 2 Sep 2012 11:26:32 +0000 Subject: [PATCH] LUCENE-3312: Add Robert's warning back. git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene3312@1379945 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/lucene/document/DocumentStoredFieldVisitor.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java b/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java index 111fd258abe..5f566c58be6 100644 --- a/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java +++ b/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java @@ -99,7 +99,10 @@ public class DocumentStoredFieldVisitor extends StoredFieldVisitor { /** * Retrieve the visited document. - * @return StoredDocument populated with stored fields. + * @return {@link StoredDocument} populated with stored fields. Note that only + * the stored information in the field instances is valid, + * data such as indexing options, term vector options, + * etc is not set. */ public StoredDocument getDocument() { return doc;