JavaDoc only @return

Author: nhojpatrick

hamcrest-integration/src/main/java/org/hamcrest/integration/EasyMock2Adapter.java

@@ -18,6 +18,8 @@ public class EasyMock2Adapter implements IArgumentMatcher {
      * Hamcrest {@link org.hamcrest.Matcher} to act as an
      * EasyMock {@link org.easymock.IArgumentMatcher} and
      * report it to EasyMock so it can be kept track of.
+     *
+     * @return The EasyMock matcher.
      */
     public static IArgumentMatcher adapt(Matcher<?> matcher) {
         EasyMock2Adapter easyMock2Matcher = new EasyMock2Adapter(matcher);

hamcrest-integration/src/main/java/org/hamcrest/integration/JMock1Adapter.java

@@ -18,6 +18,8 @@ public class JMock1Adapter implements Constraint {
      * Convenience factory method that will adapt a
      * Hamcrest {@link org.hamcrest.Matcher} to act as an
      * jMock {@link org.jmock.core.Constraint}.
+     *
+     * @return The jMock constraint.
      */
     public static Constraint adapt(Matcher<?> matcher) {
         return new JMock1Adapter(matcher);

hamcrest/src/main/java/org/hamcrest/TypeSafeDiagnosingMatcher.java

@@ -21,6 +21,8 @@ public abstract class TypeSafeDiagnosingMatcher<T> extends BaseMatcher<T> {
     /**
      * Subclasses should implement this. The item will already have been checked
      * for the specific type and will never be null.
+     *
+     * @return boolean true/false depending if item matches matcher.
      */
     protected abstract boolean matchesSafely(T item, Description mismatchDescription);
 

hamcrest/src/main/java/org/hamcrest/TypeSafeMatcher.java

@@ -43,6 +43,8 @@ protected TypeSafeMatcher(ReflectiveTypeFinder typeFinder) {
     /**
      * Subclasses should implement this. The item will already have been checked for
      * the specific type and will never be null.
+     *
+     * @return boolean true/false depending if item matches matcher.
      */
     protected abstract boolean matchesSafely(T item);
 

hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java

@@ -48,6 +48,7 @@ public void describeTo(Description description) {
      *
      * @param propertyName
      *     the name of the JavaBean property that examined beans should possess
+     * @return The matcher.
      */
     public static <T> Matcher<T> hasProperty(String propertyName) {
         return new HasProperty<T>(propertyName);

hamcrest/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java

@@ -159,6 +159,7 @@ public Condition<Method> apply(PropertyDescriptor property, Description mismatch
      *     the name of the JavaBean property that examined beans should possess
      * @param valueMatcher
      *     a matcher for the value of the specified property of the examined bean
+     * @return The matcher.
      */
     public static <T> Matcher<T> hasProperty(String propertyName, Matcher<?> valueMatcher) {
         return new HasPropertyWithValue<>(propertyName, valueMatcher);
@@ -176,6 +177,7 @@ public static <T> Matcher<T> hasProperty(String propertyName, Matcher<?> valueMa
      *     the dot-separated path from the examined object to the JavaBean property
      * @param valueMatcher
      *     a matcher for the value of the specified property of the examined bean
+     * @return The matcher.
      */
     public static <T> Matcher<T> hasPropertyAtPath(String path, Matcher<T> valueMatcher) {
         List<String> properties = Arrays.asList(path.split("\\."));

hamcrest/src/main/java/org/hamcrest/beans/SamePropertyValuesAs.java

@@ -151,6 +151,7 @@ private static Object readProperty(Method method, Object target) {
      *     the bean against which examined beans are compared
      * @param ignoredProperties
      *     do not check any of these named properties.
+     * @return The matcher.
      */
     public static <B> Matcher<B> samePropertyValuesAs(B expectedBean, String... ignoredProperties) {
         return new SamePropertyValuesAs<>(expectedBean, asList(ignoredProperties));

hamcrest/src/main/java/org/hamcrest/collection/ArrayMatching.java

@@ -26,6 +26,7 @@ public class ArrayMatching {
    *
    * @param elementMatcher
    *     the matcher to apply to elements in examined arrays
+   * @return The matcher.
    */
   public static <T> Matcher<T[]> hasItemInArray(Matcher<? super T> elementMatcher) {
       return new HasItemInArray<>(elementMatcher);
@@ -40,6 +41,7 @@ public static <T> Matcher<T[]> hasItemInArray(Matcher<? super T> elementMatcher)
    *
    * @param element
    *     the element that should be present in examined arrays
+   * @return The matcher.
    */
   public static <T> Matcher<T[]> hasItemInArray(T element) {
     return hasItemInArray(equalTo(element));
@@ -64,6 +66,7 @@ public static <T> Matcher<T[]> hasItemInArray(T element) {
    *
    * @param itemMatchers
    *     a list of matchers, each of which must be satisfied by an entry in an examined array
+   * @return The matcher.
    */
   @SafeVarargs
   public static <E> Matcher<E[]> arrayContainingInAnyOrder(Matcher<? super E>... itemMatchers) {
@@ -89,6 +92,7 @@ public static <E> Matcher<E[]> arrayContainingInAnyOrder(Matcher<? super E>... i
    *
    * @param itemMatchers
    *     a list of matchers, each of which must be satisfied by an item provided by an examined array
+   * @return The matcher.
    */
   public static <E> Matcher<E[]> arrayContainingInAnyOrder(Collection<Matcher<? super E>> itemMatchers) {
     return new ArrayAsIterableMatcher<>(new IsIterableContainingInAnyOrder<>(itemMatchers), itemMatchers, "in any order");
@@ -111,6 +115,7 @@ public static <E> Matcher<E[]> arrayContainingInAnyOrder(Collection<Matcher<? su
    *
    * @param items
    *     the items that must equal the entries of an examined array, in any order
+   * @return The matcher.
    */
   @SafeVarargs
   public static <E> Matcher<E[]> arrayContainingInAnyOrder(E... items) {
@@ -126,6 +131,7 @@ public static <E> Matcher<E[]> arrayContainingInAnyOrder(E... items) {
    *
    * @param items
    *     the items that must equal the items within an examined array
+   * @return The matcher.
    */
   @SafeVarargs
   public static <E> Matcher<E[]> arrayContaining(E... items) {
@@ -140,6 +146,7 @@ public static <E> Matcher<E[]> arrayContaining(E... items) {
    *
    * @param itemMatchers
    *     the matchers that must be satisfied by the items in the examined array
+   * @return The matcher.
    */
   @SafeVarargs
   public static <E> Matcher<E[]> arrayContaining(Matcher<? super E>... itemMatchers) {
@@ -159,6 +166,7 @@ public static <E> Matcher<E[]> arrayContaining(Matcher<? super E>... itemMatcher
    *
    * @param itemMatchers
    *     a list of matchers, each of which must be satisfied by the corresponding item in an examined array
+   * @return The matcher.
    */
   public static <E> Matcher<E[]> arrayContaining(List<Matcher<? super E>> itemMatchers) {
       return new ArrayAsIterableMatcher<>(new IsIterableContainingInOrder<>(itemMatchers), itemMatchers, "");

hamcrest/src/main/java/org/hamcrest/collection/IsArray.java

@@ -55,6 +55,8 @@ public void describeTo(Description description) {
      *
      * Can be overridden in subclasses to customise how the matcher is
      * described.
+     *
+     * @return The description prefix.
      */
     protected String descriptionStart() {
         return "[";
@@ -65,6 +67,8 @@ protected String descriptionStart() {
      *
      * Can be overridden in subclasses to customise how the matcher is
      * described.
+     *
+     * @return The description separator.
      */
     protected String descriptionSeparator() {
         return ", ";
@@ -75,6 +79,8 @@ protected String descriptionSeparator() {
      *
      * Can be overridden in subclasses to customise how the matcher is
      * described.
+     *
+     * @return The description suffix.
      */
     protected String descriptionEnd() {
         return "]";
@@ -89,6 +95,7 @@ protected String descriptionEnd() {
      *
      * @param elementMatchers
      *     the matchers that the elements of examined arrays should satisfy
+     * @return The matcher.
      */
     public static <T> IsArray<T> array(Matcher<? super T>... elementMatchers) {
         return new IsArray<T>(elementMatchers);

hamcrest/src/main/java/org/hamcrest/collection/IsArrayContainingInAnyOrder.java

@@ -57,6 +57,7 @@ public void describeTo(Description description) {
      *
      * @param itemMatchers
      *     a list of matchers, each of which must be satisfied by an entry in an examined array
+     * @return The matcher.
      */
     public static <E> Matcher<E[]> arrayContainingInAnyOrder(Matcher<? super E>... itemMatchers) {
         return arrayContainingInAnyOrder(Arrays.asList(itemMatchers));
@@ -79,6 +80,7 @@ public static <E> Matcher<E[]> arrayContainingInAnyOrder(Matcher<? super E>... i
      *
      * @param itemMatchers
      *     a list of matchers, each of which must be satisfied by an item provided by an examined array
+     * @return The matcher.
      */
     public static <E> Matcher<E[]> arrayContainingInAnyOrder(Collection<Matcher<? super E>> itemMatchers) {
         return new IsArrayContainingInAnyOrder<E>(itemMatchers);
@@ -101,6 +103,7 @@ public static <E> Matcher<E[]> arrayContainingInAnyOrder(Collection<Matcher<? su
      *
      * @param items
      *     the items that must equal the entries of an examined array, in any order
+     * @return The matcher.
      */
     public static <E> Matcher<E[]> arrayContainingInAnyOrder(E... items) {
       List<Matcher<? super E>> matchers = new ArrayList<Matcher<? super E>>();