From a82f91f9e61814eeb745ce0acce11cbd305bd56b Mon Sep 17 00:00:00 2001 From: John Patrick <142304+nhojpatrick@users.noreply.github.com> Date: Sun, 13 Feb 2022 14:01:59 +0000 Subject: [PATCH] JavaDoc only whitespace --- .../main/java/org/hamcrest/CoreMatchers.java | 4 ++-- .../java/org/hamcrest/SelfDescribing.java | 2 +- .../java/org/hamcrest/StringDescription.java | 2 +- .../java/org/hamcrest/beans/HasProperty.java | 2 +- .../hamcrest/beans/HasPropertyWithValue.java | 2 +- .../java/org/hamcrest/beans/PropertyUtil.java | 2 +- .../java/org/hamcrest/collection/IsArray.java | 8 +++---- .../hamcrest/collection/IsArrayWithSize.java | 5 ++-- .../collection/IsCollectionWithSize.java | 4 ++-- .../collection/IsEmptyCollection.java | 3 +-- .../hamcrest/collection/IsEmptyIterable.java | 3 +-- .../java/org/hamcrest/collection/IsIn.java | 24 +++++++------------ .../IsIterableContainingInAnyOrder.java | 6 ++--- .../IsIterableContainingInOrder.java | 8 +++---- .../IsIterableContainingInRelativeOrder.java | 6 ++--- .../collection/IsIterableWithSize.java | 4 ++-- .../hamcrest/collection/IsMapContaining.java | 12 +++++----- .../hamcrest/collection/IsMapWithSize.java | 5 ++-- .../java/org/hamcrest/core/DescribedAs.java | 2 +- .../main/java/org/hamcrest/core/Every.java | 2 +- .../src/main/java/org/hamcrest/core/Is.java | 3 --- .../hamcrest/core/IsCollectionContaining.java | 2 +- .../main/java/org/hamcrest/core/IsEqual.java | 5 ++-- .../java/org/hamcrest/core/IsInstanceOf.java | 6 ++--- .../hamcrest/core/IsIterableContaining.java | 8 +++---- .../main/java/org/hamcrest/core/IsNot.java | 4 ++-- .../main/java/org/hamcrest/core/IsNull.java | 7 ++---- .../org/hamcrest/core/StringContains.java | 4 +--- .../org/hamcrest/core/StringEndsWith.java | 2 +- .../org/hamcrest/core/StringStartsWith.java | 2 +- .../java/org/hamcrest/number/IsCloseTo.java | 2 +- .../java/org/hamcrest/object/HasToString.java | 4 ++-- .../org/hamcrest/object/IsCompatibleType.java | 2 +- .../java/org/hamcrest/object/IsEventFrom.java | 4 ++-- .../org/hamcrest/text/CharSequenceLength.java | 4 ++-- .../java/org/hamcrest/text/IsBlankString.java | 1 - .../java/org/hamcrest/text/IsEmptyString.java | 7 ++---- .../hamcrest/text/IsEqualIgnoringCase.java | 2 +- .../hamcrest/text/StringContainsInOrder.java | 2 +- .../main/java/org/hamcrest/xml/HasXPath.java | 8 +++---- 40 files changed, 80 insertions(+), 105 deletions(-) diff --git a/hamcrest/src/main/java/org/hamcrest/CoreMatchers.java b/hamcrest/src/main/java/org/hamcrest/CoreMatchers.java index 5e4e40fd..6691bab3 100644 --- a/hamcrest/src/main/java/org/hamcrest/CoreMatchers.java +++ b/hamcrest/src/main/java/org/hamcrest/CoreMatchers.java @@ -67,7 +67,7 @@ public static org.hamcrest.core.CombinableMatcher.CombinableEitherMatcher< * delegated to the decorated matcher, including its mismatch description. * For example: * 
describedAs("a big decimal equal to %0", equalTo(myBigDecimal), myBigDecimal.toPlainString())
- * + * * @param description * the new description for the wrapped matcher * @param matcher @@ -85,7 +85,7 @@ public static org.hamcrest.Matcher describedAs(java.lang.String descripti * itemMatcher. * For example: * 
assertThat(Arrays.asList("bar", "baz"), everyItem(startsWith("ba")))
- * + * * @param itemMatcher * the matcher to apply to every item provided by the examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/SelfDescribing.java b/hamcrest/src/main/java/org/hamcrest/SelfDescribing.java index 06b361d2..d3aa6db7 100644 --- a/hamcrest/src/main/java/org/hamcrest/SelfDescribing.java +++ b/hamcrest/src/main/java/org/hamcrest/SelfDescribing.java @@ -8,7 +8,7 @@ public interface SelfDescribing { * Generates a description of the object. The description may be part of a * a description of a larger object of which this is just a component, so it * should be worded appropriately. - * + * * @param description * The description to be built or appended to. */ diff --git a/hamcrest/src/main/java/org/hamcrest/StringDescription.java b/hamcrest/src/main/java/org/hamcrest/StringDescription.java index 813c1782..7aac98d1 100644 --- a/hamcrest/src/main/java/org/hamcrest/StringDescription.java +++ b/hamcrest/src/main/java/org/hamcrest/StringDescription.java @@ -18,7 +18,7 @@ public StringDescription(Appendable out) { /** * Return the description of a {@link SelfDescribing} object as a String. - * + * * @param selfDescribing * The object to be described. * @return diff --git a/hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java b/hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java index 320a49ef..7f2f2687 100644 --- a/hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java +++ b/hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java @@ -45,7 +45,7 @@ public void describeTo(Description description) { * with the specified name. * For example: * 
assertThat(myBean, hasProperty("foo"))
- * + * * @param propertyName * the name of the JavaBean property that examined beans should possess */ diff --git a/hamcrest/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java b/hamcrest/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java index 29b299b8..b9e33d22 100644 --- a/hamcrest/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java +++ b/hamcrest/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java @@ -154,7 +154,7 @@ public Condition apply(PropertyDescriptor property, Description mismatch * with the specified name whose value satisfies the specified matcher. * For example: * 
assertThat(myBean, hasProperty("foo", equalTo("bar"))
- * + * * @param propertyName * the name of the JavaBean property that examined beans should possess * @param valueMatcher diff --git a/hamcrest/src/main/java/org/hamcrest/beans/PropertyUtil.java b/hamcrest/src/main/java/org/hamcrest/beans/PropertyUtil.java index 946c4f84..d1564653 100644 --- a/hamcrest/src/main/java/org/hamcrest/beans/PropertyUtil.java +++ b/hamcrest/src/main/java/org/hamcrest/beans/PropertyUtil.java @@ -33,7 +33,7 @@ public static PropertyDescriptor getPropertyDescriptor(String propertyName, Obje /** * Returns all the property descriptors for the class associated with the given object - * + * * @param fromObj Use the class of this object * @param stopClass Don't include any properties from this ancestor class upwards. * @return Property descriptors diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsArray.java b/hamcrest/src/main/java/org/hamcrest/collection/IsArray.java index 38f5d915..8fbd93b4 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsArray.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsArray.java @@ -52,7 +52,7 @@ public void describeTo(Description description) { /** * Returns the string that starts the description. - * + * * Can be overridden in subclasses to customise how the matcher is * described. */ @@ -62,7 +62,7 @@ protected String descriptionStart() { /** * Returns the string that separates the elements in the description. - * + * * Can be overridden in subclasses to customise how the matcher is * described. */ @@ -72,7 +72,7 @@ protected String descriptionSeparator() { /** * Returns the string that ends the description. - * + * * Can be overridden in subclasses to customise how the matcher is * described. */ @@ -86,7 +86,7 @@ protected String descriptionEnd() { * each matcher[i] is satisfied by array[i]. * For example: * 
assertThat(new Integer[]{1,2,3}, is(array(equalTo(1), equalTo(2), equalTo(3))))
- * + * * @param elementMatchers * the matchers that the elements of examined arrays should satisfy */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsArrayWithSize.java b/hamcrest/src/main/java/org/hamcrest/collection/IsArrayWithSize.java index 4ae7235e..14695a67 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsArrayWithSize.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsArrayWithSize.java @@ -24,7 +24,7 @@ protected Integer featureValueOf(E[] actual) { * satisfies the specified matcher. * For example: * 
assertThat(new String[]{"foo", "bar"}, arrayWithSize(equalTo(2)))
- * + * * @param sizeMatcher * a matcher for the length of an examined array */ @@ -37,7 +37,7 @@ public static Matcher arrayWithSize(Matcher sizeMatche * equals the specified size. * For example: * 
assertThat(new String[]{"foo", "bar"}, arrayWithSize(2))
- * + * * @param size * the length that an examined array must have for a positive match */ @@ -50,7 +50,6 @@ public static Matcher arrayWithSize(int size) { * is zero. * For example: * 
assertThat(new String[0], emptyArray())
- * */ public static Matcher emptyArray() { return describedAs("an empty array", IsArrayWithSize.arrayWithSize(0)); diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsCollectionWithSize.java b/hamcrest/src/main/java/org/hamcrest/collection/IsCollectionWithSize.java index f79afdc6..ccb3798e 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsCollectionWithSize.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsCollectionWithSize.java @@ -25,7 +25,7 @@ protected Integer featureValueOf(Collection actual) { * a value that satisfies the specified matcher. * For example: * 
assertThat(Arrays.asList("foo", "bar"), hasSize(equalTo(2)))
- * + * * @param sizeMatcher * a matcher for the size of an examined {@link java.util.Collection} */ @@ -38,7 +38,7 @@ public static Matcher> hasSize(Matchersize. * For example: * 
assertThat(Arrays.asList("foo", "bar"), hasSize(2))
- * + * * @param size * the expected size of an examined {@link java.util.Collection} */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyCollection.java b/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyCollection.java index 481b08c3..217c9682 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyCollection.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyCollection.java @@ -31,7 +31,6 @@ public void describeTo(Description description) { * method returns true. * For example: * 
assertThat(new ArrayList<String>(), is(empty()))
- * */ public static Matcher> empty() { return new IsEmptyCollection(); @@ -42,7 +41,7 @@ public static Matcher> empty() { * method returns true. * For example: * 
assertThat(new ArrayList<String>(), is(emptyCollectionOf(String.class)))
- * + * * @param unusedToForceReturnType * the type of the collection's content */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyIterable.java b/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyIterable.java index 047e670c..9900ebd3 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyIterable.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsEmptyIterable.java @@ -27,7 +27,6 @@ public void describeTo(Description description) { * Creates a matcher for {@link Iterable}s matching examined iterables that yield no items. * For example: * 
assertThat(new ArrayList<String>(), is(emptyIterable()))
- * */ public static Matcher> emptyIterable() { return new IsEmptyIterable(); @@ -37,7 +36,7 @@ public static Matcher> emptyIterable() { * Creates a matcher for {@link Iterable}s matching examined iterables that yield no items. * For example: * 
assertThat(new ArrayList<String>(), is(emptyIterableOf(String.class)))
- * + * * @param unusedToForceReturnType * the type of the iterable's content */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsIn.java b/hamcrest/src/main/java/org/hamcrest/collection/IsIn.java index 84098110..aa133013 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsIn.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsIn.java @@ -35,12 +35,11 @@ public void describeTo(Description buffer) { * specified collection. * For example: * 
assertThat("foo", isIn(Arrays.asList("bar", "foo")))
- * + * * @deprecated use is(in(...)) instead - * + * * @param collection * the collection in which matching items must be found - * */ @Deprecated public static Matcher isIn(Collection collection) { @@ -52,10 +51,9 @@ public static Matcher isIn(Collection collection) { * specified collection. * For example: * 
assertThat("foo", is(in(Arrays.asList("bar", "foo"))))
- * + * * @param collection * the collection in which matching items must be found - * */ public static Matcher in(Collection collection) { return new IsIn<>(collection); @@ -66,12 +64,11 @@ public static Matcher in(Collection collection) { * specified array. * For example: * 
assertThat("foo", isIn(new String[]{"bar", "foo"}))
- * + * * @deprecated use is(in(...)) instead - * + * * @param elements * the array in which matching items must be found - * */ @Deprecated public static Matcher isIn(T[] elements) { @@ -83,10 +80,9 @@ public static Matcher isIn(T[] elements) { * specified array. * For example: * 
assertThat("foo", is(in(new String[]{"bar", "foo"})))
- * + * * @param elements * the array in which matching items must be found - * */ public static Matcher in(T[] elements) { return new IsIn<>(elements); @@ -97,12 +93,11 @@ public static Matcher in(T[] elements) { * specified elements. * For example: * 
assertThat("foo", isOneOf("bar", "foo"))
- * + * * @deprecated use is(oneOf(...)) instead - * + * * @param elements * the elements amongst which matching items will be found - * */ @SafeVarargs @Deprecated @@ -115,10 +110,9 @@ public static Matcher isOneOf(T... elements) { * specified elements. * For example: * 
assertThat("foo", is(oneOf("bar", "foo")))
- * + * * @param elements * the elements amongst which matching items will be found - * */ @SafeVarargs public static Matcher oneOf(T... elements) { diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInAnyOrder.java b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInAnyOrder.java index d6a9a33d..c9ea7964 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInAnyOrder.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInAnyOrder.java @@ -92,7 +92,7 @@ private boolean isMatched(S item) { * For example: *

* 
assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(equalTo("bar"), equalTo("foo")))
- * + * * @param itemMatchers * a list of matchers, each of which must be satisfied by an item provided by an examined {@link Iterable} */ @@ -117,7 +117,7 @@ public static Matcher> containsInAnyOrder(Matcher * 
assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder("bar", "foo"))
- * + * * @param items * the items that must equal the items provided by an examined {@link Iterable} in any order */ @@ -145,7 +145,7 @@ public static Matcher> containsInAnyOrder(T... items) *

*

For example:

* 
assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(Arrays.asList(equalTo("bar"), equalTo("foo"))))
- * + * * @param itemMatchers * a list of matchers, each of which must be satisfied by an item provided by an examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInOrder.java b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInOrder.java index ed62aa29..ee6b04c3 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInOrder.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInOrder.java @@ -88,7 +88,7 @@ private void describeMismatch(Matcher matcher, F item) { * must be of the same length as the number of specified items. * For example: * 
assertThat(Arrays.asList("foo", "bar"), contains("foo", "bar"))
- * + * * @param items * the items that must equal the items provided by an examined {@link Iterable} */ @@ -103,7 +103,7 @@ public static Matcher> contains(E... items) { * For a positive match, the examined iterable must only yield one item. * For example: * 
assertThat(Arrays.asList("foo"), contains(equalTo("foo")))
- * + * * @param itemMatcher * the matcher that must be satisfied by the single item provided by an * examined {@link Iterable} @@ -120,7 +120,7 @@ public static Matcher> contains(final MatcherassertThat(Arrays.asList("foo", "bar"), contains(equalTo("foo"), equalTo("bar"))) - * + * * @param itemMatchers * the matchers that must be satisfied by the items provided by an examined {@link Iterable} */ @@ -139,7 +139,7 @@ public static Matcher> contains(Matcher... * must be of the same length as the specified list of matchers. * For example: * 
assertThat(Arrays.asList("foo", "bar"), contains(Arrays.asList(equalTo("foo"), equalTo("bar"))))
- * + * * @param itemMatchers * a list of matchers, each of which must be satisfied by the corresponding item provided by * an examined {@link Iterable} diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInRelativeOrder.java b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInRelativeOrder.java index 06577685..31ae8d94 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInRelativeOrder.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableContainingInRelativeOrder.java @@ -73,7 +73,7 @@ public boolean isFinished() { * corresponding item in the specified items, in the same relative order * For example: * 
assertThat(Arrays.asList("a", "b", "c", "d", "e"), containsInRelativeOrder("b", "d"))
- * + * * @param items * the items that must be contained within items provided by an examined {@link Iterable} in the same relative order */ @@ -93,7 +93,7 @@ public static Matcher> containsInRelativeOrder(E... it * matcher in the specified matchers, in the same relative order. * For example: * 
assertThat(Arrays.asList("a", "b", "c", "d", "e"), containsInRelativeOrder(equalTo("b"), equalTo("d")))
- * + * * @param itemMatchers * the matchers that must be satisfied by the items provided by an examined {@link Iterable} in the same relative order */ @@ -108,7 +108,7 @@ public static Matcher> containsInRelativeOrder(Matcher * matcher in the specified list of matchers, in the same relative order. * For example: * 
assertThat(Arrays.asList("a", "b", "c", "d", "e"), contains(Arrays.asList(equalTo("b"), equalTo("d"))))
- * + * * @param itemMatchers * a list of matchers, each of which must be satisfied by the items provided by * an examined {@link Iterable} in the same relative order diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableWithSize.java b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableWithSize.java index 0a1535fe..7c79e746 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsIterableWithSize.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsIterableWithSize.java @@ -29,7 +29,7 @@ protected Integer featureValueOf(Iterable actual) { * matcher. * For example: * 
assertThat(Arrays.asList("foo", "bar"), iterableWithSize(equalTo(2)))
- * + * * @param sizeMatcher * a matcher for the number of items that should be yielded by an examined {@link Iterable} */ @@ -43,7 +43,7 @@ public static Matcher> iterableWithSize(Matcher * size argument. * For example: * 
assertThat(Arrays.asList("foo", "bar"), iterableWithSize(2))
- * + * * @param size * the number of items that should be yielded by an examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsMapContaining.java b/hamcrest/src/main/java/org/hamcrest/collection/IsMapContaining.java index 4ed45392..72c7899a 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsMapContaining.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsMapContaining.java @@ -49,7 +49,7 @@ public void describeTo(Description description) { * value satisfies the specified valueMatcher. * For example: * 
assertThat(myMap, hasEntry(equalTo("bar"), equalTo("foo")))
- * + * * @param keyMatcher * the key matcher that, in combination with the valueMatcher, must be satisfied by at least one entry * @param valueMatcher @@ -65,7 +65,7 @@ public static Matcher> hasEntry(Matchervalue. * For example: * 
assertThat(myMap, hasEntry("bar", "foo"))
- * + * * @param key * the key that, in combination with the value, must be describe at least one entry * @param value @@ -80,7 +80,7 @@ public static Matcher> hasEntry(K key, V valu * at least one key that satisfies the specified matcher. * For example: * 
assertThat(myMap, hasKey(equalTo("bar")))
- * + * * @param keyMatcher * the matcher that must be satisfied by at least one key */ @@ -93,7 +93,7 @@ public static Matcher> hasEntry(K key, V valu * at least one key that is equal to the specified key. * For example: * 
assertThat(myMap, hasKey("bar"))
- * + * * @param key * the key that satisfying maps must contain */ @@ -106,7 +106,7 @@ public static Matcher> hasEntry(K key, V valu * at least one value that satisfies the specified valueMatcher. * For example: * 
assertThat(myMap, hasValue(equalTo("foo")))
- * + * * @param valueMatcher * the matcher that must be satisfied by at least one value */ @@ -119,7 +119,7 @@ public static Matcher> hasEntry(K key, V valu * at least one value that is equal to the specified value. * For example: * 
assertThat(myMap, hasValue("foo"))
- * + * * @param value * the value that satisfying maps must contain */ diff --git a/hamcrest/src/main/java/org/hamcrest/collection/IsMapWithSize.java b/hamcrest/src/main/java/org/hamcrest/collection/IsMapWithSize.java index 966d9ca2..99bd3bd7 100644 --- a/hamcrest/src/main/java/org/hamcrest/collection/IsMapWithSize.java +++ b/hamcrest/src/main/java/org/hamcrest/collection/IsMapWithSize.java @@ -26,7 +26,7 @@ protected Integer featureValueOf(Map actual) { * a value that satisfies the specified matcher. * For example: * 
assertThat(myMap, is(aMapWithSize(equalTo(2))))
- * + * * @param sizeMatcher * a matcher for the size of an examined {@link java.util.Map} */ @@ -39,7 +39,7 @@ protected Integer featureValueOf(Map actual) { * a value equal to the specified size. * For example: * 
assertThat(myMap, is(aMapWithSize(2)))
- * + * * @param size * the expected size of an examined {@link java.util.Map} */ @@ -52,7 +52,6 @@ protected Integer featureValueOf(Map actual) { * zero. * For example: * 
assertThat(myMap, is(anEmptyMap()))
- * */ public static Matcher> anEmptyMap() { return IsMapWithSize.aMapWithSize(equalTo(0)); diff --git a/hamcrest/src/main/java/org/hamcrest/core/DescribedAs.java b/hamcrest/src/main/java/org/hamcrest/core/DescribedAs.java index 23876095..0e054290 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/DescribedAs.java +++ b/hamcrest/src/main/java/org/hamcrest/core/DescribedAs.java @@ -55,7 +55,7 @@ public void describeMismatch(Object item, Description description) { * delegated to the decorated matcher, including its mismatch description. * For example: * 
describedAs("a big decimal equal to %0", equalTo(myBigDecimal), myBigDecimal.toPlainString())
- * + * * @param description * the new description for the wrapped matcher * @param matcher diff --git a/hamcrest/src/main/java/org/hamcrest/core/Every.java b/hamcrest/src/main/java/org/hamcrest/core/Every.java index 988758b1..771c4a9d 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/Every.java +++ b/hamcrest/src/main/java/org/hamcrest/core/Every.java @@ -34,7 +34,7 @@ public void describeTo(Description description) { * itemMatcher. * For example: * 
assertThat(Arrays.asList("bar", "baz"), everyItem(startsWith("ba")))
- * + * * @param itemMatcher * the matcher to apply to every item provided by the examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/core/Is.java b/hamcrest/src/main/java/org/hamcrest/core/Is.java index 5264e89d..df0ee322 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/Is.java +++ b/hamcrest/src/main/java/org/hamcrest/core/Is.java @@ -42,7 +42,6 @@ public void describeMismatch(Object item, Description mismatchDescription) { * 
assertThat(cheese, is(equalTo(smelly)))
* instead of: * 
assertThat(cheese, equalTo(smelly))
- * */ public static Matcher is(Matcher matcher) { return new Is<>(matcher); @@ -54,7 +53,6 @@ public static Matcher is(Matcher matcher) { * 
assertThat(cheese, is(smelly))
* instead of: * 
assertThat(cheese, is(equalTo(smelly)))
- * */ public static Matcher is(T value) { return is(equalTo(value)); @@ -66,7 +64,6 @@ public static Matcher is(T value) { * 
assertThat(cheese, isA(Cheddar.class))
* instead of: * 
assertThat(cheese, is(instanceOf(Cheddar.class)))
- * */ public static Matcher isA(Class type) { return is(IsInstanceOf.instanceOf(type)); diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsCollectionContaining.java b/hamcrest/src/main/java/org/hamcrest/core/IsCollectionContaining.java index b54b6aa9..630ea828 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsCollectionContaining.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsCollectionContaining.java @@ -35,7 +35,7 @@ public void describeTo(Description description) { * 
assertThat(Arrays.asList("foo", "bar"), hasItem(startsWith("ba")))
* * @deprecated As of version 2.1, use {@link IsIterableContaining#hasItem(Matcher)}. - * + * * @param itemMatcher * the matcher to apply to items provided by the examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsEqual.java b/hamcrest/src/main/java/org/hamcrest/core/IsEqual.java index 582c630f..ac2d981b 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsEqual.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsEqual.java @@ -65,13 +65,13 @@ private static boolean isArray(Object o) { * Creates a matcher that matches when the examined object is logically equal to the specified * operand, as determined by calling the {@link java.lang.Object#equals} method on * the examined object. - * + * *

If the specified operand is null then the created matcher will only match if * the examined object's equals method returns true when passed a * null (which would be a violation of the equals contract), unless the * examined object itself is null, in which case the matcher will return a positive * match.

- * + * *

The created matcher provides a special behaviour when examining Arrays, whereby * it will match if both the operand and the examined object are arrays of the same length and * contain items that are equal to each other (according to the above rules) in the same @@ -81,7 +81,6 @@ private static boolean isArray(Object o) { * assertThat("foo", equalTo("foo")); * assertThat(new String[] {"foo", "bar"}, equalTo(new String[] {"foo", "bar"})); * - * */ public static Matcher equalTo(T operand) { return new IsEqual<>(operand); diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsInstanceOf.java b/hamcrest/src/main/java/org/hamcrest/core/IsInstanceOf.java index 5a508c9b..9984655e 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsInstanceOf.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsInstanceOf.java @@ -60,11 +60,10 @@ public void describeTo(Description description) { * Creates a matcher that matches when the examined object is an instance of the specified type, * as determined by calling the {@link java.lang.Class#isInstance(Object)} method on that type, passing the * the examined object. - * + * *

The created matcher assumes no relationship between specified type and the examined object.

* For example: * 
assertThat(new Canoe(), instanceOf(Paddlable.class));
- * */ @SuppressWarnings("unchecked") public static Matcher instanceOf(Class type) { @@ -75,13 +74,12 @@ public static Matcher instanceOf(Class type) { * Creates a matcher that matches when the examined object is an instance of the specified type, * as determined by calling the {@link java.lang.Class#isInstance(Object)} method on that type, passing the * the examined object. - * + * *

The created matcher forces a relationship between specified type and the examined object, and should be * used when it is necessary to make generics conform, for example in the JMock clause * with(any(Thing.class))

* For example: * 
assertThat(new Canoe(), instanceOf(Canoe.class));
- * */ @SuppressWarnings("unchecked") public static Matcher any(Class type) { diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsIterableContaining.java b/hamcrest/src/main/java/org/hamcrest/core/IsIterableContaining.java index 67e776b0..f9cd7434 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsIterableContaining.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsIterableContaining.java @@ -62,7 +62,7 @@ public void describeTo(Description description) { * will stop as soon as a matching item is found. * For example: * 
assertThat(Arrays.asList("foo", "bar"), hasItem(startsWith("ba")))
- * + * * @param itemMatcher * the matcher to apply to items provided by the examined {@link Iterable} */ @@ -77,7 +77,7 @@ public static Matcher> hasItem(Matcher itemMa * will stop as soon as a matching item is found. * For example: * 
assertThat(Arrays.asList("foo", "bar"), hasItem("bar"))
- * + * * @param item * the item to compare against the items provided by the examined {@link Iterable} */ @@ -93,7 +93,7 @@ public static Matcher> hasItem(T item) { * the examined {@link Iterable} will stop as soon as a matching item is found. * For example: * 
assertThat(Arrays.asList("foo", "bar", "baz"), hasItems(endsWith("z"), endsWith("o")))
- * + * * @param itemMatchers * the matchers to apply to items provided by the examined {@link Iterable} */ @@ -116,7 +116,7 @@ public static Matcher> hasItems(Matcher... itemMatche * examined {@link Iterable} will stop as soon as a matching item is found. * For example: * 
assertThat(Arrays.asList("foo", "bar", "baz"), hasItems("baz", "foo"))
- * + * * @param items * the items to compare against the items provided by the examined {@link Iterable} */ diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsNot.java b/hamcrest/src/main/java/org/hamcrest/core/IsNot.java index d5cf9c06..f81f516a 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsNot.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsNot.java @@ -33,7 +33,7 @@ public void describeTo(Description description) { * it will match. * For example: * 
assertThat(cheese, is(not(equalTo(smelly))))
- * + * * @param matcher * the matcher whose sense should be inverted */ @@ -47,7 +47,7 @@ public static Matcher not(Matcher matcher) { * 
assertThat(cheese, is(not(smelly)))
* instead of: * 
assertThat(cheese, is(not(equalTo(smelly))))
- * + * * @param value * the value that any examined object should not equal */ diff --git a/hamcrest/src/main/java/org/hamcrest/core/IsNull.java b/hamcrest/src/main/java/org/hamcrest/core/IsNull.java index 9ebf080f..ded83efe 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/IsNull.java +++ b/hamcrest/src/main/java/org/hamcrest/core/IsNull.java @@ -24,7 +24,6 @@ public void describeTo(Description description) { * Creates a matcher that matches if examined object is null. * For example: * 
assertThat(cheese, is(nullValue())
- * */ public static Matcher nullValue() { return new IsNull(); @@ -36,7 +35,6 @@ public static Matcher nullValue() { * 
assertThat(cheese, is(notNullValue()))
* instead of: * 
assertThat(cheese, is(not(nullValue())))
- * */ public static Matcher notNullValue() { return not(nullValue()); @@ -47,7 +45,7 @@ public static Matcher notNullValue() { * single dummy argument to facilitate type inference. * For example: * 
assertThat(cheese, is(nullValue(Cheese.class))
- * + * * @param type * dummy parameter used to infer the generic type of the returned matcher */ @@ -62,10 +60,9 @@ public static Matcher nullValue(Class type) { * 
assertThat(cheese, is(notNullValue(X.class)))
* instead of: * 
assertThat(cheese, is(not(nullValue(X.class))))
- * + * * @param type * dummy parameter used to infer the generic type of the returned matcher - * */ public static Matcher notNullValue(Class type) { return not(nullValue(type)); diff --git a/hamcrest/src/main/java/org/hamcrest/core/StringContains.java b/hamcrest/src/main/java/org/hamcrest/core/StringContains.java index 050fd159..e32b2e0a 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/StringContains.java +++ b/hamcrest/src/main/java/org/hamcrest/core/StringContains.java @@ -22,10 +22,9 @@ protected boolean evalSubstringOf(String s) { * {@link String} anywhere. * For example: * 
assertThat("myStringOfNote", containsString("ring"))
- * + * * @param substring * the substring that the returned matcher will expect to find within any examined string - * */ public static Matcher containsString(String substring) { return new StringContains(false, substring); @@ -39,7 +38,6 @@ public static Matcher containsString(String substring) { * * @param substring * the substring that the returned matcher will expect to find within any examined string - * */ public static Matcher containsStringIgnoringCase(String substring) { return new StringContains(true, substring); diff --git a/hamcrest/src/main/java/org/hamcrest/core/StringEndsWith.java b/hamcrest/src/main/java/org/hamcrest/core/StringEndsWith.java index 48ffd923..e815d0fb 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/StringEndsWith.java +++ b/hamcrest/src/main/java/org/hamcrest/core/StringEndsWith.java @@ -20,7 +20,7 @@ protected boolean evalSubstringOf(String s) { * {@link String}. * For example: * 
assertThat("myStringOfNote", endsWith("Note"))
- * + * * @param suffix * the substring that the returned matcher will expect at the end of any examined string */ diff --git a/hamcrest/src/main/java/org/hamcrest/core/StringStartsWith.java b/hamcrest/src/main/java/org/hamcrest/core/StringStartsWith.java index fa49b793..354d4426 100644 --- a/hamcrest/src/main/java/org/hamcrest/core/StringStartsWith.java +++ b/hamcrest/src/main/java/org/hamcrest/core/StringStartsWith.java @@ -20,7 +20,7 @@ public class StringStartsWith extends SubstringMatcher { *

* For example: * 
assertThat("myStringOfNote", startsWith("my"))
- * + * * @param prefix * the substring that the returned matcher will expect at the start of any examined string */ diff --git a/hamcrest/src/main/java/org/hamcrest/number/IsCloseTo.java b/hamcrest/src/main/java/org/hamcrest/number/IsCloseTo.java index 3b6967dc..6525b8f6 100644 --- a/hamcrest/src/main/java/org/hamcrest/number/IsCloseTo.java +++ b/hamcrest/src/main/java/org/hamcrest/number/IsCloseTo.java @@ -51,7 +51,7 @@ private double actualDelta(Double item) { * to the specified operand, within a range of +/- error. * For example: * 
assertThat(1.03, is(closeTo(1.0, 0.03)))
- * + * * @param operand * the expected value of matching doubles * @param error diff --git a/hamcrest/src/main/java/org/hamcrest/object/HasToString.java b/hamcrest/src/main/java/org/hamcrest/object/HasToString.java index 2dab9de4..0c0aa49e 100644 --- a/hamcrest/src/main/java/org/hamcrest/object/HasToString.java +++ b/hamcrest/src/main/java/org/hamcrest/object/HasToString.java @@ -20,7 +20,7 @@ protected String featureValueOf(T actual) { * returns a value that satisfies the specified matcher. * For example: * 
assertThat(true, hasToString(equalTo("TRUE")))
- * + * * @param toStringMatcher * the matcher used to verify the toString result */ @@ -33,7 +33,7 @@ public static Matcher hasToString(Matcher toStringMatcher * returns a value equalTo the specified string. * For example: * 
assertThat(true, hasToString("TRUE"))
- * + * * @param expectedToString * the expected toString result */ diff --git a/hamcrest/src/main/java/org/hamcrest/object/IsCompatibleType.java b/hamcrest/src/main/java/org/hamcrest/object/IsCompatibleType.java index e1410a47..acb8ddd1 100644 --- a/hamcrest/src/main/java/org/hamcrest/object/IsCompatibleType.java +++ b/hamcrest/src/main/java/org/hamcrest/object/IsCompatibleType.java @@ -31,7 +31,7 @@ public void describeTo(Description description) { * assignable from the examined class. * For example: * 
assertThat(Integer.class, typeCompatibleWith(Number.class))
- * + * * @param baseType * the base class to examine classes against */ diff --git a/hamcrest/src/main/java/org/hamcrest/object/IsEventFrom.java b/hamcrest/src/main/java/org/hamcrest/object/IsEventFrom.java index 43b64d46..50ed998c 100644 --- a/hamcrest/src/main/java/org/hamcrest/object/IsEventFrom.java +++ b/hamcrest/src/main/java/org/hamcrest/object/IsEventFrom.java @@ -51,7 +51,7 @@ public void describeTo(Description description) { * derived from eventClass announced by source. * For example: * 
assertThat(myEvent, is(eventFrom(PropertyChangeEvent.class, myBean)))
- * + * * @param eventClass * the class of the event to match on * @param source @@ -66,7 +66,7 @@ public static Matcher eventFrom(Class eventC * announced by source. * For example: * 
assertThat(myEvent, is(eventFrom(myBean)))
- * + * * @param source * the source of the event */ diff --git a/hamcrest/src/main/java/org/hamcrest/text/CharSequenceLength.java b/hamcrest/src/main/java/org/hamcrest/text/CharSequenceLength.java index e5e3d466..4324eade 100644 --- a/hamcrest/src/main/java/org/hamcrest/text/CharSequenceLength.java +++ b/hamcrest/src/main/java/org/hamcrest/text/CharSequenceLength.java @@ -27,11 +27,11 @@ protected Integer featureValueOf(CharSequence actual) { /** * Creates a matcher of {@link CharSequence} that matches when a char sequence has the given length * For example: - * + * * 
      * assertThat("text", hasLength(4))
      *
- * + * * @param length the expected length of the string */ public static Matcher hasLength(int length) { diff --git a/hamcrest/src/main/java/org/hamcrest/text/IsBlankString.java b/hamcrest/src/main/java/org/hamcrest/text/IsBlankString.java index b168541b..c05613a8 100644 --- a/hamcrest/src/main/java/org/hamcrest/text/IsBlankString.java +++ b/hamcrest/src/main/java/org/hamcrest/text/IsBlankString.java @@ -47,7 +47,6 @@ public static Matcher blankString() { * contains zero or more whitespace characters and nothing else. * For example: * 
assertThat(((String)null), is(blankOrNullString()))
- * */ public static Matcher blankOrNullString() { return NULL_OR_BLANK_INSTANCE; diff --git a/hamcrest/src/main/java/org/hamcrest/text/IsEmptyString.java b/hamcrest/src/main/java/org/hamcrest/text/IsEmptyString.java index bbe56814..dd78449a 100644 --- a/hamcrest/src/main/java/org/hamcrest/text/IsEmptyString.java +++ b/hamcrest/src/main/java/org/hamcrest/text/IsEmptyString.java @@ -32,7 +32,7 @@ public void describeTo(Description description) { * Creates a matcher of {@link String} that matches when the examined string has zero length. * For example: * 
assertThat("", isEmptyString())
- * + * * @deprecated use is(emptyString()) instead */ @Deprecated @@ -44,7 +44,6 @@ public static Matcher isEmptyString() { * Creates a matcher of {@link String} that matches when the examined string has zero length. * For example: * 
assertThat("", is(emptyString()))
- * */ public static Matcher emptyString() { return INSTANCE; @@ -55,9 +54,8 @@ public static Matcher emptyString() { * has zero length. * For example: * 
assertThat(((String)null), isEmptyOrNullString())
- * + * * @deprecated use is(emptyOrNullString()) instead - * */ @Deprecated public static Matcher isEmptyOrNullString() { @@ -69,7 +67,6 @@ public static Matcher isEmptyOrNullString() { * has zero length. * For example: * 
assertThat(((String)null), is(emptyOrNullString()))
- * */ public static Matcher emptyOrNullString() { return NULL_OR_EMPTY_INSTANCE; diff --git a/hamcrest/src/main/java/org/hamcrest/text/IsEqualIgnoringCase.java b/hamcrest/src/main/java/org/hamcrest/text/IsEqualIgnoringCase.java index defa6123..d44fb67b 100644 --- a/hamcrest/src/main/java/org/hamcrest/text/IsEqualIgnoringCase.java +++ b/hamcrest/src/main/java/org/hamcrest/text/IsEqualIgnoringCase.java @@ -43,7 +43,7 @@ public void describeTo(Description description) { * the specified expectedString, ignoring case. * For example: * 
assertThat("Foo", equalToIgnoringCase("FOO"))
- * + * * @param expectedString * the expected value of matched strings */ diff --git a/hamcrest/src/main/java/org/hamcrest/text/StringContainsInOrder.java b/hamcrest/src/main/java/org/hamcrest/text/StringContainsInOrder.java index 6df9a531..d324baba 100644 --- a/hamcrest/src/main/java/org/hamcrest/text/StringContainsInOrder.java +++ b/hamcrest/src/main/java/org/hamcrest/text/StringContainsInOrder.java @@ -46,7 +46,7 @@ public void describeTo(Description description) { * For example: * 
assertThat("myfoobarbaz", stringContainsInOrder(Arrays.asList("bar", "foo")))
* fails as "foo" occurs before "bar" in the string "myfoobarbaz" - * + * * @param substrings * the substrings that must be contained within matching strings */ diff --git a/hamcrest/src/main/java/org/hamcrest/xml/HasXPath.java b/hamcrest/src/main/java/org/hamcrest/xml/HasXPath.java index 30ed081a..a265fcec 100644 --- a/hamcrest/src/main/java/org/hamcrest/xml/HasXPath.java +++ b/hamcrest/src/main/java/org/hamcrest/xml/HasXPath.java @@ -111,7 +111,7 @@ private static XPathExpression compiledXPath(String xPathExpression, NamespaceCo * specified xPath that satisfies the specified valueMatcher. * For example: * 
assertThat(xml, hasXPath("/root/something[2]/cheese", equalTo("Cheddar")))
- * + * * @param xPath * the target xpath * @param valueMatcher @@ -127,7 +127,7 @@ public static Matcher hasXPath(String xPath, Matcher valueMatcher) * the specified valueMatcher. * For example: * 
assertThat(xml, hasXPath("/root/something[2]/cheese", myNs, equalTo("Cheddar")))
- * + * * @param xPath * the target xpath * @param namespaceContext @@ -144,7 +144,7 @@ public static Matcher hasXPath(String xPath, NamespaceContext namespaceCon * at the specified xPath, with any content. * For example: * 
assertThat(xml, hasXPath("/root/something[2]/cheese"))
- * + * * @param xPath * the target xpath */ @@ -157,7 +157,7 @@ public static Matcher hasXPath(String xPath) { * at the specified xPath within the specified namespace context, with any content. * For example: * 
assertThat(xml, hasXPath("/root/something[2]/cheese", myNs))
- * + * * @param xPath * the target xpath * @param namespaceContext