Skip to content

Commit 562d6f4

Browse files
author
Jazzer release pipeline
committed
Automated update: jazzer-junit docs
1 parent 39b16ac commit 562d6f4

6 files changed

Lines changed: 35 additions & 25 deletions

File tree

jazzer-junit/allclasses-index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
6262
<div class="table-header col-last">Description</div>
6363
<div class="col-first even-row-color all-classes-table all-classes-table-tab7"><a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntries</a></div>
6464
<div class="col-last even-row-color all-classes-table all-classes-table-tab7">
65-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
65+
<div class="block">Adds the given strings to the fuzzer's dictionary.</div>
6666
</div>
6767
<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="com/code_intelligence/jazzer/junit/DictionaryEntriesList.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntriesList</a></div>
6868
<div class="col-last odd-row-color all-classes-table all-classes-table-tab7">&nbsp;</div>
6969
<div class="col-first even-row-color all-classes-table all-classes-table-tab7"><a href="com/code_intelligence/jazzer/junit/DictionaryFile.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFile</a></div>
7070
<div class="col-last even-row-color all-classes-table all-classes-table-tab7">
71-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
71+
<div class="block">Attaches a dictionary file located in resources to a fuzz test.</div>
7272
</div>
7373
<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="com/code_intelligence/jazzer/junit/DictionaryFiles.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFiles</a></div>
7474
<div class="col-last odd-row-color all-classes-table all-classes-table-tab7">&nbsp;</div>

jazzer-junit/com/code_intelligence/jazzer/junit/DictionaryEntries.html

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,12 @@ <h1 title="Annotation Interface DictionaryEntries" class="title">Annotation Inte
7171
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
7272
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Repeatable.html" title="class or interface in java.lang.annotation" class="external-link">@Repeatable</a>(<a href="DictionaryEntriesList.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntriesList.class</a>)
7373
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">DictionaryEntries</span></div>
74-
<div class="block">Defines a reference to a dictionary within the resources directory. These should follow <a href="https://llvm.org/docs/LibFuzzer.html#dictionaries">libfuzzer's dictionary syntax</a>.</div>
74+
<div class="block">Adds the given strings to the fuzzer's dictionary. This is particularly useful for adding strings
75+
that have special meaning in the context of your fuzz test, but are difficult for the fuzzer to
76+
discover automatically.
77+
78+
<p>Typical examples include valid credentials for mock accounts in a web application or a
79+
collection of valid HTML tags for an HTML parser.</div>
7580
</section>
7681
<section class="summary">
7782
<ul class="summary-list">
@@ -85,8 +90,10 @@ <h2>Required Element Summary</h2>
8590
<div class="table-header col-second">Required Element</div>
8691
<div class="table-header col-last">Description</div>
8792
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
88-
<div class="col-second even-row-color"><code><a href="#tokens()" class="member-name-link">tokens</a></code></div>
89-
<div class="col-last even-row-color">&nbsp;</div>
93+
<div class="col-second even-row-color"><code><a href="#value()" class="member-name-link">value</a></code></div>
94+
<div class="col-last even-row-color">
95+
<div class="block">Individual strings to add to the fuzzer dictionary.</div>
96+
</div>
9097
</div>
9198
</section>
9299
</li>
@@ -100,9 +107,10 @@ <h2>Required Element Summary</h2>
100107
<h2>Element Details</h2>
101108
<ul class="member-list">
102109
<li>
103-
<section class="detail" id="tokens()">
104-
<h3>tokens</h3>
105-
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">tokens</span></div>
110+
<section class="detail" id="value()">
111+
<h3>value</h3>
112+
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">value</span></div>
113+
<div class="block">Individual strings to add to the fuzzer dictionary.</div>
106114
</section>
107115
</li>
108116
</ul>

jazzer-junit/com/code_intelligence/jazzer/junit/DictionaryFile.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,7 @@ <h1 title="Annotation Interface DictionaryFile" class="title">Annotation Interfa
7171
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
7272
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Repeatable.html" title="class or interface in java.lang.annotation" class="external-link">@Repeatable</a>(<a href="DictionaryFiles.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFiles.class</a>)
7373
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">DictionaryFile</span></div>
74-
<div class="block">Defines a reference to a dictionary within the resources directory. The given <code>
75-
resourcePath</code> must be an absolute path and must not have a leading <code>/</code>. These should follow
76-
<a href="https://llvm.org/docs/LibFuzzer.html#dictionaries">libfuzzer's dictionary syntax</a>.</div>
74+
<div class="block">Attaches a dictionary file located in resources to a fuzz test. The file should follow <a href="https://llvm.org/docs/LibFuzzer.html#dictionaries">libfuzzer's dictionary syntax</a>.</div>
7775
</section>
7876
<section class="summary">
7977
<ul class="summary-list">
@@ -88,7 +86,9 @@ <h2>Required Element Summary</h2>
8886
<div class="table-header col-last">Description</div>
8987
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
9088
<div class="col-second even-row-color"><code><a href="#resourcePath()" class="member-name-link">resourcePath</a></code></div>
91-
<div class="col-last even-row-color">&nbsp;</div>
89+
<div class="col-last even-row-color">
90+
<div class="block">The resource path of the dictionary file.</div>
91+
</div>
9292
</div>
9393
</section>
9494
</li>
@@ -105,6 +105,7 @@ <h2>Element Details</h2>
105105
<section class="detail" id="resourcePath()">
106106
<h3>resourcePath</h3>
107107
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">resourcePath</span></div>
108+
<div class="block">The resource path of the dictionary file.</div>
108109
</section>
109110
</li>
110111
</ul>

