You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2016/02/25 10:33:49 UTC
lucene-solr git commit: javadocs
Repository: lucene-solr
Updated Branches:
refs/heads/master de119f0b5 -> e901c6197
javadocs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/e901c619
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/e901c619
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/e901c619
Branch: refs/heads/master
Commit: e901c61973271d9fc0e47fd397a5dcde68ff0217
Parents: de119f0
Author: Robert Muir <rm...@apache.org>
Authored: Thu Feb 25 04:34:59 2016 -0500
Committer: Robert Muir <rm...@apache.org>
Committed: Thu Feb 25 04:34:59 2016 -0500
----------------------------------------------------------------------
.../core/src/java/org/apache/lucene/document/BinaryPoint.java | 7 ++++---
.../apache/lucene/document/DocumentStoredFieldVisitor.java | 7 ++++---
.../core/src/java/org/apache/lucene/document/DoublePoint.java | 7 ++++---
.../core/src/java/org/apache/lucene/document/FloatPoint.java | 7 ++++---
lucene/core/src/java/org/apache/lucene/document/IntPoint.java | 7 ++++---
.../core/src/java/org/apache/lucene/document/LongPoint.java | 7 ++++---
.../core/src/java/org/apache/lucene/document/StoredField.java | 4 +---
.../src/java/org/apache/lucene/document/BigIntegerPoint.java | 7 ++++---
.../src/java/org/apache/lucene/document/InetAddressPoint.java | 5 +++--
.../src/java/org/apache/lucene/document/LatLonPoint.java | 5 +++--
10 files changed, 35 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java b/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
index 6a3cb85..201001a 100644
--- a/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/BinaryPoint.java
@@ -21,9 +21,10 @@ import org.apache.lucene.search.Query;
import org.apache.lucene.util.BytesRef;
/**
- * A binary field that is indexed dimensionally such that finding
- * all documents within an N-dimensional shape or range at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed binary field.
+ * <p>
+ * Finding all documents within an N-dimensional shape or range at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
----------------------------------------------------------------------
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 2762701..ed4d0aa 100644
--- a/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
+++ b/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
@@ -16,7 +16,6 @@
*/
package org.apache.lucene.document;
-
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.HashSet;
@@ -27,8 +26,10 @@ import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.StoredFieldVisitor;
/** A {@link StoredFieldVisitor} that creates a {@link
- * Document} containing all stored fields, or only specific
- * requested fields provided to {@link #DocumentStoredFieldVisitor(Set)}.
+ * Document} from stored fields.
+ * <p>
+ * This visitor supports loading all stored fields, or only specific
+ * requested fields provided from a {@link Set}.
* <p>
* This is used by {@link IndexReader#document(int)} to load a
* document.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java b/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
index 7378288..fa0fbdc 100644
--- a/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/DoublePoint.java
@@ -22,9 +22,10 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
/**
- * A double field that is indexed dimensionally such that finding
- * all documents within an N-dimensional shape or range at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed {@code double} field.
+ * <p>
+ * Finding all documents within an N-dimensional shape or range at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java b/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
index ae7d207..ec37bc8 100644
--- a/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/FloatPoint.java
@@ -22,9 +22,10 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
/**
- * A float field that is indexed dimensionally such that finding
- * all documents within an N-dimensional at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed {@code float} field.
+ * <p>
+ * Finding all documents within an N-dimensional at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/IntPoint.java b/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
index 1d04b62..ec2e3cf 100644
--- a/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/IntPoint.java
@@ -22,9 +22,10 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
/**
- * An int field that is indexed dimensionally such that finding
- * all documents within an N-dimensional shape or range at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed {@code int} field.
+ * <p>
+ * Finding all documents within an N-dimensional shape or range at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/LongPoint.java b/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
index 7a7f16d..c2f774a 100644
--- a/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
+++ b/lucene/core/src/java/org/apache/lucene/document/LongPoint.java
@@ -22,9 +22,10 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
/**
- * A long field that is indexed dimensionally such that finding
- * all documents within an N-dimensional shape or range at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed {@code long} field.
+ * <p>
+ * Finding all documents within an N-dimensional shape or range at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/core/src/java/org/apache/lucene/document/StoredField.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/document/StoredField.java b/lucene/core/src/java/org/apache/lucene/document/StoredField.java
index 1faff36..12b529c 100644
--- a/lucene/core/src/java/org/apache/lucene/document/StoredField.java
+++ b/lucene/core/src/java/org/apache/lucene/document/StoredField.java
@@ -16,14 +16,12 @@
*/
package org.apache.lucene.document;
-
import org.apache.lucene.index.IndexReader; // javadocs
-import org.apache.lucene.index.IndexableField;
import org.apache.lucene.search.IndexSearcher; // javadocs
import org.apache.lucene.util.BytesRef;
/** A field whose value is stored so that {@link
- * IndexSearcher#doc} and {@link IndexReader#document} will
+ * IndexSearcher#doc} and {@link IndexReader#document IndexReader.document()} will
* return the field and its value. */
public class StoredField extends Field {
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/sandbox/src/java/org/apache/lucene/document/BigIntegerPoint.java
----------------------------------------------------------------------
diff --git a/lucene/sandbox/src/java/org/apache/lucene/document/BigIntegerPoint.java b/lucene/sandbox/src/java/org/apache/lucene/document/BigIntegerPoint.java
index 4716ada..b12f19f 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/document/BigIntegerPoint.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/document/BigIntegerPoint.java
@@ -24,9 +24,10 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
/**
- * A 128-bit integer field that is indexed dimensionally such that finding
- * all documents within an N-dimensional shape or range at search time is
- * efficient. Multiple values for the same field in one documents
+ * An indexed 128-bit {@code BigInteger} field.
+ * <p>
+ * Finding all documents within an N-dimensional shape or range at search time is
+ * efficient. Multiple values for the same field in one document
* is allowed.
* <p>
* This field defines static factory methods for creating common queries:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/sandbox/src/java/org/apache/lucene/document/InetAddressPoint.java
----------------------------------------------------------------------
diff --git a/lucene/sandbox/src/java/org/apache/lucene/document/InetAddressPoint.java b/lucene/sandbox/src/java/org/apache/lucene/document/InetAddressPoint.java
index d8892cc..4e5d699 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/document/InetAddressPoint.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/document/InetAddressPoint.java
@@ -24,8 +24,9 @@ import org.apache.lucene.search.Query;
import org.apache.lucene.util.BytesRef;
/**
- * A field indexing {@link InetAddress} dimensionally such that finding
- * all documents within a range at search time is
+ * An indexed 128-bit {@code InetAddress} field.
+ * <p>
+ * Finding all documents within a range at search time is
* efficient. Multiple values for the same field in one document
* is allowed.
* <p>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e901c619/lucene/sandbox/src/java/org/apache/lucene/document/LatLonPoint.java
----------------------------------------------------------------------
diff --git a/lucene/sandbox/src/java/org/apache/lucene/document/LatLonPoint.java b/lucene/sandbox/src/java/org/apache/lucene/document/LatLonPoint.java
index 6ce6a74..8b654c1 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/document/LatLonPoint.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/document/LatLonPoint.java
@@ -28,8 +28,9 @@ import org.apache.lucene.search.Query;
import org.apache.lucene.spatial.util.GeoUtils;
/**
- * A field indexing geographic coordinates dimensionally such that finding
- * all documents within a range at search time is
+ * An indexed location field.
+ * <p>
+ * Finding all documents within a range at search time is
* efficient. Multiple values for the same field in one document
* is allowed.
* <p>