You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2018/07/20 10:33:34 UTC
[commons-geometry] 03/09: GEOMETRY-4: fixing javadoc issues;
mvn site now succeeds
This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
commit 7b1e6ab4da8aac329d28045846722b6cbca1888e
Author: Matt Juntunen <ma...@hotmail.com>
AuthorDate: Mon Jun 4 22:22:07 2018 -0400
GEOMETRY-4: fixing javadoc issues; mvn site now succeeds
---
.../core/partitioning/AbstractSubHyperplane.java | 2 +-
.../commons/geometry/core/partitioning/Embedding.java | 12 ++++--------
.../commons/geometry/core/partitioning/Hyperplane.java | 4 ++--
.../commons/geometry/core/partitioning/package-info.java | 6 +++---
.../apache/commons/geometry/enclosing/EnclosingBall.java | 1 -
.../apache/commons/geometry/euclidean/oned/Point1D.java | 8 ++++----
.../commons/geometry/euclidean/threed/Rotation.java | 4 ++--
.../geometry/euclidean/threed/RotationConvention.java | 16 ++++++++--------
.../commons/geometry/euclidean/threed/Vector3D.java | 8 +++-----
.../apache/commons/geometry/euclidean/twod/Vector2D.java | 4 ++--
.../twod/hull/AbstractConvexHullGenerator2D.java | 2 +-
.../geometry/euclidean/twod/hull/ConvexHull2D.java | 2 +-
.../euclidean/twod/hull/ConvexHullGenerator2D.java | 2 +-
.../geometry/euclidean/twod/hull/MonotoneChain.java | 2 +-
.../geometry/euclidean/twod/hull/package-info.java | 2 +-
.../apache/commons/geometry/spherical/oned/ArcsSet.java | 6 +++---
.../commons/geometry/spherical/oned/LimitAngle.java | 4 ++--
.../apache/commons/geometry/spherical/oned/S1Point.java | 4 ++--
.../apache/commons/geometry/spherical/twod/Circle.java | 10 +++++-----
.../apache/commons/geometry/spherical/twod/S2Point.java | 6 +++---
.../geometry/spherical/twod/SphericalPolygonsSet.java | 6 +++---
21 files changed, 52 insertions(+), 59 deletions(-)
diff --git a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/AbstractSubHyperplane.java b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/AbstractSubHyperplane.java
index 6c07722..c8dfad1 100644
--- a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/AbstractSubHyperplane.java
+++ b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/AbstractSubHyperplane.java
@@ -77,7 +77,7 @@ public abstract class AbstractSubHyperplane<P extends Point<P>, S extends Point<
/** Get the remaining region of the hyperplane.
* <p>The returned region is expressed in the canonical hyperplane
* frame and has the hyperplane dimension. For example a chopped
- * hyperplane in the 3D euclidean is a 2D plane and the
+ * hyperplane in the 3D Euclidean is a 2D plane and the
* corresponding region is a convex 2D polygon.</p>
* @return remaining region of the hyperplane
*/
diff --git a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Embedding.java b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Embedding.java
index f4ebd50..dfc40bf 100644
--- a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Embedding.java
+++ b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Embedding.java
@@ -23,19 +23,15 @@ import org.apache.commons.geometry.core.Point;
* <p>Sub-spaces are the lower dimensions subsets of a n-dimensions
* space. The (n-1)-dimension sub-spaces are specific sub-spaces known
* as {@link Hyperplane hyperplanes}. This interface can be used regardless
- * of the dimensions differences. As an example, {@link
- * org.apache.commons.geometry.euclidean.threed.Line Line} in 3D
- * implements Embedding<{@link
- * org.apache.commons.geometry.euclidean.threed.Point3D Point3D}, {@link
- * org.apache.commons.geometry.euclidean.oned.Point1D Point1D}>, i.e. it
- * maps directly dimensions 3 and 1.</p>
+ * of the dimensions differences. For example, a line in 3D Euclidean space
+ * can map directly from 3 dimensions to 1.</p>
- * <p>In the 3D euclidean space, hyperplanes are 2D planes, and the 1D
+ * <p>In the 3D Euclidean space, hyperplanes are 2D planes, and the 1D
* sub-spaces are lines.</p>
* <p>
* Note that this interface is <em>not</em> intended to be implemented
- * by Apache Commons Math users, it is only intended to be implemented
+ * by Apache Commons Geometry users, it is only intended to be implemented
* within the library itself. New methods may be added even for minor
* versions, which breaks compatibility for external implementations.
* </p>
diff --git a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Hyperplane.java b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Hyperplane.java
index 9a29432..a8b0151 100644
--- a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Hyperplane.java
+++ b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/Hyperplane.java
@@ -24,8 +24,8 @@ import org.apache.commons.geometry.core.Point;
* partitioning is as cutters. Each partitioning node in a {@link
* BSPTree BSP tree} has a cut {@link SubHyperplane sub-hyperplane}
* which is either an hyperplane or a part of an hyperplane. In an
- * n-dimensions euclidean space, an hyperplane is an (n-1)-dimensions
- * hyperplane (for example a traditional plane in the 3D euclidean
+ * n-dimensions Euclidean space, an hyperplane is an (n-1)-dimensions
+ * hyperplane (for example a traditional plane in the 3D Euclidean
* space). They can be more exotic objects in specific fields, for
* example a circle on the surface of the unit sphere.</p>
diff --git a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/package-info.java b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/package-info.java
index c1a1208..cfb55c0 100644
--- a/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/package-info.java
+++ b/commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/package-info.java
@@ -19,7 +19,7 @@
* This package provides classes to implement Binary Space Partition trees.
*
* <p>
- * {@link org.apache.commons.geometry.partitioning.BSPTree BSP trees}
+ * {@link org.apache.commons.geometry.core.partitioning.BSPTree BSP trees}
* are an efficient way to represent parts of space and in particular
* polytopes (line segments in 1D, polygons in 2D and polyhedrons in 3D)
* and to operate on them. The main principle is to recursively subdivide
@@ -52,9 +52,9 @@
* single part, but by several convex ones. This is the property that
* allows BSP-trees to represent non-convex polytopes despites all parts
* are convex. The {@link
- * org.apache.commons.geometry.partitioning.Region Region} class is
+ * org.apache.commons.geometry.core.partitioning.Region Region} class is
* devoted to this representation, it is build on top of the {@link
- * org.apache.commons.geometry.partitioning.BSPTree BSPTree} class using
+ * org.apache.commons.geometry.core.partitioning.BSPTree BSPTree} class using
* boolean objects as the leaf nodes attributes to represent the
* inside/outside property of each leaf part, and also adds various
* methods dealing with boundaries (i.e. the separation between the
diff --git a/commons-geometry-enclosing/src/main/java/org/apache/commons/geometry/enclosing/EnclosingBall.java b/commons-geometry-enclosing/src/main/java/org/apache/commons/geometry/enclosing/EnclosingBall.java
index b7b4c99..0fb9224 100644
--- a/commons-geometry-enclosing/src/main/java/org/apache/commons/geometry/enclosing/EnclosingBall.java
+++ b/commons-geometry-enclosing/src/main/java/org/apache/commons/geometry/enclosing/EnclosingBall.java
@@ -22,7 +22,6 @@ import org.apache.commons.geometry.core.Point;
/** This class represents a ball enclosing some points.
* @param <P> Point type.
- * @see Space
* @see Point
* @see Encloser
*/
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Point1D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Point1D.java
index c6e6910..0d15c69 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Point1D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Point1D.java
@@ -201,7 +201,7 @@ public final class Point1D extends Cartesian1D implements EuclideanPoint<Point1D
* @param a scale factor for first coordinate
* @param c first coordinate
* @return point with coordinates calculated by {@code a * c}
- * @see {@link Vector1D#linearCombination(double, Vector1D)}
+ * @see Vector1D#linearCombination(double, Cartesian1D)
*/
public static Point1D vectorCombination(double a, Cartesian1D c) {
return new Point1D(a * c.getX());
@@ -226,7 +226,7 @@ public final class Point1D extends Cartesian1D implements EuclideanPoint<Point1D
* @param a2 scale factor for second coordinate
* @param c2 second coordinate
* @return point with coordinates calculated by {@code (a1 * c1) + (a2 * c2)}
- * @see {@link Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D)}
+ * @see Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D)
*/
public static Point1D vectorCombination(double a1, Cartesian1D c1, double a2, Cartesian1D c2) {
return new Point1D(
@@ -254,7 +254,7 @@ public final class Point1D extends Cartesian1D implements EuclideanPoint<Point1D
* @param a3 scale factor for third coordinate
* @param c3 third coordinate
* @return point with coordinates calculated by {@code (a1 * c1) + (a2 * c2) + (a3 * c3)}
- * @see {@link Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D, double, Cartesian1D)}
+ * @see Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D, double, Cartesian1D)
*/
public static Point1D vectorCombination(double a1, Cartesian1D c1, double a2, Cartesian1D c2,
double a3, Cartesian1D c3) {
@@ -285,7 +285,7 @@ public final class Point1D extends Cartesian1D implements EuclideanPoint<Point1D
* @param a4 scale factor for fourth coordinate
* @param c4 fourth coordinate
* @return point with coordinates calculated by {@code (a1 * c1) + (a2 * c2) + (a3 * c3) + (a4 * c4)}
- * @see {@link Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D, double, Cartesian1D, double, Cartesian1D)}
+ * @see Vector1D#linearCombination(double, Cartesian1D, double, Cartesian1D, double, Cartesian1D, double, Cartesian1D)
*/
public static Point1D vectorCombination(double a1, Cartesian1D c1, double a2, Cartesian1D c2,
double a3, Cartesian1D c3, double a4, Cartesian1D c4) {
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Rotation.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Rotation.java
index 931be75..a24129c 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Rotation.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Rotation.java
@@ -68,8 +68,8 @@ import org.apache.commons.numbers.arrays.LinearCombination;
* class does not push the user towards one specific definition and hence does not
* provide methods like <code>projectVectorIntoDestinationFrame</code> or
* <code>computeTransformedDirection</code>. It provides simpler and more generic
- * methods: {@link #applyTo(Vector3D) applyTo(Cartesian3D)} and {@link
- * #applyInverseTo(Vector3D) applyInverseTo(Cartesian3D)}.</p>
+ * methods: {@link #applyTo(Vector3D) applyTo(Vector3D)} and {@link
+ * #applyInverseTo(Vector3D) applyInverseTo(Vector3D)}.</p>
*
* <p>Since a rotation is basically a vectorial operator, several rotations can be
* composed together and the composite operation <code>r = r<sub>1</sub> o
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RotationConvention.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RotationConvention.java
index 53766ce..25abc95 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RotationConvention.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RotationConvention.java
@@ -30,10 +30,10 @@ public enum RotationConvention {
* </p>
* <p>
* This means that if we define rotation r is a 90 degrees rotation around
- * the Z axis, the image of vector {@link Cartesian3D#PLUS_I} would be
- * {@link Cartesian3D#PLUS_J}, the image of vector {@link Cartesian3D#PLUS_J}
- * would be {@link Cartesian3D#MINUS_I}, the image of vector {@link Cartesian3D#PLUS_K}
- * would be {@link Cartesian3D#PLUS_K}, and the image of vector with coordinates (1, 2, 3)
+ * the Z axis, the image of vector {@link Vector3D#PLUS_X} would be
+ * {@link Vector3D#PLUS_Y}, the image of vector {@link Vector3D#PLUS_Y}
+ * would be {@link Vector3D#MINUS_X}, the image of vector {@link Vector3D#PLUS_Z}
+ * would be {@link Vector3D#PLUS_Z}, and the image of vector with coordinates (1, 2, 3)
* would be vector (-2, 1, 3). This means that the vector rotates counterclockwise.
* </p>
* <p>
@@ -57,10 +57,10 @@ public enum RotationConvention {
* </p>
* <p>
* This means that if we define rotation r is a 90 degrees rotation around
- * the Z axis, the image of vector {@link Cartesian3D#PLUS_I} would be
- * {@link Cartesian3D#MINUS_J}, the image of vector {@link Cartesian3D#PLUS_J}
- * would be {@link Cartesian3D#PLUS_I}, the image of vector {@link Cartesian3D#PLUS_K}
- * would be {@link Cartesian3D#PLUS_K}, and the image of vector with coordinates (1, 2, 3)
+ * the Z axis, the image of vector {@link Vector3D#PLUS_X} would be
+ * {@link Vector3D#MINUS_Y}, the image of vector {@link Vector3D#PLUS_Y}
+ * would be {@link Vector3D#PLUS_X}, the image of vector {@link Vector3D#PLUS_Z}
+ * would be {@link Vector3D#PLUS_Z}, and the image of vector with coordinates (1, 2, 3)
* would be vector (2, -1, 3). This means that the coordinates of the vector rotates
* clockwise, because they are expressed with respect to a destination frame that is rotated
* counterclockwise.
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
index 85246ab..8e8e152 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
@@ -393,7 +393,7 @@ public final class Vector3D extends Cartesian3D implements EuclideanVector<Point
* @param v1 first vector
* @param v2 second vector
* @return the dot product
- * @see {@link #dotProduct(Vector3D)}
+ * @see #dotProduct(Vector3D)
*/
public static double dotProduct(Vector3D v1, Vector3D v2) {
return v1.dotProduct(v2);
@@ -404,7 +404,7 @@ public final class Vector3D extends Cartesian3D implements EuclideanVector<Point
* @param v1 first vector
* @param v2 second vector
* @return the angle between the vectors in radians
- * @see {@link #angle(Vector3D)}
+ * @see #angle(Vector3D)
*/
public static double angle(Vector3D v1, Vector3D v2) {
return v1.angle(v2);
@@ -415,7 +415,7 @@ public final class Vector3D extends Cartesian3D implements EuclideanVector<Point
* @param v1 first vector
* @param v2 second vector
* @return the computed cross product vector
- * @see {@link #crossProduct(Vector3D)}
+ * @see #crossProduct(Vector3D)
*/
public static Vector3D crossProduct(Vector3D v1, Vector3D v2) {
return v1.crossProduct(v2);
@@ -457,8 +457,6 @@ public final class Vector3D extends Cartesian3D implements EuclideanVector<Point
* @param delta elevation (δ) above (XY) plane, from -π/2 to +π/2
* @see #getAlpha()
* @see #getDelta()
- * @param alpha
- * @param delta
* @return new vector instance with the given azimuthal coordinates
*/
public static Vector3D fromSpherical(double alpha, double delta) {
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
index e6285b1..c07155d 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
@@ -331,7 +331,7 @@ public final class Vector2D extends Cartesian2D implements EuclideanVector<Point
* @param v1 first vector
* @param v2 second vector
* @return the dot product
- * @see {@link #dotProduct(Vector2D)}
+ * @see #dotProduct(Vector2D)
*/
public static double dotProduct(Vector2D v1, Vector2D v2) {
return v1.dotProduct(v2);
@@ -342,7 +342,7 @@ public final class Vector2D extends Cartesian2D implements EuclideanVector<Point
* @param v1 first vector
* @param v2 second vector
* @return the angle between the vectors in radians
- * @see {@link #angle(Vector2D)}
+ * @see #angle(Vector2D)
*/
public static double angle(Vector2D v1, Vector2D v2) {
return v1.angle(v2);
diff --git a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/AbstractConvexHullGenerator2D.java b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/AbstractConvexHullGenerator2D.java
index 14b8548..3678bf0 100644
--- a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/AbstractConvexHullGenerator2D.java
+++ b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/AbstractConvexHullGenerator2D.java
@@ -21,7 +21,7 @@ import java.util.Collection;
import org.apache.commons.geometry.euclidean.twod.Point2D;
/**
- * Abstract base class for convex hull generators in the two-dimensional euclidean space.
+ * Abstract base class for convex hull generators in the two-dimensional Euclidean space.
*/
abstract class AbstractConvexHullGenerator2D implements ConvexHullGenerator2D {
diff --git a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHull2D.java b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHull2D.java
index ce0230e..242de67 100644
--- a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHull2D.java
+++ b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHull2D.java
@@ -29,7 +29,7 @@ import org.apache.commons.numbers.arrays.LinearCombination;
import org.apache.commons.numbers.core.Precision;
/**
- * This class represents a convex hull in an two-dimensional euclidean space.
+ * This class represents a convex hull in an two-dimensional Euclidean space.
*/
public class ConvexHull2D implements ConvexHull<Point2D>, Serializable {
diff --git a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHullGenerator2D.java b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHullGenerator2D.java
index 43a45b6..8c3dde4 100644
--- a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHullGenerator2D.java
+++ b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/ConvexHullGenerator2D.java
@@ -22,7 +22,7 @@ import org.apache.commons.geometry.euclidean.twod.Point2D;
import org.apache.commons.geometry.hull.ConvexHullGenerator;
/**
- * Interface for convex hull generators in the two-dimensional euclidean space.
+ * Interface for convex hull generators in the two-dimensional Euclidean space.
*/
public interface ConvexHullGenerator2D extends ConvexHullGenerator<Point2D> {
diff --git a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/MonotoneChain.java b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/MonotoneChain.java
index a47cb1f..b480350 100644
--- a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/MonotoneChain.java
+++ b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/MonotoneChain.java
@@ -28,7 +28,7 @@ import org.apache.commons.numbers.core.Precision;
/**
* Implements Andrew's monotone chain method to generate the convex hull of a finite set of
- * points in the two-dimensional euclidean space.
+ * points in the two-dimensional Euclidean space.
* <p>
* The runtime complexity is O(n log n), with n being the number of input points. If the
* point set is already sorted (by x-coordinate), the runtime complexity is O(n).
diff --git a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/package-info.java b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/package-info.java
index 0139107..86b304c 100644
--- a/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/package-info.java
+++ b/commons-geometry-hull/src/main/java/org/apache/commons/geometry/euclidean/twod/hull/package-info.java
@@ -18,7 +18,7 @@
*
* <p>
* This package provides algorithms to generate the convex hull
- * for a set of points in an two-dimensional euclidean space.
+ * for a set of points in an two-dimensional Euclidean space.
* </p>
*
*/
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/ArcsSet.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/ArcsSet.java
index 676a88b..813dae9 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/ArcsSet.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/ArcsSet.java
@@ -36,7 +36,7 @@ import org.apache.commons.numbers.core.Precision;
* Note that due to the wrapping around \(2 \pi\), barycenter is
* ill-defined here. It was defined only in order to fulfill
* the requirements of the {@link
- * org.apache.commons.geometry.partitioning.Region Region}
+ * org.apache.commons.geometry.core.partitioning.Region Region}
* interface, but its use is discouraged.
* </p>
*/
@@ -101,7 +101,7 @@ public class ArcsSet extends AbstractRegion<S1Point, S1Point> implements Iterabl
* boundary does not really separate an inside open from an outside
* open (open having here its topological meaning), then subsequent
* calls to the {@link
- * org.apache.commons.geometry.partitioning.Region#checkPoint(org.apache.commons.geometry.Point)
+ * org.apache.commons.geometry.core.partitioning.Region#checkPoint(org.apache.commons.geometry.core.Point)
* checkPoint} method will not be meaningful anymore.</p>
* <p>If the boundary is empty, the region will represent the whole
* space.</p>
@@ -932,7 +932,7 @@ public class ArcsSet extends AbstractRegion<S1Point, S1Point> implements Iterabl
/** Specialized exception for inconsistent BSP tree state inconsistency.
* <p>
* This exception is thrown at {@link ArcsSet} construction time when the
- * {@link org.apache.commons.geometry.partitioning.Region.Location inside/outside}
+ * {@link org.apache.commons.geometry.core.partitioning.Region.Location inside/outside}
* state is not consistent at the 0, \(2 \pi \) crossing.
* </p>
*/
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/LimitAngle.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/LimitAngle.java
index fd488c7..bc80a21 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/LimitAngle.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/LimitAngle.java
@@ -83,9 +83,9 @@ public class LimitAngle implements Hyperplane<S1Point> {
* <p>Since this class represent zero dimension spaces which does
* not have lower dimension sub-spaces, this method returns a dummy
* implementation of a {@link
- * org.apache.commons.geometry.partitioning.SubHyperplane SubHyperplane}.
+ * org.apache.commons.geometry.core.partitioning.SubHyperplane SubHyperplane}.
* This implementation is only used to allow the {@link
- * org.apache.commons.geometry.partitioning.SubHyperplane
+ * org.apache.commons.geometry.core.partitioning.SubHyperplane
* SubHyperplane} class implementation to work properly, it should
* <em>not</em> be used otherwise.</p>
* @return a dummy sub hyperplane
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/S1Point.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/S1Point.java
index 7cced20..fdabb13 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/S1Point.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/oned/S1Point.java
@@ -64,13 +64,13 @@ public final class S1Point implements Point<S1Point>, Serializable {
/** Get the azimuthal angle in radians \( \alpha \).
* @return azimuthal angle \( \alpha \)
- * @see #S1Point(double)
+ * @see S1Point#of(double)
*/
public double getAlpha() {
return alpha;
}
- /** Get the corresponding normalized vector in the 2D euclidean space.
+ /** Get the corresponding normalized vector in the 2D Euclidean space.
* @return normalized vector
*/
public Vector2D getVector() {
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/Circle.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/Circle.java
index 3b017ca..31cc5c9 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/Circle.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/Circle.java
@@ -142,7 +142,7 @@ public class Circle implements Hyperplane<S2Point>, Embedding<S2Point, S1Point>
}
/** {@inheritDoc}
- * @see #getPhase(Cartesian3D)
+ * @see #getPhase(Vector3D)
*/
@Override
public S1Point toSubSpace(final S2Point point) {
@@ -251,7 +251,7 @@ public class Circle implements Hyperplane<S2Point>, Embedding<S2Point, S1Point>
}
/** {@inheritDoc}
- * @see #getOffset(Cartesian3D)
+ * @see #getOffset(Vector3D)
*/
@Override
public double getOffset(final S2Point point) {
@@ -278,12 +278,12 @@ public class Circle implements Hyperplane<S2Point>, Embedding<S2Point, S1Point>
return pole.dotProduct(otherC.pole) >= 0.0;
}
- /** Get a {@link org.apache.commons.geometry.partitioning.Transform
+ /** Get a {@link org.apache.commons.geometry.core.partitioning.Transform
* Transform} embedding a 3D rotation.
* @param rotation rotation to use
* @return a new transform that can be applied to either {@link
- * Point Point}, {@link Circle Line} or {@link
- * org.apache.commons.geometry.partitioning.SubHyperplane
+ * S2Point Point}, {@link Circle Line} or {@link
+ * org.apache.commons.geometry.core.partitioning.SubHyperplane
* SubHyperplane} instances
*/
public static Transform<S2Point, S1Point> getTransform(final Rotation rotation) {
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/S2Point.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/S2Point.java
index f8d3f4e..93cec93 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/S2Point.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/S2Point.java
@@ -93,7 +93,7 @@ public final class S2Point implements Point<S2Point>, Serializable {
/** Get the azimuthal angle \( \theta \) in the x-y plane.
* @return azimuthal angle \( \theta \) in the x-y plane
- * @see #S2Point(double, double)
+ * @see S2Point#of(double, double)
*/
public double getTheta() {
return theta;
@@ -101,13 +101,13 @@ public final class S2Point implements Point<S2Point>, Serializable {
/** Get the polar angle \( \varphi \).
* @return polar angle \( \varphi \)
- * @see #S2Point(double, double)
+ * @see S2Point#of(double, double)
*/
public double getPhi() {
return phi;
}
- /** Get the corresponding normalized vector in the 3D euclidean space.
+ /** Get the corresponding normalized vector in the 3D Euclidean space.
* @return normalized vector
*/
public Vector3D getVector() {
diff --git a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/SphericalPolygonsSet.java b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/SphericalPolygonsSet.java
index d9e3eeb..b1b6b50 100644
--- a/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/SphericalPolygonsSet.java
+++ b/commons-geometry-spherical/src/main/java/org/apache/commons/geometry/spherical/twod/SphericalPolygonsSet.java
@@ -103,7 +103,7 @@ public class SphericalPolygonsSet extends AbstractRegion<S2Point, S1Point> {
* boundary does not really separate an inside open from an outside
* open (open having here its topological meaning), then subsequent
* calls to the {@link
- * org.apache.commons.geometry.partitioning.Region#checkPoint(org.apache.commons.geometry.Point)
+ * org.apache.commons.geometry.core.partitioning.Region#checkPoint(org.apache.commons.geometry.core.Point)
* checkPoint} method will not be meaningful anymore.</p>
* <p>If the boundary is empty, the region will represent the whole
* space.</p>
@@ -420,7 +420,7 @@ public class SphericalPolygonsSet extends AbstractRegion<S2Point, S1Point> {
* <p>
* This method is intended as a first test to quickly identify points
* that are guaranteed to be outside of the region, hence performing a full
- * {@link #checkPoint(org.apache.commons.geometry.Point) checkPoint}
+ * {@link #checkPoint(org.apache.commons.geometry.core.Point) checkPoint}
* only if the point status remains undecided after the quick check. It is
* is therefore mostly useful to speed up computation for small polygons with
* complex shapes (say a country boundary on Earth), as the spherical cap will
@@ -455,7 +455,7 @@ public class SphericalPolygonsSet extends AbstractRegion<S2Point, S1Point> {
* In the special cases of empty or whole sphere polygons, special
* spherical caps are returned, with angular radius set to negative
* or positive infinity so the {@link
- * EnclosingBall#contains(org.apache.commons.geometry.Point) ball.contains(point)}
+ * EnclosingBall#contains(org.apache.commons.geometry.core.Point) ball.contains(point)}
* method return always false or true.
* </p>
* <p>