You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by su...@apache.org on 2020/01/22 17:26:17 UTC
[groovy] 03/15: fix javadoc warnings
This is an automated email from the ASF dual-hosted git repository.
sunlan pushed a commit to branch GROOVY_3_0_X
in repository https://gitbox.apache.org/repos/asf/groovy.git
commit 9765156b4a3ff102112e74c9c30957f01cd62c62
Author: Paul King <pa...@asert.com.au>
AuthorDate: Tue Jan 21 21:27:01 2020 +1000
fix javadoc warnings
(cherry picked from commit 336c72230979d54f1e63335bc17e0742a406fd4f)
---
.../codehaus/groovy/control/CompilationUnit.java | 6 +--
.../vmplugin/v8/PluginDefaultGroovyMethods.java | 56 +++++++++++-----------
2 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/src/main/java/org/codehaus/groovy/control/CompilationUnit.java b/src/main/java/org/codehaus/groovy/control/CompilationUnit.java
index bd21641..7889a5d 100644
--- a/src/main/java/org/codehaus/groovy/control/CompilationUnit.java
+++ b/src/main/java/org/codehaus/groovy/control/CompilationUnit.java
@@ -112,12 +112,12 @@ public class CompilationUnit extends ProcessingUnit {
}
}
- /** Controls behavior of {@link #classgen()} and other routines. */
+ /** Controls behavior of {@link #classgen} and other routines. */
protected boolean debug;
/** True after the first {@link #configure(CompilerConfiguration)} operation. */
protected boolean configured;
- /** A callback for use during {@link #classgen()} */
+ /** A callback for use during {@link #classgen} */
protected ClassgenCallback classgenCallback;
/** A callback for use during {@link #compile()} */
protected ProgressCallback progressCallback;
@@ -721,7 +721,7 @@ public class CompilationUnit extends ProcessingUnit {
};
/**
- * Runs {@link #classgen()} on a single {@code ClassNode}.
+ * Runs class generation on a single {@code ClassNode}.
*/
private final IPrimaryClassNodeOperation classgen = new IPrimaryClassNodeOperation() {
@Override
diff --git a/src/main/java/org/codehaus/groovy/vmplugin/v8/PluginDefaultGroovyMethods.java b/src/main/java/org/codehaus/groovy/vmplugin/v8/PluginDefaultGroovyMethods.java
index 305ac26..d3952fb 100644
--- a/src/main/java/org/codehaus/groovy/vmplugin/v8/PluginDefaultGroovyMethods.java
+++ b/src/main/java/org/codehaus/groovy/vmplugin/v8/PluginDefaultGroovyMethods.java
@@ -126,7 +126,7 @@ public class PluginDefaultGroovyMethods {
/**
* Tests given value against specified type and changes generics of result.
- * This is equivalent to: <code>self.filter(it -> it instanceof Type).map(it -> (Type) it)</code>
+ * This is equivalent to: <code>self.filter(it -> it instanceof Type).map(it -> (Type) it)</code>
* <pre class="groovyTestCase">
* assert !Optional.empty().filter(Number).isPresent()
* assert !Optional.of('x').filter(Number).isPresent()
@@ -145,10 +145,10 @@ public class PluginDefaultGroovyMethods {
* the given predicate and returns the optional if the test returns true or
* else empty.
* <pre class="groovyTestCase">
- * assert !OptionalInt.empty().filter(i -> true).isPresent()
- * assert OptionalInt.of(1234).filter(i -> true).isPresent()
- * assert !OptionalInt.of(1234).filter(i -> false).isPresent()
- * assert OptionalInt.of(1234).filter(i -> true).getAsInt() == 1234
+ * assert !OptionalInt.empty().filter(i -> true).isPresent()
+ * assert OptionalInt.of(1234).filter(i -> true).isPresent()
+ * assert !OptionalInt.of(1234).filter(i -> false).isPresent()
+ * assert OptionalInt.of(1234).filter(i -> true).getAsInt() == 1234
* </pre>
*
* @since 3.0.0
@@ -165,10 +165,10 @@ public class PluginDefaultGroovyMethods {
* the given predicate and returns the optional if the test returns true or
* else empty.
* <pre class="groovyTestCase">
- * assert !OptionalLong.empty().filter(n -> true).isPresent()
- * assert OptionalLong.of(123L).filter(n -> true).isPresent()
- * assert !OptionalLong.of(123L).filter(n -> false).isPresent()
- * assert OptionalLong.of(123L).filter(n -> true).getAsLong() == 123L
+ * assert !OptionalLong.empty().filter(n -> true).isPresent()
+ * assert OptionalLong.of(123L).filter(n -> true).isPresent()
+ * assert !OptionalLong.of(123L).filter(n -> false).isPresent()
+ * assert OptionalLong.of(123L).filter(n -> true).getAsLong() == 123L
* </pre>
*
* @since 3.0.0
@@ -185,10 +185,10 @@ public class PluginDefaultGroovyMethods {
* the given predicate and returns the optional if the test returns true or
* empty otherwise.
* <pre class="groovyTestCase">
- * assert !OptionalDouble.empty().filter(n -> true).isPresent()
- * assert OptionalDouble.of(Math.PI).filter(n -> true).isPresent()
- * assert !OptionalDouble.of(Math.PI).filter(n -> false).isPresent()
- * assert OptionalDouble.of(Math.PI).filter(n -> true).getAsDouble() == Math.PI
+ * assert !OptionalDouble.empty().filter(n -> true).isPresent()
+ * assert OptionalDouble.of(Math.PI).filter(n -> true).isPresent()
+ * assert !OptionalDouble.of(Math.PI).filter(n -> false).isPresent()
+ * assert OptionalDouble.of(Math.PI).filter(n -> true).getAsDouble() == Math.PI
* </pre>
*
* @since 3.0.0
@@ -204,9 +204,9 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalInt}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !OptionalInt.empty().mapToObj(x -> new Object()).isPresent()
- * assert OptionalInt.of(1234).mapToObj(x -> new Object()).isPresent()
- * assert !OptionalInt.of(1234).mapToObj(x -> null).isPresent()
+ * assert !OptionalInt.empty().mapToObj(x -> new Object()).isPresent()
+ * assert OptionalInt.of(1234).mapToObj(x -> new Object()).isPresent()
+ * assert !OptionalInt.of(1234).mapToObj(x -> null).isPresent()
* assert OptionalInt.of(1234).mapToObj(Integer::toString).get() == '1234'
* </pre>
*
@@ -223,9 +223,9 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalLong}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !OptionalLong.empty().mapToObj(x -> new Object()).isPresent()
- * assert OptionalLong.of(123L).mapToObj(x -> new Object()).isPresent()
- * assert !OptionalLong.of(123L).mapToObj(x -> null).isPresent()
+ * assert !OptionalLong.empty().mapToObj(x -> new Object()).isPresent()
+ * assert OptionalLong.of(123L).mapToObj(x -> new Object()).isPresent()
+ * assert !OptionalLong.of(123L).mapToObj(x -> null).isPresent()
* assert OptionalLong.of(1234L).mapToObj(Long::toString).get() == '1234'
* </pre>
*
@@ -242,9 +242,9 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalDouble}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !OptionalDouble.empty().mapToObj(x -> new Object()).isPresent()
- * assert OptionalDouble.of(Math.PI).mapToObj(x -> new Object()).isPresent()
- * assert !OptionalDouble.of(Math.PI).mapToObj(x -> null).isPresent()
+ * assert !OptionalDouble.empty().mapToObj(x -> new Object()).isPresent()
+ * assert OptionalDouble.of(Math.PI).mapToObj(x -> new Object()).isPresent()
+ * assert !OptionalDouble.of(Math.PI).mapToObj(x -> null).isPresent()
* assert OptionalDouble.of(Math.PI).mapToObj(Double::toString).get().startsWith('3.14')
* </pre>
*
@@ -261,8 +261,8 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalInt}, returns an {@code OptionalInt}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !Optional.empty().mapToInt(x -> 42).isPresent()
- * assert Optional.of('x').mapToInt(x -> 42).getAsInt() == 42
+ * assert !Optional.empty().mapToInt(x -> 42).isPresent()
+ * assert Optional.of('x').mapToInt(x -> 42).getAsInt() == 42
* </pre>
*
* @since 3.0.0
@@ -278,8 +278,8 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalLong}, returns an {@code OptionalLong}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !Optional.empty().mapToLong(x -> 42L).isPresent()
- * assert Optional.of('x').mapToLong(x -> 42L).getAsLong() == 42L
+ * assert !Optional.empty().mapToLong(x -> 42L).isPresent()
+ * assert Optional.of('x').mapToLong(x -> 42L).getAsLong() == 42L
* </pre>
*
* @since 3.0.0
@@ -295,8 +295,8 @@ public class PluginDefaultGroovyMethods {
* If a value is present in the {@code OptionalDouble}, returns an {@code OptionalDouble}
* consisting of the result of applying the given function to the value or else empty.
* <pre class="groovyTestCase">
- * assert !Optional.empty().mapToDouble(x -> Math.PI).isPresent()
- * assert Optional.of('x').mapToDouble(x -> Math.PI).getAsDouble() == Math.PI
+ * assert !Optional.empty().mapToDouble(x -> Math.PI).isPresent()
+ * assert Optional.of('x').mapToDouble(x -> Math.PI).getAsDouble() == Math.PI
* </pre>
*
* @since 3.0.0