Skip to content

Commit

Permalink
JavaDoc only whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
nhojpatrick committed Feb 13, 2022
1 parent b378743 commit a82f91f
Show file tree
Hide file tree
Showing 40 changed files with 80 additions and 105 deletions.
4 changes: 2 additions & 2 deletions hamcrest/src/main/java/org/hamcrest/CoreMatchers.java
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public static <LHS> org.hamcrest.core.CombinableMatcher.CombinableEitherMatcher<
* delegated to the decorated matcher, including its mismatch description.
* For example:
* <pre>describedAs("a big decimal equal to %0", equalTo(myBigDecimal), myBigDecimal.toPlainString())</pre>
*
*
* @param description
* the new description for the wrapped matcher
* @param matcher
Expand All @@ -85,7 +85,7 @@ public static <T> org.hamcrest.Matcher<T> describedAs(java.lang.String descripti
* <code>itemMatcher</code>.
* For example:
* <pre>assertThat(Arrays.asList("bar", "baz"), everyItem(startsWith("ba")))</pre>
*
*
* @param itemMatcher
* the matcher to apply to every item provided by the examined {@link Iterable}
*/
Expand Down
2 changes: 1 addition & 1 deletion hamcrest/src/main/java/org/hamcrest/SelfDescribing.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion hamcrest/src/main/java/org/hamcrest/StringDescription.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion hamcrest/src/main/java/org/hamcrest/beans/HasProperty.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public void describeTo(Description description) {
* with the specified name.
* For example:
* <pre>assertThat(myBean, hasProperty("foo"))</pre>
*
*
* @param propertyName
* the name of the JavaBean property that examined beans should possess
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public Condition<Method> apply(PropertyDescriptor property, Description mismatch
* with the specified name whose value satisfies the specified matcher.
* For example:
* <pre>assertThat(myBean, hasProperty("foo", equalTo("bar"))</pre>
*
*
* @param propertyName
* the name of the JavaBean property that examined beans should possess
* @param valueMatcher
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions hamcrest/src/main/java/org/hamcrest/collection/IsArray.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand All @@ -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.
*/
Expand All @@ -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.
*/
Expand All @@ -86,7 +86,7 @@ protected String descriptionEnd() {
* each matcher[i] is satisfied by array[i].
* For example:
* <pre>assertThat(new Integer[]{1,2,3}, is(array(equalTo(1), equalTo(2), equalTo(3))))</pre>
*
*
* @param elementMatchers
* the matchers that the elements of examined arrays should satisfy
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ protected Integer featureValueOf(E[] actual) {
* satisfies the specified matcher.
* For example:
* <pre>assertThat(new String[]{"foo", "bar"}, arrayWithSize(equalTo(2)))</pre>
*
*
* @param sizeMatcher
* a matcher for the length of an examined array
*/
Expand All @@ -37,7 +37,7 @@ public static <E> Matcher<E[]> arrayWithSize(Matcher<? super Integer> sizeMatche
* equals the specified <code>size</code>.
* For example:
* <pre>assertThat(new String[]{"foo", "bar"}, arrayWithSize(2))</pre>
*
*
* @param size
* the length that an examined array must have for a positive match
*/
Expand All @@ -50,7 +50,6 @@ public static <E> Matcher<E[]> arrayWithSize(int size) {
* is zero.
* For example:
* <pre>assertThat(new String[0], emptyArray())</pre>
*
*/
public static <E> Matcher<E[]> emptyArray() {
return describedAs("an empty array", IsArrayWithSize.<E>arrayWithSize(0));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ protected Integer featureValueOf(Collection<? extends E> actual) {
* a value that satisfies the specified matcher.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), hasSize(equalTo(2)))</pre>
*
*
* @param sizeMatcher
* a matcher for the size of an examined {@link java.util.Collection}
*/
Expand All @@ -38,7 +38,7 @@ public static <E> Matcher<Collection<? extends E>> hasSize(Matcher<? super Integ
* a value equal to the specified <code>size</code>.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), hasSize(2))</pre>
*
*
* @param size
* the expected size of an examined {@link java.util.Collection}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ public void describeTo(Description description) {
* method returns <code>true</code>.
* For example:
* <pre>assertThat(new ArrayList&lt;String&gt;(), is(empty()))</pre>
*
*/
public static <E> Matcher<Collection<? extends E>> empty() {
return new IsEmptyCollection<E>();
Expand All @@ -42,7 +41,7 @@ public static <E> Matcher<Collection<? extends E>> empty() {
* method returns <code>true</code>.
* For example:
* <pre>assertThat(new ArrayList&lt;String&gt;(), is(emptyCollectionOf(String.class)))</pre>
*
*
* @param unusedToForceReturnType
* the type of the collection's content
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
* <pre>assertThat(new ArrayList&lt;String&gt;(), is(emptyIterable()))</pre>
*
*/
public static <E> Matcher<Iterable<? extends E>> emptyIterable() {
return new IsEmptyIterable<E>();
Expand All @@ -37,7 +36,7 @@ public static <E> Matcher<Iterable<? extends E>> emptyIterable() {
* Creates a matcher for {@link Iterable}s matching examined iterables that yield no items.
* For example:
* <pre>assertThat(new ArrayList&lt;String&gt;(), is(emptyIterableOf(String.class)))</pre>
*
*
* @param unusedToForceReturnType
* the type of the iterable's content
*/
Expand Down
24 changes: 9 additions & 15 deletions hamcrest/src/main/java/org/hamcrest/collection/IsIn.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,11 @@ public void describeTo(Description buffer) {
* specified collection.
* For example:
* <pre>assertThat("foo", isIn(Arrays.asList("bar", "foo")))</pre>
*
*
* @deprecated use is(in(...)) instead
*
*
* @param collection
* the collection in which matching items must be found
*
*/
@Deprecated
public static <T> Matcher<T> isIn(Collection<T> collection) {
Expand All @@ -52,10 +51,9 @@ public static <T> Matcher<T> isIn(Collection<T> collection) {
* specified collection.
* For example:
* <pre>assertThat("foo", is(in(Arrays.asList("bar", "foo"))))</pre>
*
*
* @param collection
* the collection in which matching items must be found
*
*/
public static <T> Matcher<T> in(Collection<T> collection) {
return new IsIn<>(collection);
Expand All @@ -66,12 +64,11 @@ public static <T> Matcher<T> in(Collection<T> collection) {
* specified array.
* For example:
* <pre>assertThat("foo", isIn(new String[]{"bar", "foo"}))</pre>
*
*
* @deprecated use is(in(...)) instead
*
*
* @param elements
* the array in which matching items must be found
*
*/
@Deprecated
public static <T> Matcher<T> isIn(T[] elements) {
Expand All @@ -83,10 +80,9 @@ public static <T> Matcher<T> isIn(T[] elements) {
* specified array.
* For example:
* <pre>assertThat("foo", is(in(new String[]{"bar", "foo"})))</pre>
*
*
* @param elements
* the array in which matching items must be found
*
*/
public static <T> Matcher<T> in(T[] elements) {
return new IsIn<>(elements);
Expand All @@ -97,12 +93,11 @@ public static <T> Matcher<T> in(T[] elements) {
* specified elements.
* For example:
* <pre>assertThat("foo", isOneOf("bar", "foo"))</pre>
*
*
* @deprecated use is(oneOf(...)) instead
*
*
* @param elements
* the elements amongst which matching items will be found
*
*/
@SafeVarargs
@Deprecated
Expand All @@ -115,10 +110,9 @@ public static <T> Matcher<T> isOneOf(T... elements) {
* specified elements.
* For example:
* <pre>assertThat("foo", is(oneOf("bar", "foo")))</pre>
*
*
* @param elements
* the elements amongst which matching items will be found
*
*/
@SafeVarargs
public static <T> Matcher<T> oneOf(T... elements) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ private boolean isMatched(S item) {
* For example:
* </p>
* <pre>assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(equalTo("bar"), equalTo("foo")))</pre>
*
*
* @param itemMatchers
* a list of matchers, each of which must be satisfied by an item provided by an examined {@link Iterable}
*/
Expand All @@ -117,7 +117,7 @@ public static <T> Matcher<Iterable<? extends T>> containsInAnyOrder(Matcher<? su
* For example:
* </p>
* <pre>assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder("bar", "foo"))</pre>
*
*
* @param items
* the items that must equal the items provided by an examined {@link Iterable} in any order
*/
Expand Down Expand Up @@ -145,7 +145,7 @@ public static <T> Matcher<Iterable<? extends T>> containsInAnyOrder(T... items)
* </p>
* <p>For example:</p>
* <pre>assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(Arrays.asList(equalTo("bar"), equalTo("foo"))))</pre>
*
*
* @param itemMatchers
* a list of matchers, each of which must be satisfied by an item provided by an examined {@link Iterable}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ private void describeMismatch(Matcher<? super F> matcher, F item) {
* must be of the same length as the number of specified items.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), contains("foo", "bar"))</pre>
*
*
* @param items
* the items that must equal the items provided by an examined {@link Iterable}
*/
Expand All @@ -103,7 +103,7 @@ public static <E> Matcher<Iterable<? extends E>> contains(E... items) {
* For a positive match, the examined iterable must only yield one item.
* For example:
* <pre>assertThat(Arrays.asList("foo"), contains(equalTo("foo")))</pre>
*
*
* @param itemMatcher
* the matcher that must be satisfied by the single item provided by an
* examined {@link Iterable}
Expand All @@ -120,7 +120,7 @@ public static <E> Matcher<Iterable<? extends E>> contains(final Matcher<? super
* must be of the same length as the number of specified matchers.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), contains(equalTo("foo"), equalTo("bar")))</pre>
*
*
* @param itemMatchers
* the matchers that must be satisfied by the items provided by an examined {@link Iterable}
*/
Expand All @@ -139,7 +139,7 @@ public static <E> Matcher<Iterable<? extends E>> contains(Matcher<? super E>...
* must be of the same length as the specified list of matchers.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), contains(Arrays.asList(equalTo("foo"), equalTo("bar"))))</pre>
*
*
* @param itemMatchers
* a list of matchers, each of which must be satisfied by the corresponding item provided by
* an examined {@link Iterable}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public boolean isFinished() {
* corresponding item in the specified items, in the same relative order
* For example:
* <pre>assertThat(Arrays.asList("a", "b", "c", "d", "e"), containsInRelativeOrder("b", "d"))</pre>
*
*
* @param items
* the items that must be contained within items provided by an examined {@link Iterable} in the same relative order
*/
Expand All @@ -93,7 +93,7 @@ public static <E> Matcher<Iterable<? extends E>> containsInRelativeOrder(E... it
* matcher in the specified matchers, in the same relative order.
* For example:
* <pre>assertThat(Arrays.asList("a", "b", "c", "d", "e"), containsInRelativeOrder(equalTo("b"), equalTo("d")))</pre>
*
*
* @param itemMatchers
* the matchers that must be satisfied by the items provided by an examined {@link Iterable} in the same relative order
*/
Expand All @@ -108,7 +108,7 @@ public static <E> Matcher<Iterable<? extends E>> containsInRelativeOrder(Matcher
* matcher in the specified list of matchers, in the same relative order.
* For example:
* <pre>assertThat(Arrays.asList("a", "b", "c", "d", "e"), contains(Arrays.asList(equalTo("b"), equalTo("d"))))</pre>
*
*
* @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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ protected Integer featureValueOf(Iterable<E> actual) {
* matcher.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), iterableWithSize(equalTo(2)))</pre>
*
*
* @param sizeMatcher
* a matcher for the number of items that should be yielded by an examined {@link Iterable}
*/
Expand All @@ -43,7 +43,7 @@ public static <E> Matcher<Iterable<E>> iterableWithSize(Matcher<? super Integer>
* <code>size</code> argument.
* For example:
* <pre>assertThat(Arrays.asList("foo", "bar"), iterableWithSize(2))</pre>
*
*
* @param size
* the number of items that should be yielded by an examined {@link Iterable}
*/
Expand Down
Loading

0 comments on commit a82f91f

Please sign in to comment.