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:33 UTC

[7/7] lucene-solr:branch_6x: LUCENE-7157: More javadoc fixes

LUCENE-7157: More javadoc fixes


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/974dc158
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/974dc158
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/974dc158

Branch: refs/heads/branch_6x
Commit: 974dc158e4511310c756df9a55c7f36ea773be19
Parents: 76f9e55
Author: Karl Wright <Da...@gmail.com>
Authored: Mon Apr 4 14:51:28 2016 -0400
Committer: Karl Wright <Da...@gmail.com>
Committed: Mon Apr 4 15:56:45 2016 -0400

----------------------------------------------------------------------
 .../spatial3d/geom/GeoPolygonFactory.java       | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/974dc158/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 847f170..83c95b6 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
@@ -236,6 +236,14 @@ public class GeoPolygonFactory {
     return arcDistance > 0.0;
   }
   
+  /** Compute the angle for a point given rotation information.
+    * @param point is the point to assess
+    * @param sinLatitude the sine of the latitude
+    * @param cosLatitude the cosine of the latitude
+    * @param sinLongitude the sine of the longitude
+    * @param cosLongitude the cosine of the longitude
+    * @return the angle of rotation, or null if not computable
+    */
   protected static Double computeAngle(final GeoPoint point,
     final double sinLatitude,
     final double cosLatitude,
@@ -638,6 +646,13 @@ public class GeoPolygonFactory {
     return true;
   }
   
+  /** Check if a point is within a set of edges.
+    * @param point is the point
+    * @param edgeSet is the set of edges
+    * @param extension is the new edge
+    * @param returnBoundary is the return edge
+    * @return true if within
+    */
   protected static boolean isWithin(final GeoPoint point, final Set<Edge> edgeSet, final Edge extension, final SidedPlane returnBoundary) {
     if (!extension.plane.isWithin(point)) {
       return false;
@@ -648,6 +663,11 @@ public class GeoPolygonFactory {
     return isWithin(point, edgeSet);
   }
   
+  /** Check if a point is within a set of edges.
+    * @param point is the point
+    * @param edgeSet is the set of edges
+    * @return true if within
+    */
   protected static boolean isWithin(final GeoPoint point, final Set<Edge> edgeSet) {
     for (final Edge edge : edgeSet) {
       if (!edge.plane.isWithin(point)) {