Simplify JavaDoc
@@ -12,19 +12,9 @@ public final class ColorFunctions {
* Shades a color by some factor, where a higher factor results in a darker
* shade.
*
- * @param color
- * The color.
- *
- * @param shadeFactor
- * The factor.
- *
- * Values should range from 0.0 to 1.0.
- *
- * @return
- * The shaded color.
- *
- * @throws NullPointerException
- * If the color is null.
+ * @param color A color
+ * @param shadeFactor The amount to shade by, from 0.0 to 1.0.
+ * @return The shaded color.
*/
public static Color shade(final @NonNull Color color, double shadeFactor) {
if (shadeFactor > 1.0) {
@@ -51,19 +41,9 @@ public final class ColorFunctions {
* Tints a color by some factor, where a higher factor results in a lighter
* tint.
*
- * @param color
- * the color.
- *
- * @param tintFactor
- * The factor.
- *
- * Values should range from 0.0 to 1.0.
- *
- * @return
- * The tinted color.
- *
- * @throws NullPointerException
- * If the color is null.
+ * @param color A color.
+ * @param tintFactor The amount to tint by, from 0.0 to 1.0.
+ * @return The tinted color.
*/
public static Color tint(final @NonNull Color color, double tintFactor) {
if (tintFactor > 1.0) {
@@ -89,17 +69,9 @@ public final class ColorFunctions {
/**
* Blends two colors using the alpha blend algorithm.
*
- * @param source
- * The source color being blended onto the destination color.
- *
- * @param destination
- * The destination color.
- *
- * @return
- * The blended color.
- *
- * @throws NullPointerException
- * If either color is null.
+ * @param source The source color being blended onto the destination color.
+ * @param destination The destination color.
+ * @return The blended color.
*/
public static Color alphaBlend(final @NonNull Color source, final @NonNull Color destination) {
return new Color(alphaBlend(source.getRGB(), destination.getRGB()));
@@ -108,14 +80,9 @@ public final class ColorFunctions {
/**
* Blends two RGBA values using the alpha blend algorithm.
*
- * @param sourceRGBA
- * The source RGBA being blended onto the destination RGBA.
- *
- * @param destinationRGBA
- * The destination RGBA.
- *
- * @return
- * The blended RGBA value.
+ * @param sourceRGBA The source RGBA being blended onto the destination RGBA.
+ * @param destinationRGBA The destination RGBA.
+ * @return The blended RGBA value.
*/
public static int alphaBlend(final int sourceRGBA, final int destinationRGBA) {
final int destinationA = (destinationRGBA >> 24) & 0xFF;
