More JavaDoc for core matchers.

joe.walnes · joe.walnes · commit ebfc82d89fed · 2007-05-21T17:05:55.000Z
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/AllOf.java b/hamcrest-core/src/main/java/org/hamcrest/core/AllOf.java
@@ -42,11 +42,17 @@ public void describeTo(Description description) {
         description.appendText(")");
     }
 
+    /**
+     * MM Evaluates to true only if ALL of the passed in matchers evaluate to true.
+     */
     @Factory
     public static <T> Matcher<T> allOf(Matcher<T>... matchers) {
         return allOf(Arrays.asList(matchers));
     }
 
+    /**
+     * IM Evaluates to true only if ALL of the passed in matchers evaluate to true.
+     */
     @Factory
     public static <T> Matcher<T> allOf(Iterable<Matcher<T>> matchers) {
         return new AllOf<T>(matchers);
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/AnyOf.java b/hamcrest-core/src/main/java/org/hamcrest/core/AnyOf.java
@@ -43,11 +43,17 @@ public void describeTo(Description description) {
         description.appendText(")");
     }
 
+    /**
+     * Evaluates to true if ANY of the passed in matchers evaluate to true.
+     */
     @Factory
     public static <T> Matcher<T> anyOf(Matcher<T>... matchers) {
         return anyOf(Arrays.asList(matchers));
     }
 
+    /**
+     * Evaluates to true if ANY of the passed in matchers evaluate to true.
+     */
     @Factory
     public static <T> Matcher<T> anyOf(Iterable<Matcher<T>> matchers) {
         return new AnyOf<T>(matchers);
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/DescribedAs.java b/hamcrest-core/src/main/java/org/hamcrest/core/DescribedAs.java
@@ -44,7 +44,10 @@ public void describeTo(Description description) {
             description.appendText(descriptionTemplate.substring(textStart));
         }
     }
-    
+
+    /**
+     * Wraps an existing matcher and overrides the description when it fails.
+     */
     @Factory
     public static <T> Matcher<T> describedAs(String description, Matcher<T> matcher, Object... values) {
         return new DescribedAs<T>(description, matcher, values);
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/IsInstanceOf.java b/hamcrest-core/src/main/java/org/hamcrest/core/IsInstanceOf.java
@@ -33,9 +33,12 @@ public void describeTo(Description description) {
                 .appendText(theClass.getName());
     }
 
+    /**
+     * Is the value an instance of a particular type?
+     */
     @Factory
-    public static <T> Matcher<T> instanceOf(Class<T> instanceOf) {
-        return new IsInstanceOf<T>(instanceOf);
+    public static <T> Matcher<T> instanceOf(Class<T> type) {
+        return new IsInstanceOf<T>(type);
     }
 
 }
diff --git a/hamcrest-generator/src/main/java/org/hamcrest/generator/ReflectiveFactoryReader.java b/hamcrest-generator/src/main/java/org/hamcrest/generator/ReflectiveFactoryReader.java
@@ -73,11 +73,12 @@ public void remove() {
      * <p/>
      * <p>The rules for determining this are:
      * 1. The method must be public static.
-     * 2. It must have a return type of {@link Matcher} (or something that extends this).
-     * 3. It must be marked with the {@link Factory} annotation.
+     * 2. It must have a return type of org.hamcrest.Matcher (or something that extends this).
+     * 3. It must be marked with the org.hamcrest.Factory annotation.
      * <p/>
      * <p>To use another set of rules, override this method.
      */
+    @SuppressWarnings({"unchecked"})
     protected boolean isFactoryMethod(Method javaMethod) {
         // We dynamically load these classes, to avoid a compile time
         // dependency on org.hamcrest.{Factory,Matcher}. This gets around

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,10 @@ public void describeTo(Description description) {`
`44`	`44`	`description.appendText(descriptionTemplate.substring(textStart));`
`45`	`45`	`}`
`46`	`46`	`}`
`47`		`-`
	`47`	`+`
	`48`	`+ /**`
	`49`	`+ * Wraps an existing matcher and overrides the description when it fails.`
	`50`	`+ */`
`48`	`51`	`@Factory`
`49`	`52`	`public static <T> Matcher<T> describedAs(String description, Matcher<T> matcher, Object... values) {`
`50`	`53`	`return new DescribedAs<T>(description, matcher, values);`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,12 @@ public void describeTo(Description description) {`
`33`	`33`	`.appendText(theClass.getName());`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * Is the value an instance of a particular type?`
	`38`	`+ */`
`36`	`39`	`@Factory`
`37`		`- public static <T> Matcher<T> instanceOf(Class<T> instanceOf) {`
`38`		`- return new IsInstanceOf<T>(instanceOf);`
	`40`	`+ public static <T> Matcher<T> instanceOf(Class<T> type) {`
	`41`	`+ return new IsInstanceOf<T>(type);`
`39`	`42`	`}`
`40`	`43`
`41`	`44`	`}`