JavaDoc only @return org.hamcrest.text

Author: nhojpatrick

hamcrest/src/main/java/org/hamcrest/text/CharSequenceLength.java

@@ -33,6 +33,7 @@ protected Integer featureValueOf(CharSequence actual) {
      * </pre>
      *
      * @param length the expected length of the string
+     * @return The matcher.
      */
     public static Matcher<CharSequence> hasLength(int length) {
         return new CharSequenceLength(equalTo(length));
@@ -47,6 +48,7 @@ public static Matcher<CharSequence> hasLength(int length) {
       * </pre>
       *
       * @param lengthMatcher the expected length of the string
+      * @return The matcher.
       */
      @SuppressWarnings("WeakerAccess")
      public static Matcher<CharSequence> hasLength(Matcher<? super Integer> lengthMatcher) {

hamcrest/src/main/java/org/hamcrest/text/IsBlankString.java

@@ -37,6 +37,8 @@ public void describeTo(Description description) {
      * zero or more whitespace characters and nothing else.
      * For example:
      * <pre>assertThat("  ", is(blankString()))</pre>
+     *
+     * @return The matcher.
      */
     public static Matcher<String> blankString() {
         return BLANK_INSTANCE;
@@ -47,6 +49,8 @@ public static Matcher<String> blankString() {
      * contains zero or more whitespace characters and nothing else.
      * For example:
      * <pre>assertThat(((String)null), is(blankOrNullString()))</pre>
+     *
+     * @return The matcher.
      */
     public static Matcher<String> blankOrNullString() {
         return NULL_OR_BLANK_INSTANCE;

hamcrest/src/main/java/org/hamcrest/text/IsEmptyString.java

@@ -34,6 +34,7 @@ public void describeTo(Description description) {
      * <pre>assertThat("", isEmptyString())</pre>
      *
      * @deprecated use is(emptyString()) instead
+     * @return The matcher.
      */
     @Deprecated
     public static Matcher<String> isEmptyString() {
@@ -44,6 +45,8 @@ public static Matcher<String> isEmptyString() {
      * Creates a matcher of {@link String} that matches when the examined string has zero length.
      * For example:
      * <pre>assertThat("", is(emptyString()))</pre>
+     *
+     * @return The matcher.
      */
     public static Matcher<String> emptyString() {
         return INSTANCE;
@@ -56,6 +59,7 @@ public static Matcher<String> emptyString() {
      * <pre>assertThat(((String)null), isEmptyOrNullString())</pre>
      *
      * @deprecated use is(emptyOrNullString()) instead
+     * @return The matcher.
      */
     @Deprecated
     public static Matcher<String> isEmptyOrNullString() {
@@ -67,6 +71,8 @@ public static Matcher<String> isEmptyOrNullString() {
      * has zero length.
      * For example:
      * <pre>assertThat(((String)null), is(emptyOrNullString()))</pre>
+     *
+     * @return The matcher.
      */
     public static Matcher<String> emptyOrNullString() {
         return NULL_OR_EMPTY_INSTANCE;

hamcrest/src/main/java/org/hamcrest/text/IsEqualCompressingWhiteSpace.java

@@ -46,6 +46,7 @@ public String stripSpaces(String toBeStripped) {
      * @deprecated {@link #equalToCompressingWhiteSpace(String)}
      * @param expectedString
      *     the expected value of matched strings
+     * @return The matcher.
      */
     public static Matcher<String> equalToIgnoringWhiteSpace(String expectedString) {
         return new IsEqualCompressingWhiteSpace(expectedString);
@@ -64,6 +65,7 @@ public static Matcher<String> equalToIgnoringWhiteSpace(String expectedString) {
      *
      * @param expectedString
      *     the expected value of matched strings
+     * @return The matcher.
      */
     public static Matcher<String> equalToCompressingWhiteSpace(String expectedString) {
         return new IsEqualCompressingWhiteSpace(expectedString);

hamcrest/src/main/java/org/hamcrest/text/IsEqualIgnoringCase.java

@@ -46,6 +46,7 @@ public void describeTo(Description description) {
      *
      * @param expectedString
      *     the expected value of matched strings
+     * @return The matcher.
      */
     public static Matcher<String> equalToIgnoringCase(String expectedString) {
         return new IsEqualIgnoringCase(expectedString);

hamcrest/src/main/java/org/hamcrest/text/MatchesPattern.java

@@ -26,6 +26,8 @@ public void describeTo(Description description) {
     /**
      * Creates a matcher of {@link java.lang.String} that matches when the examined string
      * exactly matches the given {@link java.util.regex.Pattern}.
+     *
+     * @return The matcher.
      */
     public static Matcher<String> matchesPattern(Pattern pattern) {
         return new MatchesPattern(pattern);
@@ -34,6 +36,8 @@ public static Matcher<String> matchesPattern(Pattern pattern) {
     /**
      * Creates a matcher of {@link java.lang.String} that matches when the examined string
      * exactly matches the given regular expression, treated as a {@link java.util.regex.Pattern}.
+     *
+     * @return The matcher.
      */
     public static Matcher<String> matchesPattern(String regex) {
         return new MatchesPattern(Pattern.compile(regex));

hamcrest/src/main/java/org/hamcrest/text/StringContainsInOrder.java

@@ -49,6 +49,7 @@ public void describeTo(Description description) {
      *
      * @param substrings
      *     the substrings that must be contained within matching strings
+     * @return The matcher.
      */
     public static Matcher<String> stringContainsInOrder(Iterable<String> substrings) {
         return new StringContainsInOrder(substrings);
@@ -63,6 +64,7 @@ public static Matcher<String> stringContainsInOrder(Iterable<String> substrings)
      *
      * @param substrings
      *     the substrings that must be contained within matching strings
+     * @return The matcher.
      */
     public static Matcher<String> stringContainsInOrder(String... substrings) {
         return new StringContainsInOrder(Arrays.asList(substrings));