Skip to content

Commit

Permalink
Minor javadoc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@joel-costigliola @scordio
joel-costigliola authored and scordio committed Aug 14, 2020
1 parent 542612c commit 7e64a5f
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
54 changes: 27 additions & 27 deletions src/main/java/org/assertj/core/api/AbstractCharSequenceAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,7 @@ public SELF hasSameSizeAs(Iterable<?> other) {
/**
* Verifies that the actual {@code CharSequence} is equal to the given one, ignoring case considerations.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Gandalf the grey&quot;).isEqualToIgnoringCase(&quot;GaNdAlF tHe GREY&quot;);
* assertThat(&quot;Gandalf the grey&quot;).isEqualToIgnoringCase(&quot;Gandalf the grey&quot;);
Expand All @@ -580,7 +580,7 @@ public SELF isEqualToIgnoringCase(CharSequence expected) {
/**
* Verifies that the actual {@code CharSequence} is not equal to the given one, ignoring case considerations.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat("Gandalf").isNotEqualToIgnoringCase("Hobbit");
* assertThat("Gandalf").isNotEqualToIgnoringCase("HOBit");
Expand Down Expand Up @@ -623,7 +623,7 @@ public SELF containsOnlyDigits() {
/**
* Verifies that the actual {@code CharSequence} contains the given sequence <b>only once</b>.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).containsOnlyOnce(&quot;do&quot;);
*
Expand Down Expand Up @@ -801,7 +801,7 @@ public SELF containsSubsequence(Iterable<? extends CharSequence> values) {
/**
* Verifies that the actual {@code CharSequence} contains the given sequence, ignoring case considerations.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Gandalf the grey&quot;).containsIgnoringCase(&quot;gandalf&quot;);
*
Expand All @@ -822,7 +822,7 @@ public SELF containsIgnoringCase(CharSequence sequence) {
/**
* Verifies that the actual {@code CharSequence} does not contain any of the given values.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotContain(&quot;pippin&quot;)
* .doesNotContain(&quot;fro&quot;, &quot;sam&quot;);
Expand All @@ -846,7 +846,7 @@ public SELF doesNotContain(CharSequence... values) {
/**
* Verifies that the actual {@code CharSequence} does not contain any of the given Iterable.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotContain(Arrays.asList(&quot;&quot;))
* .doesNotContain(Arrays.asList(&quot;fro&quot;, &quot;sam&quot;));
Expand All @@ -869,7 +869,7 @@ public SELF doesNotContain(Iterable<? extends CharSequence> values) {
/**
* Verifies that the actual {@code CharSequence} does not contain any of the given values, ignoring case considerations.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot;Frodo&quot;).doesNotContainIgnoringCase(&quot;pippin&quot;)
* .doesNotContainIgnoringCase(&quot;Merry&quot;, &quot;sam&quot;);
Expand Down Expand Up @@ -897,7 +897,7 @@ public SELF doesNotContainIgnoringCase(CharSequence... values) {
/**
* Verifies that the actual {@code CharSequence} does not contain the given regular expression.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotContainPattern(&quot;Fr.ud&quot;);
*
Expand All @@ -920,7 +920,7 @@ public SELF doesNotContainPattern(CharSequence pattern) {
/**
* Verifies that the actual {@code CharSequence} does not contain the given regular expression.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotContainPattern(Pattern.compile(&quot;Fr.ud&quot;));
*
Expand All @@ -942,7 +942,7 @@ public SELF doesNotContainPattern(Pattern pattern) {
/**
* Verifies that the actual {@code CharSequence} starts with the given prefix.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot;Frodo&quot;).startsWith(&quot;Fro&quot;);
* assertThat(&quot;Gandalf the grey&quot;).startsWith(&quot;Gandalf&quot;);
Expand Down Expand Up @@ -988,7 +988,7 @@ public SELF doesNotStartWith(CharSequence prefix) {
/**
* Verifies that the actual {@code CharSequence} ends with the given suffix.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).endsWith(&quot;do&quot;);
*
Expand Down Expand Up @@ -1031,7 +1031,7 @@ public SELF doesNotEndWith(CharSequence suffix) {
/**
* Verifies that the actual {@code CharSequence} matches the given regular expression.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).matches(&quot;..o.o&quot;);
*
Expand All @@ -1053,7 +1053,7 @@ public SELF matches(CharSequence regex) {
/**
* Verifies that the actual {@code CharSequence} does not match the given regular expression.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotMatch(&quot;.*d&quot;);
*
Expand All @@ -1075,7 +1075,7 @@ public SELF doesNotMatch(CharSequence regex) {
/**
* Verifies that the actual {@code CharSequence} matches the given regular expression pattern.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).matches(Pattern.compile(&quot;..o.o&quot;));
*
Expand All @@ -1096,7 +1096,7 @@ public SELF matches(Pattern pattern) {
/**
* Verifies that the actual {@code CharSequence} does not match the given regular expression pattern.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).doesNotMatch(Pattern.compile(&quot;.*d&quot;));
*
Expand All @@ -1117,7 +1117,7 @@ public SELF doesNotMatch(Pattern pattern) {
* Verifies that the actual {@code CharSequence} is equal to the given XML {@code CharSequence} after both have been
* formatted the same way.
* <p>
* Example :
* Example:
* <pre><code class='java'> String expectedXml =
* &quot;&lt;rings&gt;\n&quot; +
* &quot; &lt;bearer&gt;\n&quot; +
Expand Down Expand Up @@ -1167,7 +1167,7 @@ public SELF isXmlEqualTo(CharSequence expectedXml) {
* <p>
* This is an handy shortcut that calls : {@code isXmlEqualTo(contentOf(xmlFile))}
* </p>
* Example :
* Example:
* <pre><code class='java'> // You can easily compare your XML String to the content of an XML file, whatever how formatted they are.
* String oneLineXml = &quot;&lt;rings&gt;&lt;bearer&gt;&lt;name&gt;Frodo&lt;/name&gt;&lt;ring&gt;&lt;name&gt;one ring&lt;/name&gt;&lt;createdBy&gt;Sauron&lt;/createdBy&gt;&lt;/ring&gt;&lt;/bearer&gt;&lt;/rings&gt;&quot;;
* assertThat(oneLineXml).isXmlEqualToContentOf(new File(&quot;src/test/resources/formatted.xml&quot;));</code></pre>
Expand Down Expand Up @@ -1296,7 +1296,7 @@ public SELF isEqualToIgnoringWhitespace(CharSequence expected) {
/**
* Verifies that the actual {@code CharSequence} is not equal to the given one, ignoring whitespace differences.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot; my\tfoo bar &quot;).isNotEqualToIgnoringWhitespace(&quot;myfoo&quot;);
* assertThat(&quot; my\tfoo&quot;).isNotEqualToIgnoringWhitespace(&quot; my bar&quot;);
Expand Down Expand Up @@ -1328,7 +1328,7 @@ public SELF isNotEqualToIgnoringWhitespace(CharSequence expected) {
* <li>any remaining whitespace, appearing within either string, is collapsed to a single space before comparison</li>
* </ul>
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat("Game of Thrones").isEqualToNormalizingWhitespace("Game of Thrones")
* .isEqualToNormalizingWhitespace("Game of Thrones")
Expand Down Expand Up @@ -1363,7 +1363,7 @@ public SELF isEqualToNormalizingWhitespace(CharSequence expected) {
* <li>any remaining whitespace, appearing within either string, is collapsed to a single space before comparison</li>
* </ul>
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot; my\tfoo&quot;).isNotEqualToNormalizingWhitespace(&quot; my bar&quot;);
* assertThat(&quot; my\tfoo bar &quot;).isNotEqualToNormalizingWhitespace(&quot; my foobar&quot;);
Expand Down Expand Up @@ -1397,7 +1397,7 @@ public SELF isNotEqualToNormalizingWhitespace(CharSequence expected) {
* <li>Punctuation is any of the following character <b>{@code !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~}</b></li>
* </ul>
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat("Game'of'Thrones").isEqualToNormalizingPunctuationAndWhitespace("GameofThrones")
* assertThat("Game of Throne's").isEqualToNormalizingPunctuationAndWhitespace("Game of Thrones")
Expand Down Expand Up @@ -1427,7 +1427,7 @@ public SELF isEqualToNormalizingPunctuationAndWhitespace(CharSequence expected)
/**
* Verifies that the actual {@code CharSequence} is a substring of the given one (opposite assertion of {@link #contains(CharSequence...) contains(CharSequence cs)}.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot;Lego&quot;).isSubstringOf(&quot;Legolas&quot;);
* assertThat(&quot;Legolas&quot;).isSubstringOf(&quot;Legolas&quot;);
Expand All @@ -1447,7 +1447,7 @@ public SELF isSubstringOf(CharSequence sequence) {
/**
* Verifies that the actual {@code CharSequence} contains the given regular expression.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).containsPattern(&quot;Fr.d&quot;);
*
Expand All @@ -1469,7 +1469,7 @@ public SELF containsPattern(CharSequence regex) {
/**
* Verifies that the actual {@code CharSequence} contains the given regular expression pattern.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertion will pass
* assertThat(&quot;Frodo&quot;).containsPattern(Pattern.compile(&quot;Fr.d&quot;));
*
Expand Down Expand Up @@ -1514,7 +1514,7 @@ public SELF isEqualToNormalizingNewlines(CharSequence expected) {
/**
* Verifies that the actual {@code CharSequence} is equal to the given one after both strings new lines (\n, \r\n) have been removed.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat("Some textWith new lines").isEqualToIgnoringNewLines("Some text\nWith new lines")
* .isEqualToIgnoringNewLines("Some text\r\nWith new lines")
Expand All @@ -1540,7 +1540,7 @@ public SELF isEqualToIgnoringNewLines(CharSequence expected) {
/**
* Verifies that the actual {@code CharSequence} is a lowercase {@code CharSequence} by comparing it to a lowercase {@code actual} built with {@link String#toLowerCase()}.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot;lego&quot;).isLowerCase();
* assertThat("").isLowerCase();
Expand All @@ -1564,7 +1564,7 @@ public SELF isLowerCase() {
/**
* Verifies that the actual {@code CharSequence} is a uppercase {@code CharSequence} by comparing it to an uppercase {@code actual} built with {@link String#toUpperCase()}.
* <p>
* Example :
* Example:
* <pre><code class='java'> // assertions will pass
* assertThat(&quot;LEGO&quot;).isUpperCase();
* assertThat("").isUpperCase();
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/assertj/core/api/AbstractInputStreamAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public SELF hasSameContentAs(InputStream expected) {
}

/**
* Verifies whether the content of the actual {@code InputStream} is empty.
* Verifies that the content of the actual {@code InputStream} is empty.
* <p>
* Example:
* <pre><code class='java'> // assertion will pass
Expand All @@ -102,7 +102,7 @@ public SELF isEmpty() {
}

/**
* Verifies whether the content of the actual {@code InputStream} is not empty.
* Verifies that the content of the actual {@code InputStream} is not empty.
* <p>
* Example:
* <pre><code class='java'> // assertion will pass
Expand Down

0 comments on commit 7e64a5f

Please sign in to comment.