Added extra javadoc to $._

mperry · mperry · commit 24fcb57a0a33 · 2015-08-13T09:23:35.000+10:00
diff --git a/core/src/main/java/fj/data/$.java b/core/src/main/java/fj/data/$.java
@@ -15,10 +15,12 @@ public final class $<A, B> extends P1<B> {
     this.b = b;
   }
 
-	/**
-	 * @deprecated  JDK 8 warns '_' may not be supported after SE 8.  Replaced by {@link #constant} and synonym {@link #__} (prefer constant).
-	 */
-	@Deprecated
+  /**
+   * Returns a function that given an argument, returns a function that ignores its argument.
+   * @deprecated  JDK 8 warns '_' may not be supported after SE 8.  As of release 4.5, use {@link #constant} (note the synonym {@link #__}).
+   * @return A function that given an argument, returns a function that ignores its argument.
+   */
+  @Deprecated
   public static <A, B> $<A, B> _(final B b) {
     return constant(b);
   }
