lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From uschind...@apache.org
Subject svn commit: r1379945 - /lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
Date Sun, 02 Sep 2012 11:26:32 GMT
Author: uschindler
Date: Sun Sep  2 11:26:32 2012
New Revision: 1379945

URL: http://svn.apache.org/viewvc?rev=1379945&view=rev
Log:
LUCENE-3312: Add Robert's warning back.

Modified:
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java?rev=1379945&r1=1379944&r2=1379945&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
(original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
Sun Sep  2 11:26:32 2012
@@ -99,7 +99,10 @@ public class DocumentStoredFieldVisitor 
 
   /**
    * 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;



Mime
View raw message