This is an automated email from the ASF dual-hosted git repository. mattjuntunen pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
commit c619eeb94641648451a539dee027f396f9016926 Author: XenoAmess <[email protected]> AuthorDate: Sat Jul 4 00:44:00 2020 +0800 fix javadocs --- .../geometry/core/partitioning/bsp/MergeChecker.java | 4 ++-- .../core/partitioning/test/AttributeBSPTree.java | 4 ++-- .../apache/commons/geometry/euclidean/oned/Interval.java | 2 +- .../commons/geometry/euclidean/oned/RegionBSPTree1D.java | 4 ++-- .../apache/commons/geometry/euclidean/threed/Planes.java | 10 +++++----- .../geometry/euclidean/threed/RegionBSPTree3D.java | 4 ++-- .../euclidean/threed/VertexListConvexPolygon3D.java | 2 +- .../geometry/euclidean/threed/LinecastChecker3D.java | 16 ++++++++-------- .../threed/rotation/QuaternionRotationTest.java | 4 ++-- .../geometry/euclidean/twod/LinecastChecker2D.java | 10 +++++----- 10 files changed, 30 insertions(+), 30 deletions(-) diff --git a/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/bsp/MergeChecker.java b/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/bsp/MergeChecker.java index 939003c..13ff2c8 100644 --- a/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/bsp/MergeChecker.java +++ b/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/bsp/MergeChecker.java @@ -73,8 +73,8 @@ class MergeChecker { /** Construct a new instance that will verify the output of performing the given merge operation * on the input trees. - * @param tree1 first tree in the merge operation - * @param tree2 second tree in the merge operation + * @param tree1Factory first tree factory in the merge operation + * @param tree2Factory second tree factory in the merge operation * @param constOperation object that performs the merge operation in a form that * leaves both argument unmodified * @param inPlaceOperation object that performs the merge operation in a form diff --git a/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/test/AttributeBSPTree.java b/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/test/AttributeBSPTree.java index dfb52af..3b9adc3 100644 --- a/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/test/AttributeBSPTree.java +++ b/commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partitioning/test/AttributeBSPTree.java @@ -20,7 +20,7 @@ import org.apache.commons.geometry.core.Point; import org.apache.commons.geometry.core.partitioning.Hyperplane; import org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree; -/** Simple {@link BSPTree} implementation allowing arbitrary values to be +/** Simple {@link org.apache.commons.geometry.core.partitioning.bsp.BSPTree} implementation allowing arbitrary values to be * associated with each node. * @param <P> Point implementation type * @param <T> Tree node attribute type @@ -59,7 +59,7 @@ public class AttributeBSPTree<P extends Point<P>, T> dst.setAttribute(src.getAttribute()); } - /** {@link BSPTree.Node} implementation for use with {@link AttributeBSPTree}s. + /** {@link org.apache.commons.geometry.core.partitioning.bsp.BSPTree.Node} implementation for use with {@link AttributeBSPTree}s. * @param <P> Point implementation type * @param <T> Tree node attribute type */ diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Interval.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Interval.java index 19b56c9..bce3da4 100644 --- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Interval.java +++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Interval.java @@ -180,7 +180,7 @@ public final class Interval implements HyperplaneBoundedRegion<Vector1D> { * of the region. * @param x the location to test * @return true if the location is on the inside or boundary of the region - * @see #contains(Point) + * @see #contains(org.apache.commons.geometry.core.Point) */ public boolean contains(final double x) { return classify(x) != RegionLocation.OUTSIDE; diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/RegionBSPTree1D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/RegionBSPTree1D.java index cf15c4e..4726f0d 100644 --- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/RegionBSPTree1D.java +++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/RegionBSPTree1D.java @@ -75,7 +75,7 @@ public final class RegionBSPTree1D extends AbstractRegionBSPTree<Vector1D, Regio /** Classify a point location with respect to the region. * @param x the point to classify * @return the location of the point with respect to the region - * @see #classify(Point) + * @see #classify(Vector1D) */ public RegionLocation classify(final double x) { return classify(Vector1D.of(x)); @@ -85,7 +85,7 @@ public final class RegionBSPTree1D extends AbstractRegionBSPTree<Vector1D, Regio * of the region. * @param x the location to test * @return true if the location is on the inside or boundary of the region - * @see #contains(Point) + * @see #contains(org.apache.commons.geometry.core.Point) */ public boolean contains(final double x) { return contains(Vector1D.of(x)); diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Planes.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Planes.java index f0c5497..9b5007a 100644 --- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Planes.java +++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Planes.java @@ -653,7 +653,7 @@ public final class Planes { /** Build a plane from the configured point sequence. * @return a plane built from the configured point sequence - * @throw IllegalArgumentException if the points do not define a plane + * @throws IllegalArgumentException if the points do not define a plane */ Plane build() { if (pts.size() < 3) { @@ -669,7 +669,7 @@ public final class Planes { * and adding all discovered unique points to the given list. * @param vertexOutput list that unique points discovered in the point sequence will be added to * @return a plane created from the configured point sequence - * @throw IllegalArgumentException if the points do not define a plane or the {@code requireConvex} + * @throws IllegalArgumentException if the points do not define a plane or the {@code requireConvex} * flag is true and the points do not define a convex area */ Plane buildForConvexPolygon(final List<Vector3D> vertexOutput) { @@ -681,7 +681,7 @@ public final class Planes { /** Process a point from the point sequence. * @param pt - * @throw IllegalArgumentException if the points do not define a plane or the {@code requireConvex} + * @throws IllegalArgumentException if the points do not define a plane or the {@code requireConvex} * flag is true and the points do not define a convex area */ private void processPoint(final Vector3D pt) { @@ -712,7 +712,7 @@ public final class Planes { /** Process the computed cross product of two vectors from the input point sequence. The vectors * start at the first point in the sequence and point to adjacent points later in the sequence. * @param cross the cross product of two vectors from the input point sequence - * @throw IllegalArgumentException if the points do not define a plane or the {@code requireConvex} + * @throws IllegalArgumentException if the points do not define a plane or the {@code requireConvex} * flag is true and the points do not define a convex area */ private void processCrossProduct(final Vector3D cross) { @@ -743,7 +743,7 @@ public final class Planes { /** Construct the plane instance using the value gathered during point processing. * @return the created plane instance - * @throw IllegalArgumentException if the point do not define a plane + * @throws IllegalArgumentException if the point do not define a plane */ private Plane createPlane() { if (normal == null) { diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RegionBSPTree3D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RegionBSPTree3D.java index 93d273e..122b225 100644 --- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RegionBSPTree3D.java +++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/RegionBSPTree3D.java @@ -467,7 +467,7 @@ public final class RegionBSPTree3D extends AbstractRegionBSPTree<Vector3D, Regio * of each pyramid is calculated using the fact that it is located 3/4 of the way along the * line from the apex to the base. The region centroid then becomes the volume-weighted * average of these pyramid centers. - * @see https://en.wikipedia.org/wiki/Polyhedron#Volume + * @see <a href="https://en.wikipedia.org/wiki/Polyhedron#Volume";>Polyhedron#Volume</a> */ private static final class RegionSizePropertiesVisitor implements BSPTreeVisitor<Vector3D, RegionNode3D> { @@ -586,7 +586,7 @@ public final class RegionBSPTree3D extends AbstractRegionBSPTree<Vector3D, Regio this.firstOnly = firstOnly; } - /** Get the first {@link LinecastPoint2D} resulting from the linecast operation. + /** Get the first {@link org.apache.commons.geometry.euclidean.twod.LinecastPoint2D} resulting from the linecast operation. * @return the first linecast result point */ public LinecastPoint3D getFirstResult() { diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/VertexListConvexPolygon3D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/VertexListConvexPolygon3D.java index 18cdc02..f309cf0 100644 --- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/VertexListConvexPolygon3D.java +++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/VertexListConvexPolygon3D.java @@ -36,7 +36,7 @@ final class VertexListConvexPolygon3D extends AbstractConvexPolygon3D { * vertices should not contain the duplicated first endpoint. No validation is performed. * @param plane plane containing convex polygon * @param vertices vertices defining the convex polygon - * @throw IllegalArgumentException if fewer than 3 vertices are given + * @throws IllegalArgumentException if fewer than 3 vertices are given */ VertexListConvexPolygon3D(final Plane plane, final List<Vector3D> vertices) { super(plane); diff --git a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/LinecastChecker3D.java b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/LinecastChecker3D.java index 2aab6cb..ec8f2ac 100644 --- a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/LinecastChecker3D.java +++ b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/LinecastChecker3D.java @@ -51,8 +51,8 @@ class LinecastChecker3D { } /** Configure the instance to expect no results (an empty list from linecast() and null from - * linecastFirst()) from the next linecast operation performed by {@link #whenGiven(Line)} - * or {@link #whenGiven(Segment)}. + * linecastFirst()) from the next linecast operation performed by {@link #whenGiven(Line3D)} + * or {@link #whenGiven(LineConvexSubset3D)}. * @return */ public LinecastChecker3D expectNothing() { @@ -74,7 +74,7 @@ class LinecastChecker3D { return this; } - /** Fluent API alias for {@link #returns(Vector3D, Vector3D)}. + /** Fluent API alias for {@link #expect(Vector3D, Vector3D)}. * @param point * @param normal * @return @@ -83,7 +83,7 @@ class LinecastChecker3D { return expect(point, normal); } - /** Perform {@link Linecastable2D#linecast(Line)} and {@link Linecastable2D#linecastFirst(Line)} + /** Perform {@link Linecastable3D#linecast(Line3D)} and {@link Linecastable3D#linecastFirst(Line3D)} * operations using the given line and assert that the results match the configured expected * values. * @param line @@ -93,7 +93,7 @@ class LinecastChecker3D { checkLinecastFirstResult(target.linecastFirst(line), line); } - /** Perform {@link Linecastable2D#linecast(Segment)} and {@link Linecastable2D#linecastFirst(Segment)} + /** Perform {@link Linecastable3D#linecast(LineConvexSubset3D)} and {@link Linecastable3D#linecastFirst(LineConvexSubset3D)} * operations using the given line segment and assert that the results match the configured * expected results. * @param segment @@ -152,8 +152,8 @@ class LinecastChecker3D { } /** Return true if the given linecast points are equivalent according to the test precision. - * @param expected - * @param actual + * @param a + * @param b * @return */ private static boolean eq(final LinecastPoint3D a, final LinecastPoint3D b) { @@ -163,7 +163,7 @@ class LinecastChecker3D { TEST_PRECISION.eq(a.getAbscissa(), b.getAbscissa()); } - /** Convert an {@link ExpectedResult} struct to a {@link LinecastPoint2D} instance + /** Convert an {@link ExpectedResult} struct to a {@link org.apache.commons.geometry.euclidean.twod.LinecastPoint2D} instance * using the given line. * @param expected * @param line diff --git a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/rotation/QuaternionRotationTest.java b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/rotation/QuaternionRotationTest.java index 7c39ffd..10910e9 100644 --- a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/rotation/QuaternionRotationTest.java +++ b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/threed/rotation/QuaternionRotationTest.java @@ -1464,7 +1464,7 @@ public class QuaternionRotationTest { checkFromAxisAngleSequenceRelative(StandardRotations.PLUS_DIAGONAL_TWO_THIRDS_PI, AxisSequence.ZYZ, 0, PlaneAngleRadians.PI_OVER_TWO, PlaneAngleRadians.PI_OVER_TWO); } - /** Helper method for verifying that a {@link RelativeEulerAngles} instance constructed with the given arguments + /** Helper method for verifying that a relative euler angles instance constructed with the given arguments * is correctly converted to a QuaternionRotation that matches the given operator. * @param rotation * @param axes @@ -1556,7 +1556,7 @@ public class QuaternionRotationTest { checkFromAxisAngleSequenceAbsolute(StandardRotations.PLUS_DIAGONAL_TWO_THIRDS_PI, AxisSequence.ZYZ, PlaneAngleRadians.PI_OVER_TWO, PlaneAngleRadians.PI_OVER_TWO, 0); } - /** Helper method for verifying that an {@link AbsoluteEulerAngles} instance constructed with the given arguments + /** Helper method for verifying that an absolute euler angles instance constructed with the given arguments * is correctly converted to a QuaternionRotation that matches the given operator. * @param rotation * @param axes diff --git a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/twod/LinecastChecker2D.java b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/twod/LinecastChecker2D.java index 07042e5..774e795 100644 --- a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/twod/LinecastChecker2D.java +++ b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/twod/LinecastChecker2D.java @@ -48,7 +48,7 @@ public class LinecastChecker2D { /** Configure the instance to expect no results (an empty list from linecast() and null from * linecastFirst()) from the next linecast operation performed by {@link #whenGiven(Line)} - * or {@link #whenGiven(Segment)}. + * or {@link #whenGiven(LineConvexSubset)}. * @return */ public LinecastChecker2D expectNothing() { @@ -70,7 +70,7 @@ public class LinecastChecker2D { return this; } - /** Fluent API alias for {@link #returns(Vector2D, Vector2D)}. + /** Fluent API alias for {@link #expect(Vector2D, Vector2D)}. * @param point * @param normal * @return @@ -89,7 +89,7 @@ public class LinecastChecker2D { checkLinecastFirstResult(target.linecastFirst(line), line); } - /** Perform {@link Linecastable2D#linecast(Segment)} and {@link Linecastable2D#linecastFirst(Segment)} + /** Perform {@link Linecastable2D#linecast(LineConvexSubset)} and {@link Linecastable2D#linecastFirst(LineConvexSubset)} * operations using the given line segment and assert that the results match the configured * expected results. * @param segment @@ -148,8 +148,8 @@ public class LinecastChecker2D { } /** Return true if the given linecast points are equivalent according to the test precision. - * @param expected - * @param actual + * @param a + * @param b * @return */ private static boolean eq(final LinecastPoint2D a, final LinecastPoint2D b) {
