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
This commit is contained in:
Uwe Schindler 2012-09-02 11:26:32 +00:00
parent 12dddf2285
commit 0b3b1fa69e
1 changed files with 4 additions and 1 deletions

View File

@ -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;