Return-Path: X-Original-To: apmail-lucene-commits-archive@www.apache.org Delivered-To: apmail-lucene-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 77ED618012 for ; Mon, 4 Apr 2016 18:58:26 +0000 (UTC) Received: (qmail 64077 invoked by uid 500); 4 Apr 2016 18:58:26 -0000 Mailing-List: contact commits-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@lucene.apache.org Delivered-To: mailing list commits@lucene.apache.org Received: (qmail 64066 invoked by uid 99); 4 Apr 2016 18:58:26 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 04 Apr 2016 18:58:26 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 266E7DFE2E; Mon, 4 Apr 2016 18:58:26 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: kwright@apache.org To: commits@lucene.apache.org Date: Mon, 04 Apr 2016 18:58:26 -0000 Message-Id: <6f7006ae23fa4d268ceeb0560d9689cf@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [1/4] lucene-solr:master: LUCENE-7157: Fix up javadoc Repository: lucene-solr Updated Branches: refs/heads/master c1a3e1b8d -> 9bef6c000 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/c2c68ece Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/c2c68ece Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/c2c68ece Branch: refs/heads/master Commit: c2c68ece23df8248d59b3db9798e19c7692174b0 Parents: c1a3e1b Author: Karl Wright Authored: Mon Apr 4 13:43:46 2016 -0400 Committer: Karl Wright Committed: Mon Apr 4 13:43:46 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/c2c68ece/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/c2c68ece/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/c2c68ece/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 edges = new HashSet<>(); protected final Map previousEdges = new HashMap<>(); protected final Map 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 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 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 iterator() { return new EdgeBufferIterator(this); } + /** Return a first edge. + * @return the edge. + */ public Edge pickOne() { return oneEdge; }