svn commit: r1375040 - in /lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index: GeneralField.java IndexDocument.java StorableField.java StorableFieldType.java StoredDocument.java

[us...@apache.org]

Author: uschindler
Date: Mon Aug 20 14:39:44 2012
New Revision: 1375040

URL: http://svn.apache.org/viewvc?rev=1375040&view=rev
Log:
LUCENE-3312: Applied Javadocs fix from lucene-3312-patch-14.patch

Modified:
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/GeneralField.java
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/IndexDocument.java
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableField.java
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableFieldType.java
    lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StoredDocument.java

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/GeneralField.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/GeneralField.java?rev=1375040&r1=1375039&r2=1375040&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/GeneralField.java (original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/GeneralField.java Mon Aug 20 14:39:44 2012
@@ -17,6 +17,11 @@ package org.apache.lucene.index;
  * limitations under the License.
  */
 
+/** Represents a single field in lucene document. Further generalizations
+ * are {@link IndexableField} and {@link StorableField} interfaces.  
+ *
+ *  @lucene.experimental */
+
 public interface GeneralField {
 
   /** Field name */

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/IndexDocument.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/IndexDocument.java?rev=1375040&r1=1375039&r2=1375040&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/IndexDocument.java (original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/IndexDocument.java Mon Aug 20 14:39:44 2012
@@ -18,6 +18,7 @@ package org.apache.lucene.index;
  */
 
 /**
+ * Elementary interface used for indexing an document.
  * @lucene.internal
  */
 public interface IndexDocument {

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableField.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableField.java?rev=1375040&r1=1375039&r2=1375040&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableField.java (original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableField.java Mon Aug 20 14:39:44 2012
@@ -21,6 +21,11 @@ import java.io.Reader;
 
 import org.apache.lucene.util.BytesRef;
 
+/** Represents a single stored field in lucene document. These fields
+ * are contained in document retrieved from IndexReader.
+ *
+ *  @lucene.experimental */
+
 public interface StorableField extends GeneralField {
 
   /** Non-null if this field has a binary value */

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableFieldType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableFieldType.java?rev=1375040&r1=1375039&r2=1375040&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableFieldType.java (original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StorableFieldType.java Mon Aug 20 14:39:44 2012
@@ -17,6 +17,12 @@ package org.apache.lucene.index;
  * limitations under the License.
  */
 
+// TODO: Move some properties from IndexableFieldType here, those regarding stored fields. 
+
+/** 
+ * Describes the properties of a stored field.
+ * @lucene.experimental 
+ */
 public interface StorableFieldType {
 
   /** DocValues type; if non-null then the field's value

Modified: lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StoredDocument.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StoredDocument.java?rev=1375040&r1=1375039&r2=1375040&view=diff
==============================================================================
--- lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StoredDocument.java (original)
+++ lucene/dev/branches/lucene3312/lucene/core/src/java/org/apache/lucene/index/StoredDocument.java Mon Aug 20 14:39:44 2012
@@ -30,8 +30,12 @@ import org.apache.lucene.document.FloatF
 import org.apache.lucene.document.IntField;
 import org.apache.lucene.document.LongField;
 import org.apache.lucene.search.IndexSearcher;
+import org.apache.lucene.search.ScoreDoc;
 import org.apache.lucene.util.BytesRef;
 
+/** 
+* StoredDocument is retrieved from IndexReader containing only stored fields from indexed {@link IndexDocument}.
+*/
 public class StoredDocument implements Iterable<StorableField>{
   
   private final List<StorableField> fields = new ArrayList<StorableField>();