Skip to content

Commit

Permalink
Javadoc fixes and improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@joel-costigliola
joel-costigliola committed Jan 20, 2021
1 parent 8929220 commit 67822a4
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
18 changes: 9 additions & 9 deletions src/main/java/org/assertj/core/api/AbstractBooleanArrayAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,11 @@ public SELF containsSequence(boolean... sequence) {
* <p>
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(new boolean[] { true, false }).containsSequence(true, false);
* assertThat(new boolean[] { true, false, false, true }).containsSequence(false, true);
* assertThat(new boolean[] { true, false }).containsSequence(new Boolean[] { true, false });
* assertThat(new boolean[] { true, false, false, true }).containsSequence(new Boolean[] { false, true });
*
* // assertion will fail
* assertThat(new boolean[] { true, true, false }).containsSequence(false, true);</code></pre>
* assertThat(new boolean[] { true, true, false }).containsSequence(new Boolean[] { false, true });</code></pre>
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
Expand Down Expand Up @@ -579,10 +579,10 @@ public SELF startsWith(boolean... sequence) {
* <p>
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(new boolean[] { true, false, false, true }).startsWith(true, false);
* assertThat(new boolean[] { true, false, false, true }).startsWith(new Boolean[] { true, false });
*
* // assertion will fail
* assertThat(new boolean[] { true, false, false, true }).startsWith(false, false, true);</code></pre>
* assertThat(new boolean[] { true, false, false, true }).startsWith(new Boolean[] { false, false, true });</code></pre>
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
Expand Down Expand Up @@ -628,10 +628,10 @@ public SELF endsWith(boolean... sequence) {
* <p>
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(new boolean[] { true, false, false, true }).endsWith(false, false, true);
* assertThat(new boolean[] { true, false, false, true }).endsWith(new Boolean[] { false, false, true });
*
* // assertion will fail
* assertThat(new boolean[] { true, false, false, true }).endsWith(true, false);</code></pre>
* assertThat(new boolean[] { true, false, false, true }).endsWith(new Boolean[] { true, false });</code></pre>
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
Expand Down Expand Up @@ -712,10 +712,10 @@ public SELF containsExactly(boolean... values) {
* <p>
* Example :
* <pre><code class='java'> // assertion will pass
* assertThat(new boolean[] { true, false, true }).containsExactly(true, false, true);
* assertThat(new boolean[] { true, false, true }).containsExactly(new Boolean[] { true, false, true });
*
* // assertion will fail as actual and expected order differ
* assertThat(new boolean[] { true, false, true }).containsExactly(false, true, true);</code></pre>
* assertThat(new boolean[] { true, false, true }).containsExactly(new Boolean[] { false, true, true });</code></pre>
*
* @param values the given values.
* @return {@code this} assertion object.
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/assertj/core/api/AbstractDoubleArrayAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,8 @@ public SELF contains(double... values) {
* assertThat(values).contains(new Double[] { 1.0, 3.0, 2.0 })
*
* // assertions will fail
* assertThat(values).contains(1.0, 4.0);
* assertThat(values).contains(1.1, 2.1);</code></pre>
* assertThat(values).contains(new Double[] { 1.0, 4.0 });
* assertThat(values).contains(new Double[] { 1.1, 2.1 });</code></pre>
*
* @param values the given values.
* @return {@code this} assertion object.
Expand Down Expand Up @@ -1337,7 +1337,7 @@ public SELF containsExactly(double... values) {
* assertThat(new double[] { 1.0, 2.0, 1.0 }).containsExactly(new Double[] { 1.0, 2.0, 1.0 });
*
* // assertion will fail as actual and expected order differ
* assertThat(new double[] { 1.0, 2.0, 1.0 }).containsExactly(new Double[] {2.0, 1.0, 1.0});</code></pre>
* assertThat(new double[] { 1.0, 2.0, 1.0 }).containsExactly(new Double[] { 2.0, 1.0, 1.0 });</code></pre>
*
* @param values the given values.
* @return {@code this} assertion object.
Expand Down Expand Up @@ -1520,7 +1520,7 @@ public SELF containsAnyOf(double... values) {
*
* // assertions will fail
* assertThat(new double[] { 1.0, 2.0, 3.0 }).containsAnyOf(new Double[] { 8.0 });
* assertThat(new double[] { 1.0, 2.0, 3.0 }).containsAnyOf(new double[] { 12.0, 11.0, 15.0 };</code></pre>
* assertThat(new double[] { 1.0, 2.0, 3.0 }).containsAnyOf(new Double[] { 12.0, 11.0, 15.0 };</code></pre>
*
* @param values the values whose at least one which is expected to be in the array under test.
* @return {@code this} assertion object.
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/assertj/core/api/AbstractDoubleAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ private boolean noCustomComparatorSet() {
* <p>
* Examples:
* <pre><code class='java'> // assertion succeeds
* assertThat(+1.0d).isFinite();
* assertThat(1.0d).isFinite();
*
* // assertions fail
* assertThat(Double.NaN).isFinite();
Expand Down Expand Up @@ -888,7 +888,7 @@ public SELF isFinite() {
* assertThat(Double.POSITIVE_INFINITY).isInfinite();
*
* // assertions fail
* assertThat(+1.0d).isInfinite();
* assertThat(1.0d).isInfinite();
* assertThat(Double.NaN).isInfinite();</code></pre>
*
* @return this assertion object.
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/assertj/core/api/AbstractFloatAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,7 @@ private boolean noCustomComparatorSet() {
* <p>
* Example:
* <pre><code class='java'> // assertion succeeds
* assertThat(+1.0f).isFinite();
* assertThat(1.0f).isFinite();
*
* // assertions fail
* assertThat(Float.NaN).isFinite();
Expand Down Expand Up @@ -906,7 +906,7 @@ public SELF isFinite() {
* assertThat(Float.POSITIVE_INFINITY).isInfinite();
*
* // assertions fail
* assertThat(+1.0f).isInfinite();
* assertThat(1.0f).isInfinite();
* assertThat(Float.NaN).isInfinite();</code></pre>
*
* @return this assertion object.
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/assertj/core/api/AbstractIntArrayAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ public SELF containsExactly(int... values) {
* assertThat(new int[] { 1, 2, 3 }).containsExactly(new Integer[] { 1, 2, 3 });
*
* // assertion will fail as actual and expected order differ
* assertThat(new int[] { 1, 2, 3 }).containsExactly(new int[] { 1, 3, 2 });</code></pre>
* assertThat(new int[] { 1, 2, 3 }).containsExactly(new Integer[] { 1, 3, 2 });</code></pre>
*
* @param values the given values.
* @return {@code this} assertion object.
Expand Down Expand Up @@ -754,9 +754,9 @@ public SELF containsExactlyInAnyOrder(int... values) {
* assertThat(new int[] { 1, 2, 3 }).containsExactlyInAnyOrder(new Integer[] { 3, 2, 1 });
*
* // assertions will fail
* assertThat(new int[] { 1, 2 }).containsExactlyInAnyOrder(new Boolean[] { 1, 4 });
* assertThat(new int[] { 1 }).containsExactlyInAnyOrder(new Boolean[] { 4, 1 });
* assertThat(new int[] { 1, 2, 3 }).containsExactlyInAnyOrder(new Boolean[] { 1, 2 });</code></pre>
* assertThat(new int[] { 1, 2 }).containsExactlyInAnyOrder(new Integer[] { 1, 4 });
* assertThat(new int[] { 1 }).containsExactlyInAnyOrder(new Integer[] { 4, 1 });
* assertThat(new int[] { 1, 2, 3 }).containsExactlyInAnyOrder(new Integer[] { 1, 2 });</code></pre>
*
* @param values the given values.
* @return {@code this} assertion object.
Expand Down

0 comments on commit 67822a4

Please sign in to comment.