You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by kw...@apache.org on 2016/04/04 22:49:30 UTC
[4/7] lucene-solr:branch_6x: LUCENE-7157: Fix up javadoc
LUCENE-7157: Fix up javadoc
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/e509eb68
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/e509eb68
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/e509eb68
Branch: refs/heads/branch_6x
Commit: e509eb6851f2fa8a9ae163073c0491e4895dfe8e
Parents: 882d1d4
Author: Karl Wright <Da...@gmail.com>
Authored: Mon Apr 4 13:43:46 2016 -0400
Committer: Karl Wright <Da...@gmail.com>
Committed: Mon Apr 4 15:55:39 2016 -0400
----------------------------------------------------------------------
.../spatial3d/geom/GeoConcavePolygon.java | 1 +
.../lucene/spatial3d/geom/GeoConvexPolygon.java | 1 +
.../spatial3d/geom/GeoPolygonFactory.java | 34 ++++++++++++++++++--
3 files changed, 34 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e509eb68/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConcavePolygon.java
----------------------------------------------------------------------
diff --git a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConcavePolygon.java b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConcavePolygon.java
index 7069e38..375ec60 100644
--- a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConcavePolygon.java
+++ b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConcavePolygon.java
@@ -295,6 +295,7 @@ class GeoConcavePolygon extends GeoBasePolygon {
protected final SidedPlane exception;
/** Constructor.
+ * @param exception is the one plane to exclude from the check.
*/
public EitherBound(final SidedPlane exception) {
this.exception = exception;
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e509eb68/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConvexPolygon.java
----------------------------------------------------------------------
diff --git a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConvexPolygon.java b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConvexPolygon.java
index 502af3f..0a48eeb 100755
--- a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConvexPolygon.java
+++ b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoConvexPolygon.java
@@ -281,6 +281,7 @@ class GeoConvexPolygon extends GeoBasePolygon {
protected final SidedPlane exception;
/** Constructor.
+ * @param exception is the one plane to exclude from the check.
*/
public EitherBound(final SidedPlane exception) {
this.exception = exception;
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e509eb68/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoPolygonFactory.java
----------------------------------------------------------------------
diff --git a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoPolygonFactory.java b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoPolygonFactory.java
index d8040de..d2d71b3 100755
--- a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoPolygonFactory.java
+++ b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoPolygonFactory.java
@@ -741,7 +741,14 @@ public class GeoPolygonFactory {
protected final Set<Edge> edges = new HashSet<>();
protected final Map<Edge, Edge> previousEdges = new HashMap<>();
protected final Map<Edge, Edge> nextEdges = new HashMap<>();
-
+
+ /** Constructor.
+ * @param pointList is the list of points.
+ * @param startPlaneStartIndex is the index of the startPlane's starting point
+ * @param startPlaneEndIndex is the index of the startPlane's ending point
+ * @param startPlane is the starting plane
+ * @param startPlaneIsInternal signals whether the startPlane is an internal edge
+ */
public EdgeBuffer(final List<GeoPoint> pointList, final int startPlaneStartIndex, final int startPlaneEndIndex, final SidedPlane startPlane, final boolean startPlaneIsInternal) {
/*
System.out.println("Initial points:");
@@ -832,14 +839,26 @@ public class GeoPolygonFactory {
}
*/
+ /** Get the previous edge.
+ * @param currentEdge is the current edge.
+ * @return the previous edge, if found.
+ */
public Edge getPrevious(final Edge currentEdge) {
return previousEdges.get(currentEdge);
}
+ /** Get the next edge.
+ * @param currentEdge is the current edge.
+ * @return the next edge, if found.
+ */
public Edge getNext(final Edge currentEdge) {
return nextEdges.get(currentEdge);
}
+ /** Replace a list of edges with a new edge.
+ * @param removeList is the list of edges to remove.
+ * @param newEdge is the edge to add.
+ */
public void replace(final List<Edge> removeList, final Edge newEdge) {
/*
System.out.println("Replacing: ");
@@ -865,7 +884,9 @@ public class GeoPolygonFactory {
}
//verify();
}
-
+
+ /** Clear all edges.
+ */
public void clear() {
edges.clear();
previousEdges.clear();
@@ -873,14 +894,23 @@ public class GeoPolygonFactory {
oneEdge = null;
}
+ /** Get the size of the edge buffer.
+ * @return the size.
+ */
public int size() {
return edges.size();
}
+ /** Get an iterator to iterate over edges.
+ * @return the iterator.
+ */
public Iterator<Edge> iterator() {
return new EdgeBufferIterator(this);
}
+ /** Return a first edge.
+ * @return the edge.
+ */
public Edge pickOne() {
return oneEdge;
}