fix all javadoc errors

Author: micycle1

pom.xml

@@ -4,14 +4,14 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>micycle</groupId>
 	<artifactId>PeasyGradients</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>0.9.4</version>
 	<name>PeasyGradients</name>
 
 	<properties>
 		<sonar.projectKey>micycle1_PeasyGradients</sonar.projectKey>
 		<sonar.organization>micycle</sonar.organization>
 		<sonar.host.url>https://sonarcloud.io</sonar.host.url>
-		<junit>[5.9,)</junit>
+		<junit>[5.11,)</junit>
 	</properties>
 
 	<build>
@@ -20,7 +20,7 @@
 		<plugins>
 			<plugin>
 				<artifactId>maven-compiler-plugin</artifactId>
-				<version>3.8.1</version>
+				<version>3.13.0</version>
 				<configuration>
 					<source>1.8</source>
 					<target>1.8</target>
@@ -30,7 +30,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-source-plugin</artifactId>
-				<version>3.2.1</version>
+				<version>3.3.1</version>
 				<executions>
 					<execution>
 						<id>attach-sources</id>
@@ -44,22 +44,23 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>3.4.1</version>
+				<version>3.11.1</version>
 				<executions>
 					<execution>
 						<id>attach-javadocs</id>
 						<goals>
 							<goal>jar</goal>
 						</goals>
 						<configuration>
-							<additionalJOption>-Xdoclint:none</additionalJOption>
+							<excludePackageNames>
+								micycle.peasygradients.utilities,micycle.peasygradients.utilities.*</excludePackageNames>
 						</configuration>
 					</execution>
 				</executions>
 			</plugin>
 			<plugin> <!-- for test running -->
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>2.22.2</version>
+				<version>3.5.2</version>
 			</plugin>
 		</plugins>
 	</build>
@@ -72,7 +73,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-shade-plugin</artifactId>
-						<version>3.2.4</version>
+						<version>3.6.0</version>
 						<configuration>
 							<createDependencyReducedPom>false</createDependencyReducedPom>
 							<filters>
@@ -119,7 +120,8 @@
 			<artifactId>processing3</artifactId>
 			<version>3.5.4</version>
 			<scope>provided</scope> <!-- don't package into uber jar -->
-			<optional>true</optional> <!-- user artifact should override when provided -->
+			<optional>true</optional> <!-- user artifact should override when
+			provided -->
 		</dependency>
 		<dependency>
 			<groupId>com.github.micycle1</groupId>

src/main/micycle/peasygradients/PeasyGradients.java

@@ -47,17 +47,14 @@
  * with multiple color stops and custom center offsets)
  * </ul>
  *
- * <p>
- * By default, renders directly to the Processing sketch. Use
+ * <p>By default, renders directly to the Processing sketch. Use
  * {@code .setRenderTarget()} to specify a custom {@code PGraphics} output
- * buffer.
+ * buffer.</p>
  *
  * <p>
- * Linear, radial & conic sampling algorithms adapted from <a href=
- * "https://medium.com/@behreajj/color-gradients-in-processing-v-2-0-e5c0b87cdfd2">
- * Jeremy Behreandt's work</a>. Additional sampling patterns are original
- * implementations.
- *
+ * Linear, radial &amp; conic sampling algorithms adapted from Jeremy
+ * Behreandt. Additional sampling patterns are original implementations.
+ * </p>
  * 
  * @author Michael Carleton
  */
