Ritual sacrifice to pedantic javadoc gods

jnape · jnape · commit a04f781cd2f8 · 2018-07-15T20:00:37.000-05:00
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn2.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn2.java
@@ -33,7 +33,7 @@ public interface Fn2<A, B, C> extends Fn1<A, Fn1<B, C>> {
     C apply(A a, B b);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn3<Z, A, B, C> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn3.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn3.java
@@ -32,7 +32,7 @@ public interface Fn3<A, B, C, D> extends Fn2<A, B, Fn1<C, D>> {
     D apply(A a, B b, C c);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn4<Z, A, B, C, D> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn4.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn4.java
@@ -34,7 +34,7 @@ public interface Fn4<A, B, C, D, E> extends Fn3<A, B, C, Fn1<D, E>> {
     E apply(A a, B b, C c, D d);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn5<Z, A, B, C, D, E> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn5.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn5.java
@@ -36,7 +36,7 @@ public interface Fn5<A, B, C, D, E, F> extends Fn4<A, B, C, D, Fn1<E, F>> {
     F apply(A a, B b, C c, D d, E e);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn6<Z, A, B, C, D, E, F> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn6.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn6.java
@@ -38,7 +38,7 @@ public interface Fn6<A, B, C, D, E, F, G> extends Fn5<A, B, C, D, E, Fn1<F, G>>
     G apply(A a, B b, C c, D d, E e, F f);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn7<Z, A, B, C, D, E, F, G> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/Fn7.java b/src/main/java/com/jnape/palatable/lambda/functions/Fn7.java
@@ -40,7 +40,7 @@ public interface Fn7<A, B, C, D, E, F, G, H> extends Fn6<A, B, C, D, E, F, Fn1<G
     H apply(A a, B b, C c, D d, E e, F f, G g);
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     @Override
     default <Z> Fn8<Z, A, B, C, D, E, F, G, H> widen() {
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn2/LTE.java b/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn2/LTE.java
@@ -9,7 +9,7 @@
 
 /**
  * Given two {@link Comparable} values of type <code>A</code>, return <code>true</code> if the first value is less than
- * or equal to the second value according to {@link Comparable#compareTo(Object);} otherwise, return false.
+ * or equal to the second value according to {@link Comparable#compareTo(Object)} otherwise, return false.
  *
  * @param <A> the value typ
  * @see LTEBy
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn4/RateLimit.java b/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn4/RateLimit.java
@@ -21,15 +21,15 @@
  * <p>
  * As an example, the following will print at most 10 elements per second:
  * <pre><code>
- * rateLimit(Clock.systemUTC()::instant, 10L, Duration.ofSeconds(1), iterate(x -> x + 1, 1)).forEach(System.out::println);
+ * rateLimit(Clock.systemUTC()::instant, 10L, Duration.ofSeconds(1), iterate(x -&gt; x + 1, 1)).forEach(System.out::println);
  * </code></pre>
  * Currying allows different rate limits to be combined naturally:
  * <pre><code>
- * Iterable<Integer> elements = iterate(x -> x + 1, 1);
+ * Iterable&lt;Integer&gt; elements = iterate(x -&gt; x + 1, 1);
  *
- * Supplier<Instant> instantSupplier = Clock.systemUTC()::instant;
- * Fn1<Iterable<Integer>, Iterable<Integer>> tenPerSecond = rateLimit(instantSupplier, 10L, Duration.ofSeconds(1));
- * Fn1<Iterable<Integer>, Iterable<Integer>> oneHundredEveryTwoMinutes = rateLimit(instantSupplier, 100L, Duration.ofMinutes(2));
+ * Supplier&lt;Instant&gt; instantSupplier = Clock.systemUTC()::instant;
+ * Fn1&lt;Iterable&lt;Integer&gt;, Iterable&lt;Integer&gt;&gt; tenPerSecond = rateLimit(instantSupplier, 10L, Duration.ofSeconds(1));
+ * Fn1&lt;Iterable&lt;Integer&gt;, Iterable&lt;Integer&gt;&gt; oneHundredEveryTwoMinutes = rateLimit(instantSupplier, 100L, Duration.ofMinutes(2));
  *
  * tenPerSecond.fmap(oneHundredEveryTwoMinutes).apply(elements).forEach(System.out::println);
  * </code></pre>

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Given two {@link Comparable} values of type <code>A</code>, return <code>true</code> if the first value is less than`
`12`		`- * or equal to the second value according to {@link Comparable#compareTo(Object);} otherwise, return false.`
	`12`	`+ * or equal to the second value according to {@link Comparable#compareTo(Object)} otherwise, return false.`
`13`	`13`	`*`
`14`	`14`	`* @param <A> the value typ`
`15`	`15`	`* @see LTEBy`