Skip to content

Commit fc2854f

Browse files
Florian GläßerflorianGla
authored andcommitted
chore: include new annotations in docs
1 parent fead9ec commit fc2854f

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

docs/mutation-framework.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,21 @@ string. This is done using annotations directly on the parameters.
8787
All annotations reside in the `com.code_intelligence.jazzer.mutation.annotation`
8888
package.
8989

90-
| Annotation | Applies To | Notes |
91-
|-------------------|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
92-
| `@Ascii` | `java.lang.String` | `String` should only contain ASCII characters |
93-
| `@InRange` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long` | Specifies `min` and `max` values of generated integrals |
94-
| `@FloatInRange` | `float`, `Float` | Specifies `min` and `max` values of generated floats |
95-
| `@DoubleInRange` | `double`, `Double` | Specifies `min` and `max` values of generated doubles |
96-
| `@NotNull` | | Specifies that a reference type should not be `null` |
97-
| `@WithLength` | `byte[]` | Specifies the length of the generated byte array |
98-
| `@WithUtf8Length` | `java.lang.String` | Specifies the length of the generated string in UTF-8 bytes, see annotation Javadoc for further information |
99-
| `@WithSize` | `java.util.List`, `java.util.Map` | Specifies the size of the generated collection |
100-
| `@UrlSegment` | `java.lang.String` | `String` should only contain valid URL segment characters |
90+
| Annotation | Applies To | Notes |
91+
|-------------------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
92+
| `@Ascii` | `java.lang.String` | `String` should only contain ASCII characters |
93+
| `@InRange` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long` | Specifies `min` and `max` values of generated integrals |
94+
| `@FloatInRange` | `float`, `Float` | Specifies `min` and `max` values of generated floats |
95+
| `@DoubleInRange` | `double`, `Double` | Specifies `min` and `max` values of generated doubles |
96+
| `Positive` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long`, `float`, `Float`, `double`, `Double` | Specifies that only positive values are generated |
97+
| `Negative` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long`, `float`, `Float`, `double`, `Double` | Specifies that only negative values are generated |
98+
| `NonPositive` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long`, `float`, `Float`, `double`, `Double` | Specifies that only non-positive values are generated |
99+
| `NonNegative` | `byte`, `Byte`, `short`, `Short`, `int`, `Int`, `long`, `Long`, `float`, `Float`, `double`, `Double` | Specifies that only non-negative values are generated |
100+
| `@NotNull` | | Specifies that a reference type should not be `null` |
101+
| `@WithLength` | `byte[]` | Specifies the length of the generated byte array |
102+
| `@WithUtf8Length` | `java.lang.String` | Specifies the length of the generated string in UTF-8 bytes, see annotation Javadoc for further information |
103+
| `@WithSize` | `java.util.List`, `java.util.Map` | Specifies the size of the generated collection |
104+
| `@UrlSegment` | `java.lang.String` | `String` should only contain valid URL segment characters |
101105

102106
The example below shows how Fuzz Test parameters can be annotated to provide
103107
additional information to the mutation framework.

0 commit comments

Comments
 (0)