aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabian Meumertzheim <fabian@meumertzhe.im>2022-08-11 10:09:34 +0200
committerFabian Meumertzheim <fabian@meumertzhe.im>2022-08-15 22:27:22 +0200
commit11707bcec3ca41f7957dc3296253a4a431fd2041 (patch)
tree1a2fd85f96f0161a37b84e5e08be8678d1506324
parent766b77226a38388b772983aafe40c9c230a882a1 (diff)
downloadjazzer-api-11707bcec3ca41f7957dc3296253a4a431fd2041.tar.gz
api: Fix paragraphs and links in Javadoc
<p> is required to begin a new paragraph, empty lines aren't enough.
-rw-r--r--agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueCritical.java2
-rw-r--r--agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueHigh.java2
-rw-r--r--agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueMedium.java2
-rw-r--r--agent/src/main/java/com/code_intelligence/jazzer/api/Jazzer.java38
-rw-r--r--agent/src/main/java/com/code_intelligence/jazzer/api/MethodHook.java2
-rw-r--r--sanitizers/src/main/java/com/code_intelligence/jazzer/sanitizers/RegexRoadblocks.java2
-rw-r--r--tests/src/test/java/com/example/LongStringFuzzer.java8
7 files changed, 28 insertions, 28 deletions
diff --git a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueCritical.java b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueCritical.java
index 4402a7f3..fbde853b 100644
--- a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueCritical.java
+++ b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueCritical.java
@@ -17,7 +17,7 @@ package com.code_intelligence.jazzer.api;
/**
* Thrown to indicate that a fuzz target has detected a critical severity security issue rather than
* a normal bug.
- *
+ * <p>
* There is only a semantical but no functional difference between throwing exceptions of this type
* or any other. However, automated fuzzing platforms can use the extra information to handle the
* detected issues appropriately.
diff --git a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueHigh.java b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueHigh.java
index 4d323e56..05837b0e 100644
--- a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueHigh.java
+++ b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueHigh.java
@@ -17,7 +17,7 @@ package com.code_intelligence.jazzer.api;
/**
* Thrown to indicate that a fuzz target has detected a high severity security issue rather than a
* normal bug.
- *
+ * <p>
* There is only a semantical but no functional difference between throwing exceptions of this type
* or any other. However, automated fuzzing platforms can use the extra information to handle the
* detected issues appropriately.
diff --git a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueMedium.java b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueMedium.java
index f0de4ce7..be7c8c8f 100644
--- a/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueMedium.java
+++ b/agent/src/main/java/com/code_intelligence/jazzer/api/FuzzerSecurityIssueMedium.java
@@ -17,7 +17,7 @@ package com.code_intelligence.jazzer.api;
/**
* Thrown to indicate that a fuzz target has detected a medium severity security issue rather than a
* normal bug.
- *
+ * <p>
* There is only a semantical but no functional difference between throwing exceptions of this type
* or any other. However, automated fuzzing platforms can use the extra information to handle the
* detected issues appropriately.
diff --git a/agent/src/main/java/com/code_intelligence/jazzer/api/Jazzer.java b/agent/src/main/java/com/code_intelligence/jazzer/api/Jazzer.java
index 2d2e82b0..97adf578 100644
--- a/agent/src/main/java/com/code_intelligence/jazzer/api/Jazzer.java
+++ b/agent/src/main/java/com/code_intelligence/jazzer/api/Jazzer.java
@@ -29,7 +29,7 @@ final public class Jazzer {
* between multiple possible mutations they could guide the fuzzer towards.
* Hooks <b>must not</b> base the decision whether or not to report a finding
* on this number as this will make findings non-reproducible.
- *
+ * <p>
* This is the same number that libFuzzer uses as a seed internally, which
* makes it possible to deterministically reproduce a previous fuzzing run by
* supplying the seed value printed by libFuzzer as the value of the
@@ -160,7 +160,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -190,7 +190,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -220,7 +220,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -250,7 +250,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -281,7 +281,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -312,7 +312,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -337,7 +337,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -362,7 +362,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -387,7 +387,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -413,7 +413,7 @@ final public class Jazzer {
/**
* Attempts to invoke {@code func} with arguments created automatically from the fuzzer input
* using only public methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to execute {@code func} in
* meaningful ways for a number of reasons.
*
@@ -439,7 +439,7 @@ final public class Jazzer {
/**
* Attempts to construct an instance of {@code type} from the fuzzer input using only public
* methods available on the classpath.
- *
+ * <p>
* <b>Note:</b> This function is inherently heuristic and may fail to return meaningful values for
* a variety of reasons.
*
@@ -464,7 +464,7 @@ final public class Jazzer {
/**
* Instructs the fuzzer to guide its mutations towards making {@code current} equal to {@code
* target}.
- *
+ * <p>
* If the relation between the raw fuzzer input and the value of {@code current} is relatively
* complex, running the fuzzer with the argument {@code -use_value_profile=1} may be necessary to
* achieve equality.
@@ -487,7 +487,7 @@ final public class Jazzer {
/**
* Instructs the fuzzer to guide its mutations towards making {@code current} equal to {@code
* target}.
- *
+ * <p>
* If the relation between the raw fuzzer input and the value of {@code current} is relatively
* complex, running the fuzzer with the argument {@code -use_value_profile=1} may be necessary to
* achieve equality.
@@ -510,7 +510,7 @@ final public class Jazzer {
/**
* Instructs the fuzzer to guide its mutations towards making {@code haystack} contain {@code
* needle} as a substring.
- *
+ * <p>
* If the relation between the raw fuzzer input and the value of {@code haystack} is relatively
* complex, running the fuzzer with the argument {@code -use_value_profile=1} may be necessary to
* satisfy the substring check.
@@ -534,12 +534,12 @@ final public class Jazzer {
/**
* Instructs the fuzzer to attain as many possible values for the absolute value of {@code state}
* as possible.
- *
+ * <p>
* Call this function from a fuzz target or a hook to help the fuzzer track partial progress
* (e.g. by passing the length of a common prefix of two lists that should become equal) or
* explore different values of state that is not directly related to code coverage (see the
* MazeFuzzer example).
- *
+ * <p>
* <b>Note:</b> This hint only takes effect if the fuzzer is run with the argument
* {@code -use_value_profile=1}.
*
@@ -584,7 +584,7 @@ final public class Jazzer {
/**
* Make Jazzer report the provided {@link Throwable} as a finding.
- *
+ * <p>
* <b>Note:</b> This method must only be called from a method hook. In a
* fuzz target, simply throw an exception to trigger a finding.
* @param finding the finding that Jazzer should report
@@ -609,7 +609,7 @@ final public class Jazzer {
/**
* Register a callback to be executed right before the fuzz target is executed for the first time.
- *
+ * <p>
* This can be used to disable hooks until after Jazzer has been fully initializing, e.g. to
* prevent Jazzer internals from triggering hooks on Java standard library classes.
*
diff --git a/agent/src/main/java/com/code_intelligence/jazzer/api/MethodHook.java b/agent/src/main/java/com/code_intelligence/jazzer/api/MethodHook.java
index 46c5c112..3a1c5f39 100644
--- a/agent/src/main/java/com/code_intelligence/jazzer/api/MethodHook.java
+++ b/agent/src/main/java/com/code_intelligence/jazzer/api/MethodHook.java
@@ -88,7 +88,7 @@ import java.lang.invoke.MethodType;
* <p>
* Return value: the value that should take the role of the value the target
* method would have returned
- *
+ * <p>
* <dt><span class="strong">{@link HookType#AFTER}</span>
* <dd>
* <pre>{@code
diff --git a/sanitizers/src/main/java/com/code_intelligence/jazzer/sanitizers/RegexRoadblocks.java b/sanitizers/src/main/java/com/code_intelligence/jazzer/sanitizers/RegexRoadblocks.java
index f28c9991..1043ac02 100644
--- a/sanitizers/src/main/java/com/code_intelligence/jazzer/sanitizers/RegexRoadblocks.java
+++ b/sanitizers/src/main/java/com/code_intelligence/jazzer/sanitizers/RegexRoadblocks.java
@@ -32,7 +32,7 @@ import sun.misc.Unsafe;
/**
* The hooks in this class extend the reach of Jazzer's string compare instrumentation to literals
* (both strings and characters) that are part of regular expression patterns.
- *
+ * <p>
* Internally, the Java standard library represents a compiled regular expression as a graph of
* instances of Pattern$Node instances, each of which represents a single unit of the full
* expression and provides a `match` function that takes a {@link Matcher}, a {@link CharSequence}
diff --git a/tests/src/test/java/com/example/LongStringFuzzer.java b/tests/src/test/java/com/example/LongStringFuzzer.java
index 5fecf91f..324764d4 100644
--- a/tests/src/test/java/com/example/LongStringFuzzer.java
+++ b/tests/src/test/java/com/example/LongStringFuzzer.java
@@ -17,11 +17,11 @@ package com.example;
import com.code_intelligence.jazzer.api.FuzzerSecurityIssueLow;
/**
- * Provoke a finding with huge captured data to verify that the generated
- * crash reproducer is still compilable. This test uses a huge, predefined
- * corpus to speed up finding the issue.
+ * Provoke a finding with huge captured data to verify that the generated crash reproducer is still
+ * compilable. This test uses a huge, predefined corpus to speed up finding the issue.
* <p>
- * Reproduces issue #269 (https://github.com/CodeIntelligenceTesting/jazzer/issues/269)
+ * Reproduces issue #269 (<a
+ * href="https://github.com/CodeIntelligenceTesting/jazzer/issues/269">...</a>)
*/
public class LongStringFuzzer {
public static void fuzzerTestOneInput(byte[] data) {