JavaDoc only @return org.hamcrest.core

Author: nhojpatrick

hamcrest/src/main/java/org/hamcrest/core/AllOf.java

@@ -44,6 +44,8 @@ public void describeTo(Description description) {
      * Creates a matcher that matches if the examined object matches <b>ALL</b> of the specified matchers.
      * For example:
      * <pre>assertThat("myValue", allOf(startsWith("my"), containsString("Val")))</pre>
+     *
+     * @return The matcher.
      */
     public static <T> Matcher<T> allOf(Iterable<Matcher<? super T>> matchers) {
         return new AllOf<>(matchers);
@@ -53,6 +55,8 @@ public static <T> Matcher<T> allOf(Iterable<Matcher<? super T>> matchers) {
      * Creates a matcher that matches if the examined object matches <b>ALL</b> of the specified matchers.
      * For example:
      * <pre>assertThat("myValue", allOf(startsWith("my"), containsString("Val")))</pre>
+     *
+     * @return The matcher.
      */
     @SafeVarargs
     public static <T> Matcher<T> allOf(Matcher<? super T>... matchers) {

hamcrest/src/main/java/org/hamcrest/core/AnyOf.java

@@ -34,6 +34,8 @@ public void describeTo(Description description) {
      * Creates a matcher that matches if the examined object matches <b>ANY</b> of the specified matchers.
      * For example:
      * <pre>assertThat("myValue", anyOf(startsWith("foo"), containsString("Val")))</pre>
+     *
+     * @return The matcher.
      */
     public static <T> AnyOf<T> anyOf(Iterable<Matcher<? super T>> matchers) {
         return new AnyOf<>(matchers);
@@ -43,6 +45,8 @@ public static <T> AnyOf<T> anyOf(Iterable<Matcher<? super T>> matchers) {
      * Creates a matcher that matches if the examined object matches <b>ANY</b> of the specified matchers.
      * For example:
      * <pre>assertThat("myValue", anyOf(startsWith("foo"), containsString("Val")))</pre>
+     *
+     * @return The matcher.
      */
     @SafeVarargs
     public static <T> AnyOf<T> anyOf(Matcher<? super T>... matchers) {

hamcrest/src/main/java/org/hamcrest/core/CombinableMatcher.java

@@ -46,6 +46,8 @@ private ArrayList<Matcher<? super T>> templatedListWith(Matcher<? super T> other
    * Creates a matcher that matches when both of the specified matchers match the examined object.
    * For example:
    * <pre>assertThat("fab", both(containsString("a")).and(containsString("b")))</pre>
+   *
+   * @return The matcher.
    */
   public static <LHS> CombinableBothMatcher<LHS> both(Matcher<? super LHS> matcher) {
     return new CombinableBothMatcher<>(matcher);
@@ -65,6 +67,8 @@ public CombinableMatcher<X> and(Matcher<? super X> other) {
    * Creates a matcher that matches when either of the specified matchers match the examined object.
    * For example:
    * <pre>assertThat("fan", either(containsString("a")).or(containsString("b")))</pre>
+   *
+   * @return The matcher.
    */
   public static <LHS> CombinableEitherMatcher<LHS> either(Matcher<? super LHS> matcher) {
     return new CombinableEitherMatcher<>(matcher);

hamcrest/src/main/java/org/hamcrest/core/DescribedAs.java

@@ -62,6 +62,7 @@ public void describeMismatch(Object item, Description description) {
      *     the matcher to wrap
      * @param values
      *     optional values to insert into the tokenised description
+     * @return The matcher.
      */
     public static <T> Matcher<T> describedAs(String description, Matcher<T> matcher, Object... values) {
         return new DescribedAs<T>(description, matcher, values);

hamcrest/src/main/java/org/hamcrest/core/Every.java

@@ -37,6 +37,7 @@ public void describeTo(Description description) {
      *
      * @param itemMatcher
      *     the matcher to apply to every item provided by the examined {@link Iterable}
+     * @return The matcher.
      */
     public static <U> Matcher<Iterable<? extends U>> everyItem(final Matcher<U> itemMatcher) {
         return new Every<>(itemMatcher);

hamcrest/src/main/java/org/hamcrest/core/Is.java

@@ -42,6 +42,8 @@ public void describeMismatch(Object item, Description mismatchDescription) {
      * <pre>assertThat(cheese, is(equalTo(smelly)))</pre>
      * instead of:
      * <pre>assertThat(cheese, equalTo(smelly))</pre>
+     *
+     * @return The matcher.
      */
     public static <T> Matcher<T> is(Matcher<T> matcher) {
         return new Is<>(matcher);
@@ -53,6 +55,8 @@ public static <T> Matcher<T> is(Matcher<T> matcher) {
      * <pre>assertThat(cheese, is(smelly))</pre>
      * instead of:
      * <pre>assertThat(cheese, is(equalTo(smelly)))</pre>
+     *
+     * @return The matcher.
      */
     public static <T> Matcher<T> is(T value) {
         return is(equalTo(value));
@@ -64,6 +68,8 @@ public static <T> Matcher<T> is(T value) {
      * <pre>assertThat(cheese, isA(Cheddar.class))</pre>
      * instead of:
      * <pre>assertThat(cheese, is(instanceOf(Cheddar.class)))</pre>
+     *
+     * @return The matcher.
      */
     public static <T> Matcher<T> isA(Class<?> type) {
         return is(IsInstanceOf.<T>instanceOf(type));

hamcrest/src/main/java/org/hamcrest/core/IsAnything.java

@@ -32,6 +32,8 @@ public void describeTo(Description description) {
 
     /**
      * Creates a matcher that always matches, regardless of the examined object.
+     *
+     * @return The matcher.
      */
     public static Matcher<Object> anything() { return new IsAnything<>(); }
 
@@ -41,6 +43,7 @@ public void describeTo(Description description) {
      *
      * @param description
      *     a meaningful {@link String} used when describing itself
+     * @return The matcher.
      */
     public static Matcher<Object> anything(String description) {
         return new IsAnything<>(description);

hamcrest/src/main/java/org/hamcrest/core/IsCollectionContaining.java

@@ -38,6 +38,7 @@ public void describeTo(Description description) {
      *
      * @param itemMatcher
      *     the matcher to apply to items provided by the examined {@link Iterable}
+     * @return The matcher.
      */
     public static <T> Matcher<Iterable<? super T>> hasItem(Matcher<? super T> itemMatcher) {
         return IsIterableContaining.hasItem(itemMatcher);
@@ -55,6 +56,7 @@ public static <T> Matcher<Iterable<? super T>> hasItem(Matcher<? super T> itemMa
      *
      * @param item
      *     the item to compare against the items provided by the examined {@link Iterable}
+     * @return The matcher.
      */
     public static <T> Matcher<Iterable<? super T>> hasItem(T item) {
         // Doesn't forward to hasItem() method so compiler can sort out generics.
@@ -73,6 +75,7 @@ public static <T> Matcher<Iterable<? super T>> hasItem(T item) {
      *
      * @param itemMatchers
      *     the matchers to apply to items provided by the examined {@link Iterable}
+     * @return The matcher.
      */
     @SafeVarargs
     public static <T> Matcher<Iterable<T>> hasItems(Matcher<? super T>... itemMatchers) {
@@ -91,6 +94,7 @@ public static <T> Matcher<Iterable<T>> hasItems(Matcher<? super T>... itemMatche
      *
      * @param items
      *     the items to compare against the items provided by the examined {@link Iterable}
+     * @return The matcher.
      */
     @SafeVarargs
     public static <T> Matcher<Iterable<T>> hasItems(T... items) {

hamcrest/src/main/java/org/hamcrest/core/IsEqual.java

@@ -81,6 +81,8 @@ private static boolean isArray(Object o) {
      * assertThat("foo", equalTo("foo"));
      * assertThat(new String[] {"foo", "bar"}, equalTo(new String[] {"foo", "bar"}));
      * </pre>
+     *
+     * @return The matcher.
      */
     public static <T> Matcher<T> equalTo(T operand) {
         return new IsEqual<>(operand);
@@ -89,6 +91,8 @@ public static <T> Matcher<T> equalTo(T operand) {
     /**
      * Creates an {@link org.hamcrest.core.IsEqual} matcher that does not enforce the values being
      * compared to be of the same static type.
+     *
+     * @return The matcher.
      */
     public static Matcher<Object> equalToObject(Object operand) {
         return new IsEqual<>(operand);

hamcrest/src/main/java/org/hamcrest/core/IsInstanceOf.java

@@ -64,6 +64,8 @@ public void describeTo(Description description) {
      * <p>The created matcher assumes no relationship between specified type and the examined object.</p>
      * For example:
      * <pre>assertThat(new Canoe(), instanceOf(Paddlable.class));</pre>
+     *
+     * @return The matcher.
      */
     @SuppressWarnings("unchecked")
     public static <T> Matcher<T> instanceOf(Class<?> type) {
@@ -80,6 +82,8 @@ public static <T> Matcher<T> instanceOf(Class<?> type) {
      * <code>with(any(Thing.class))</code></p>
      * For example:
      * <pre>assertThat(new Canoe(), instanceOf(Canoe.class));</pre>
+     *
+     * @return The matcher.
      */
     @SuppressWarnings("unchecked")
     public static <T> Matcher<T> any(Class<T> type) {