@@ -178,7 +175,7 @@ public void setRenderTarget(PApplet p, int offSetX, int offSetY, int width, int
 	 * PGraphics object provided by the user.
 	 * 
 	 * @param g PImage or PGraphics object to render gradients into
-	 * @see #renderIntoSketch()
+	 * @see #setRenderTarget(PApplet)
 	 */
 	public void setRenderTarget(PImage g) {
 		setRenderTarget(g, 0, 0, g.width, g.height);
@@ -356,7 +353,6 @@ public void linearGradient(Gradient gradient, PVector centerPoint, double angle)
 	/**
 	 * Renders a linear gradient using a given gradient centerpoint, angle and
 	 * length.
-	 * 
 	 * <p>
 	 * It's called 'linear' because the colors flow from left-to-right,
 	 * top-to-bottom, or at any angle you chose in a single direction.
@@ -367,8 +363,9 @@ public void linearGradient(Gradient gradient, PVector centerPoint, double angle)
 	 * @param angle       in radians
 	 * @param length      coefficient to lerp from centrepoint to edges (that
 	 *                    intersect with angle). default = 1: (first and last colors
-	 *                    will be exactly on edge); <1: colors will be sqashed; >1
-	 *                    colors spread out (outermost colors will leave the view).
+	 *                    will be exactly on edge); When &lt;1, colors will be
+	 *                    squashed; when &gt;1, colors spread out (outermost colors
+	 *                    will leave the view).
 	 */
 	public void linearGradient(Gradient gradient, PVector centerPoint, double angle, double length) {
 		// get edge-line intersection points
@@ -456,19 +453,11 @@ public void radialGradient(Gradient gradient, PVector centerPoint, double zoom)
 	 * angle provided and the contrast between the color values is great enough to
 	 * tell a difference.
 	 * 
-	 * <p>
-	 * This method creates a hard stop where the first and last colors bump right up
-	 * to one another. See
-	 * {@link #conicGradientSmooth(Gradient, PVector, double, double)
-	 * conicGradientSmooth()} to render a conic gradient with a smooth transition
-	 * between the first and last colors.
-	 * 
 	 * @param gradient    1D {@link Gradient gradient} to use as the basis for the
 	 *                    conic gradient
 	 * @param centerPoint The PVector center point of the gradient — the position
 	 *                    where it radiates from.
 	 * @param angle       in radians, where 0 is east; going clockwise
-	 * @see #conicGradientSmooth(Gradient, PVector, double, double)
 	 */
 	public void conicGradient(Gradient gradient, PVector centerPoint, double angle) {
 		// TODO add zoom arg
@@ -1457,8 +1446,8 @@ public Boolean call() {
 
 					double z = (renderMidpointY - newYpos) / (renderMidpointX - newXpos); // atan2(y,x) === atan(y/x), so calc y/x here
 
-					double dist = Math.sqrt((yDist + xDist + pinch) * (z * z + roundness)) * denominator; // cos(atan(x)) === sqrt(z * z +
-																											// 1)
+					// cos(atan(x)) === sqrt(z * z + 1)
+					double dist = Math.sqrt((yDist + xDist + pinch) * (z * z + roundness)) * denominator;
 
 					final int stepInt = clampAndDither(dist, x, y);
 					gradientPG.pixels[pixel++] = gradientCache[stepInt];

src/main/micycle/peasygradients/colorspace/ColorSpace.java

@@ -83,7 +83,7 @@ public enum ColorSpace {
 	JAB(new JAB()),
 	/**
 	 * Natural color mixing by treating colors as real-life pigments using the
-	 * Kubelka & Munk theory to predict realistic color behavior.
+	 * Kubelka & Munk theory to predict realistic color behavior.
 	 */
 	KMUNK(new K_MUNK()),
 	/**

src/main/micycle/peasygradients/colorspace/ColorSpaceTransform.java

@@ -48,9 +48,6 @@ public interface ColorSpaceTransform {
 	 * @param step a double value between 0.0 and 1.0 representing the interpolation
 	 *             factor, where 0.0 corresponds to the starting color, 1.0 to the
 	 *             ending color, and values in between to intermediate colors
-	 * @param out  an array of doubles where the interpolated color will be stored.
-	 *             This array must be pre-allocated and of appropriate length for
-	 *             the color space
 	 * @return the {@code out} array containing the interpolated color
 	 */
 	public default double[] interpolateLinear(double[] a, double[] b, double step) {

src/main/micycle/peasygradients/gradient/Gradient.java

@@ -31,7 +31,7 @@
  * <p>
  * This class defines only the mathematical gradient function - it does not
  * handle the actual rendering or rasterization. To generate a two-dimensional
- * visualization of this gradient, use a {@link #peasyGradients.PeasyGradients}
+ * visualization of this gradient, use a {@link micycle.peasygradients.PeasyGradients PeasyGradients}
  * instance, which will sample this function to create a 2D spectrum.
  *
  * @author Michael Carleton
@@ -239,7 +239,7 @@ public void setStopColor(int stopIndex, int col) {
 
 	/**
 	 * Sets the 1D position of a color stop (given by its index) to a certain
-	 * position on the 1D gradient axis. Positions < 0 or > 1 will wrap around the
+	 * position on the 1D gradient axis. Positions &lt; 0 or &gt; 1 will wrap around the
 	 * gradient.
 	 * 
 	 * @param index

src/main/micycle/peasygradients/utilities/ColorUtils.java

@@ -59,7 +59,7 @@ public static float[] interpolateLinear(float[] col1, float[] col2, float step,
 	 * Composes a 32-bit ARGB color from RGB components represented as a float
 	 * array.
 	 * 
-	 * @param RGBA The RGB components as a float array [R,G,B] with each value in
+	 * @param RGB The RGB components as a float array [R,G,B] with each value in
 	 *             the range 0...1.
 	 * @return The composed ARGB color as an integer.
 	 */

src/main/micycle/peasygradients/utilities/FastPow.java

@@ -9,7 +9,7 @@
  * "http://www.hxa7241.org/articles/content/fast-pow-adjustable_hxa7241_2007.html">Fast
  * pow() With Adjustable Accuracy</a> by Harrison Ainsworth.
  * <p>
- * When precision = 11 (8KB table), mean error is < 0.01%, and max error is <
+ * When precision = 11 (8KB table), mean error is &lt; 0.01%, and max error is &lt;
  * 0.02% (proportional, ie: abs(true - approx) / true).
  * <p>
  * The essential approximation is a 'staircase' function across the fraction
@@ -49,7 +49,7 @@ private FastPow() {
 	 * 
 	 * fastLog speed factor drops off after 14 bits.
 	 * 
-	 * @param precision number of mantissa bits used, >= 0 and <= 18
+	 * @param precision number of mantissa bits used, &ge; 0 and &le; 18
 	 */
 	public static void init(int precision) {
 
@@ -112,7 +112,7 @@ public static float fastPow(final float base, final float exponent) {
 	/**
 	 * Includes further optimisation to calculate base representation.
 	 * 
-	 * @param baseRepresentation the exact base
+	 * @param base the exact base
 	 * @param exponent           power to raise radix to
 	 * @return
 	 * @see #fastPow(float, float)

src/main/micycle/peasygradients/utilities/Functions.java

@@ -328,7 +328,7 @@ public static double fastAtan(double z) {
 	 * @param y
 	 * @param x
 	 * @return
-	 * @see #fastAtan(float)
+	 * @see #fastAtan(double)
 	 */
 	public static double fastAtan2a(double y, double x) {
 		if (x != 0.0f) {
@@ -460,17 +460,15 @@ public static float lerpAngle(float fromRadians, float toRadians, float progress
 	 * given by a point inside the rectangle and an angle.
 	 * <p>
 	 * A Java/Processing implementation of
-	 * <a href="https://gamedev.stackexchange.com/questions/124108/i-need-to-find-
-	 * intersection-point-of-a-vector-in-an-axis-aligned-rectangle">this SE Game Dev
+	 * <a href="https://gamedev.stackexchange.com/questions/124108">this SE Game Dev
 	 * answer</a>.
-	 * 
-	 * 
-	 * @param rectCoords a float[4] containing the rectangle corner coordinates
-	 *                   {UL,BL,BR,UR}
-	 * @param point      2D coordinates of point within rectangle (i.e. where the
-	 *                   line originates from)
-	 * @param angle      angle of line in radians (where 0 faces east). Increases in
-	 *                   a clockwise manner
+	 *
+	 * @param rect  a float[4] containing the rectangle corner coordinates
+	 *              {UL,BL,BR,UR}
+	 * @param point 2D coordinates of point within rectangle (i.e. where the line
+	 *              originates from)
+	 * @param angle angle of line in radians (where 0 faces east). Increases in a
+	 *              clockwise manner
 	 * @return PVector[2] containing the two points of intersection
 	 * @see #lineRectIntersection(float, float, PVector, float)
 	 */
@@ -506,7 +504,7 @@ public static PVector[] lineRectIntersection(PVector[] rect, PVector point, floa
 	}
 
 	/**
-	 * An x-axis & y-axis aligned version of
+	 * An x-axis &amp; y-axis aligned version of
 	 * {@link #lineRectIntersection(PVector[], PVector, float) this} method.
 	 * 
 	 * <p>

src/main/micycle/peasygradients/utilities/Interpolation.java

@@ -34,12 +34,7 @@ public enum Interpolation {
 	 */
 	SMOOTH_STEP,
 	/**
-	 * Ken Perlin's smoother step, a simoid like function.
-	 * 
-	 * @param st step, between 0 and 1
-	 * @return the new mapped step, having undergone a transformation according to a
-	 *         sigmoid-like function (eg: [0.5 -> 0.5], [0.25 -> 0.104], [0.65
-	 *         ->0.765])
+	 * Ken Perlin's smoother step, a sigmoid like function.
 	 */
 	SMOOTHER_STEP,
 	/*