jazzer-junit/com/code_intelligence/jazzer/junit/package-summary.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ <h1 title="Package com.code_intelligence.jazzer.junit" class="title">Package com
8686
<div class="table-header col-last">Description</div>
8787
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="DictionaryEntries.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntries</a></div>
8888
<div class="col-last even-row-color class-summary class-summary-tab7">
89-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
89+
<div class="block">Adds the given strings to the fuzzer's dictionary.</div>
9090
</div>
9191
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="DictionaryEntriesList.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntriesList</a></div>
9292
<div class="col-last odd-row-color class-summary class-summary-tab7">&nbsp;</div>
9393
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="DictionaryFile.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFile</a></div>
9494
<div class="col-last even-row-color class-summary class-summary-tab7">
95-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
95+
<div class="block">Attaches a dictionary file located in resources to a fuzz test.</div>
9696
</div>
9797
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="DictionaryFiles.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFiles</a></div>
9898
<div class="col-last odd-row-color class-summary class-summary-tab7">&nbsp;</div>

jazzer-junit/index-all.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<div class="header">
5151
<h1>Index</h1>
5252
</div>
53-
<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a>
53+
<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a>
5454
<h2 class="title" id="I:C">C</h2>
5555
<dl class="index">
5656
<dt><a href="com/code_intelligence/jazzer/package-summary.html">com.code_intelligence.jazzer</a> - package com.code_intelligence.jazzer</dt>
@@ -62,13 +62,13 @@ <h2 class="title" id="I:D">D</h2>
6262
<dl class="index">
6363
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html" class="type-name-link" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntries</a> - Annotation Interface in <a href="com/code_intelligence/jazzer/junit/package-summary.html">com.code_intelligence.jazzer.junit</a></dt>
6464
<dd>
65-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
65+
<div class="block">Adds the given strings to the fuzzer's dictionary.</div>
6666
</dd>
6767
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryEntriesList.html" class="type-name-link" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntriesList</a> - Annotation Interface in <a href="com/code_intelligence/jazzer/junit/package-summary.html">com.code_intelligence.jazzer.junit</a></dt>
6868
<dd>&nbsp;</dd>
6969
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryFile.html" class="type-name-link" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFile</a> - Annotation Interface in <a href="com/code_intelligence/jazzer/junit/package-summary.html">com.code_intelligence.jazzer.junit</a></dt>
7070
<dd>
71-
<div class="block">Defines a reference to a dictionary within the resources directory.</div>
71+
<div class="block">Attaches a dictionary file located in resources to a fuzz test.</div>
7272
</dd>
7373
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryFiles.html" class="type-name-link" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFiles</a> - Annotation Interface in <a href="com/code_intelligence/jazzer/junit/package-summary.html">com.code_intelligence.jazzer.junit</a></dt>
7474
<dd>&nbsp;</dd>
@@ -133,15 +133,16 @@ <h2 class="title" id="I:P">P</h2>
133133
<h2 class="title" id="I:R">R</h2>
134134
<dl class="index">
135135
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryFile.html#resourcePath()" class="member-name-link">resourcePath()</a> - Element in annotation interface com.code_intelligence.jazzer.junit.<a href="com/code_intelligence/jazzer/junit/DictionaryFile.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFile</a></dt>
136-
<dd>&nbsp;</dd>
137-
</dl>
138-
<h2 class="title" id="I:T">T</h2>
139-
<dl class="index">
140-
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html#tokens()" class="member-name-link">tokens()</a> - Element in annotation interface com.code_intelligence.jazzer.junit.<a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntries</a></dt>
141-
<dd>&nbsp;</dd>
136+
<dd>
137+
<div class="block">The resource path of the dictionary file.</div>
138+
</dd>
142139
</dl>
143140
<h2 class="title" id="I:V">V</h2>
144141
<dl class="index">
142+
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html#value()" class="member-name-link">value()</a> - Element in annotation interface com.code_intelligence.jazzer.junit.<a href="com/code_intelligence/jazzer/junit/DictionaryEntries.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntries</a></dt>
143+
<dd>
144+
<div class="block">Individual strings to add to the fuzzer dictionary.</div>
145+
</dd>
145146
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryEntriesList.html#value()" class="member-name-link">value()</a> - Element in annotation interface com.code_intelligence.jazzer.junit.<a href="com/code_intelligence/jazzer/junit/DictionaryEntriesList.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryEntriesList</a></dt>
146147
<dd>&nbsp;</dd>
147148
<dt><a href="com/code_intelligence/jazzer/junit/DictionaryFiles.html#value()" class="member-name-link">value()</a> - Element in annotation interface com.code_intelligence.jazzer.junit.<a href="com/code_intelligence/jazzer/junit/DictionaryFiles.html" title="annotation interface in com.code_intelligence.jazzer.junit">DictionaryFiles</a></dt>
@@ -156,7 +157,7 @@ <h2 class="title" id="I:V">V</h2>
156157
the order they are declared.</div>
157158
</dd>
158159
</dl>
159-
<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a></main>
160+
<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a></main>
160161
</div>
161162
</div>
162163
</body>

jazzer-junit/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)