docs: add Javadoc to mutation annotations

Author: Marcono1234

src/main/java/com/code_intelligence/jazzer/mutation/annotation/Ascii.java

@@ -24,6 +24,11 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a {@code String} consisting only of ASCII characters (including control characters).
+ *
+ * @see WithUtf8Length
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo(String.class)

src/main/java/com/code_intelligence/jazzer/mutation/annotation/DoubleInRange.java

@@ -25,16 +25,28 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a {@code double} in the specified range.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({double.class, Double.class})
 @ValidateMinMax
 @PropertyConstraint
 public @interface DoubleInRange {
+  /**
+   * The minimum value of the range, inclusive.
+   */
   double min() default Double.NEGATIVE_INFINITY;
 
+  /**
+   * The maximum value of the range, inclusive.
+   */
   double max() default Double.POSITIVE_INFINITY;
 
+  /**
+   * Whether NaN is allowed to be generated.
+   */
   boolean allowNaN() default true;
 
   /**

src/main/java/com/code_intelligence/jazzer/mutation/annotation/FloatInRange.java

@@ -25,16 +25,28 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a {@code float} in the specified range.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({float.class, Float.class})
 @ValidateMinMax
 @PropertyConstraint
 public @interface FloatInRange {
+  /**
+   * The minimum value of the range, inclusive.
+   */
   float min() default Float.NEGATIVE_INFINITY;
 
+  /**
+   * The maximum value of the range, inclusive.
+   */
   float max() default Float.POSITIVE_INFINITY;
 
+  /**
+   * Whether NaN is allowed to be generated.
+   */
   boolean allowNaN() default true;
 
   /**

src/main/java/com/code_intelligence/jazzer/mutation/annotation/InRange.java

@@ -25,6 +25,12 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates an integral number in the specified range.
+ *
+ * @see FloatInRange
+ * @see DoubleInRange
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({
@@ -40,8 +46,14 @@
 @ValidateMinMax
 @PropertyConstraint
 public @interface InRange {
+  /**
+   * The minimum value of the range, inclusive.
+   */
   long min() default Long.MIN_VALUE;
 
+  /**
+   * The maximum value of the range, inclusive.
+   */
   long max() default Long.MAX_VALUE;
 
   /**

src/main/java/com/code_intelligence/jazzer/mutation/annotation/Negative.java

@@ -24,6 +24,11 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a negative number, that is, a number < 0.
+ *
+ * <p>For {@code float} and {@code double} this does not include -0.0 or NaN.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({

src/main/java/com/code_intelligence/jazzer/mutation/annotation/NonNegative.java

@@ -24,6 +24,11 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a non-negative number, that is, a number >= 0.
+ *
+ * <p>For {@code float} and {@code double} this does not include NaN.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({

src/main/java/com/code_intelligence/jazzer/mutation/annotation/NonPositive.java

@@ -24,6 +24,11 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a non-positive number, that is, a number <= 0.
+ *
+ * <p>For {@code float} and {@code double} this does not include NaN.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({

src/main/java/com/code_intelligence/jazzer/mutation/annotation/NotNull.java

@@ -25,6 +25,10 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a not-{@code null} value. By default the mutation framework can generate {@code null} for objects
+ * (including arrays).
+ */
 @Target({PARAMETER, TYPE_USE})
 @Retention(RUNTIME)
 @AppliesTo(subClassesOf = Object.class)

src/main/java/com/code_intelligence/jazzer/mutation/annotation/Positive.java

@@ -24,6 +24,11 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates a positive number, that is, a number > 0.
+ *
+ * <p>For {@code float} and {@code double} this does not include NaN.
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo({

src/main/java/com/code_intelligence/jazzer/mutation/annotation/WithLength.java

@@ -25,6 +25,12 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Generates an array of the specified length.
+ *
+ * @see WithSize
+ * @see WithUtf8Length
+ */
 @Target(TYPE_USE)
 @Retention(RUNTIME)
 @AppliesTo(
@@ -42,8 +48,14 @@
 @ValidateContainerDimensions
 @PropertyConstraint
 public @interface WithLength {
+  /**
+   * The minimum length, inclusive.
+   */
   int min() default 0;
 
+  /**
+   * The maximum length, inclusive.
+   */
   int max() default 1000;
 
   /**