Fixed javadoc warnings for core submodule

Mark Perry · Mark Perry · commit 79f2905722d6 · 2014-06-05T17:44:21.000+10:00
diff --git a/core/src/main/java/fj/Ord.java b/core/src/main/java/fj/Ord.java
@@ -662,11 +662,11 @@ public Ordering f(final A a2) {
   }
 
   /**
-   * An order instance that uses {@link Object#hashCode()} and {@link Object#equals()} for computing
+   * An order instance that uses {@link Object#hashCode()} and {@link Object#equals} for computing
    * the order and equality. First the hashCode is compared, if this is equal, objects are compared
-   * using {@link Object#equals()}.
+   * using {@link Object#equals}.
    *
-   * @return An order instance that is based on {@link Object#hashCode()} and {@link Object#equals()}.
+   * @return An order instance that is based on {@link Object#hashCode()} and {@link Object#equals}.
    */
   public static <A> Ord<A> hashEqualsOrd() {
     return Ord.<A> ord(new F<A, F<A, Ordering>>() {
diff --git a/core/src/main/java/fj/data/$.java b/core/src/main/java/fj/data/$.java
@@ -7,6 +7,7 @@
  * is the identity morphism from B to B.
  */
 @SuppressWarnings({"UnusedDeclaration"})
+@Deprecated
 public final class $<A, B> implements P1<B> {
 
   private final B b;
diff --git a/core/src/main/java/fj/data/IO.java b/core/src/main/java/fj/data/IO.java
@@ -24,8 +24,8 @@
 import fj.data.Iteratee.IterV;
 
 /**
- * IO monad for processing files, with main methods {@link #enumFileLines(File, Option, IterV)},
- * {@link #enumFileChars(File, Option, IterV)} and {@link #enumFileCharChunks(File, Option, IterV)}
+ * IO monad for processing files, with main methods {@link #enumFileLines },
+ * {@link #enumFileChars} and {@link #enumFileCharChunks}
  * (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee
  * without indirection in between).
  *
@@ -58,7 +58,7 @@ public Unit run() throws IOException {
   /**
    * An IO monad that reads lines from the given file (using a {@link BufferedReader}) and passes
    * lines to the provided iteratee. May not be suitable for files with very long
-   * lines, consider to use {@link #enumFileCharChunks(File, IterV)} or {@link #enumFileChars(File, IterV)}
+   * lines, consider to use {@link #enumFileCharChunks} or {@link #enumFileChars}
    * as an alternative.
    * 
    * @param f the file to read, must not be <code>null</code>
diff --git a/core/src/main/java/fj/test/package-info.java b/core/src/main/java/fj/test/package-info.java
@@ -5,7 +5,7 @@
  * the testing and reporting of the status of those properties occurs by automating various aspects.
  * For example, if a property is found to be false (i.e. a test fails), then the counter-example may
  * be reduced while still falsifying the property so that the reported counter-example is the
- * simplest found (this is called {@link Shrink shrinking}). The expression of the property also
+ * simplest found (this is called {@link fj.test.Shrink}). The expression of the property also
  * serves as very rigorous documentation for the code under test; far surpassing that provided by
  * traditional testing techniques.
  *
diff --git a/core/src/main/java/fj/test/reflect/package-info.java b/core/src/main/java/fj/test/reflect/package-info.java
@@ -1,33 +1,33 @@
 /**
  * A wrapper around the <code>fj.test</code> package that uses annotations for configuring properties to
- * check. The properties are found using {@link java.lang.reflect Java Reflection}. All annotations
+ * check. The properties are found using reflection. All annotations
  * are optional and a property is eligible for checking by default. A property is any of the
  * following member descriptions, unless the member or enclosing class is annotated with
- * {@link NoCheck}.
+ * {@link fj.test.reflect.NoCheck}.
  *
 <ul>
-  <li>a static field of type {@link Property}.</li>
-  <li>a static zero argument method that returns {@link Property}.</li>
-  <li>a non-static field of type {@link Property} in a class with a zero-argument constructor.</li>
-  <li>a non-static no-argument method that returns {@link Property} in a class with a no-argument
+  <li>a static field of type {@link fj.test.Property}.</li>
+  <li>a static zero argument method that returns {@link fj.test.Property}.</li>
+  <li>a non-static field of type {@link fj.test.Property} in a class with a zero-argument constructor.</li>
+  <li>a non-static no-argument method that returns {@link fj.test.Property} in a class with a no-argument
       constructor.</li>
 </ul>
  *
  * <p>
  * A property may be in zero or more categories by annotating the member or enclosing class with
- * {@link Category}. The property is in the set of categories that make up the
+ * {@link fj.test.reflect.Category}. The property is in the set of categories that make up the
  * union of its member and enclosing class category annotation.
  * </p>
  * <p>
  * When a property is checked, it uses default configuration values, which may be overridden by
- * annotating the member or the enclosing class with the {@link CheckParams}
+ * annotating the member or the enclosing class with the {@link fj.test.reflect.CheckParams}
  * annotation. The values used are first those specified on the member; or if the annotation does
  * not exist, then the enclosing class (default values otherwise). 
  * </p>
  * <p>
  * A property can have a name associated with it by annotating the member with the
- * {@link Name} annotation. The name is a {@link String} that is used
- * only for reporting in check results. If the {@link Name} annotation does not
+ * {@link fj.test.reflect.Name} annotation. The name is a {@link java.lang.String} that is used
+ * only for reporting in check results. If the {@link fj.test.reflect.Name} annotation does not
  * appear on a property member, then the field or method name is used by default. 
  * </p>
  *

Original file line number	Diff line number	Diff line change
`@@ -662,11 +662,11 @@ public Ordering f(final A a2) {`
`662`	`662`	`}`
`663`	`663`
`664`	`664`	`/**`
`665`		`- * An order instance that uses {@link Object#hashCode()} and {@link Object#equals()} for computing`
	`665`	`+ * An order instance that uses {@link Object#hashCode()} and {@link Object#equals} for computing`
`666`	`666`	`* the order and equality. First the hashCode is compared, if this is equal, objects are compared`
`667`		`- * using {@link Object#equals()}.`
	`667`	`+ * using {@link Object#equals}.`
`668`	`668`	`*`
`669`		`- * @return An order instance that is based on {@link Object#hashCode()} and {@link Object#equals()}.`
	`669`	`+ * @return An order instance that is based on {@link Object#hashCode()} and {@link Object#equals}.`
`670`	`670`	`*/`
`671`	`671`	`public static <A> Ord<A> hashEqualsOrd() {`
`672`	`672`	`return Ord.<A> ord(new F<A, F<A, Ordering>>() {`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`* the testing and reporting of the status of those properties occurs by automating various aspects.`
`6`	`6`	`* For example, if a property is found to be false (i.e. a test fails), then the counter-example may`
`7`	`7`	`* be reduced while still falsifying the property so that the reported counter-example is the`
`8`		`- * simplest found (this is called {@link Shrink shrinking}). The expression of the property also`
	`8`	`+ * simplest found (this is called {@link fj.test.Shrink}). The expression of the property also`
`9`	`9`	`* serves as very rigorous documentation for the code under test; far surpassing that provided by`
`10`	`10`	`* traditional testing techniques.`
`11`	`11`	`*`