Skip to content

Commit a79191f

Browse files
committed
JavaDoc only @return org.hamcrest.number
1 parent 9fed28c commit a79191f

4 files changed

Lines changed: 9 additions & 0 deletions

File tree

hamcrest/src/main/java/org/hamcrest/number/BigDecimalCloseTo.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ private BigDecimal actualDelta(BigDecimal item) {
5454
* the expected value of matching BigDecimals
5555
* @param error
5656
* the delta (+/-) within which matches will be allowed
57+
* @return The matcher.
5758
*/
5859
public static Matcher<BigDecimal> closeTo(BigDecimal operand, BigDecimal error) {
5960
return new BigDecimalCloseTo(operand, error);

hamcrest/src/main/java/org/hamcrest/number/IsCloseTo.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ private double actualDelta(Double item) {
5656
* the expected value of matching doubles
5757
* @param error
5858
* the delta (+/-) within which matches will be allowed
59+
* @return The matcher.
5960
*/
6061
public static Matcher<Double> closeTo(double operand, double error) {
6162
return new IsCloseTo(operand, error);

hamcrest/src/main/java/org/hamcrest/number/IsNaN.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ public void describeTo(Description description) {
3131
* Creates a matcher of {@link Double}s that matches when an examined double is not a number.
3232
* For example:
3333
* <pre>assertThat(Double.NaN, is(notANumber()))</pre>
34+
*
35+
* @return The matcher.
3436
*/
3537
public static Matcher<Double> notANumber() {
3638
return new IsNaN();

hamcrest/src/main/java/org/hamcrest/number/OrderingComparison.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ private OrderingComparison() {
1616
* <pre>assertThat(1, comparesEqualTo(1))</pre>
1717
*
1818
* @param value the value which, when passed to the compareTo method of the examined object, should return zero
19+
* @return The matcher.
1920
*/
2021
public static <T extends Comparable<T>> Matcher<T> comparesEqualTo(T value) {
2122
return ComparatorMatcherBuilder.<T>usingNaturalOrdering().comparesEqualTo(value);
@@ -30,6 +31,7 @@ public static <T extends Comparable<T>> Matcher<T> comparesEqualTo(T value) {
3031
*
3132
* @param value the value which, when passed to the compareTo method of the examined object, should return greater
3233
* than zero
34+
* @return The matcher.
3335
*/
3436
public static <T extends Comparable<T>> Matcher<T> greaterThan(T value) {
3537
return ComparatorMatcherBuilder.<T>usingNaturalOrdering().greaterThan(value);
@@ -44,6 +46,7 @@ public static <T extends Comparable<T>> Matcher<T> greaterThan(T value) {
4446
*
4547
* @param value the value which, when passed to the compareTo method of the examined object, should return greater
4648
* than or equal to zero
49+
* @return The matcher.
4750
*/
4851
public static <T extends Comparable<T>> Matcher<T> greaterThanOrEqualTo(T value) {
4952
return ComparatorMatcherBuilder.<T>usingNaturalOrdering().greaterThanOrEqualTo(value);
@@ -58,6 +61,7 @@ public static <T extends Comparable<T>> Matcher<T> greaterThanOrEqualTo(T value)
5861
*
5962
* @param value the value which, when passed to the compareTo method of the examined object, should return less
6063
* than zero
64+
* @return The matcher.
6165
*/
6266
public static <T extends Comparable<T>> Matcher<T> lessThan(T value) {
6367
return ComparatorMatcherBuilder.<T>usingNaturalOrdering().lessThan(value);
@@ -72,6 +76,7 @@ public static <T extends Comparable<T>> Matcher<T> lessThan(T value) {
7276
*
7377
* @param value the value which, when passed to the compareTo method of the examined object, should return less
7478
* than or equal to zero
79+
* @return The matcher.
7580
*/
7681
public static <T extends Comparable<T>> Matcher<T> lessThanOrEqualTo(T value) {
7782
return ComparatorMatcherBuilder.<T>usingNaturalOrdering().lessThanOrEqualTo(value);

0 commit comments

Comments
 (0)