You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2020/09/26 12:57:46 UTC
[groovy] branch master updated: fix javadoc warnings

This is an automated email from the ASF dual-hosted git repository.

paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git


The following commit(s) were added to refs/heads/master by this push:
     new 1e02f82  fix javadoc warnings
1e02f82 is described below

commit 1e02f82e13532a27d3d7f6b33cee171a858f5ae9
Author: Paul King <pa...@asert.com.au>
AuthorDate: Sat Sep 26 22:57:34 2020 +1000

    fix javadoc warnings
---
 .../groovy-contracts/src/main/java/groovy/contracts/Ensures.java      | 4 ++--
 .../groovy-contracts/src/main/java/groovy/contracts/Requires.java     | 2 +-
 .../contracts/ast/visitor/AnnotationContractParameterVisitor.java     | 4 ++--
 .../java/org/apache/groovy/contracts/generation/BaseGenerator.java    | 2 --
 4 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java b/subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java
index 49f5e05..7b905e5 100644
--- a/subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java
+++ b/subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java
@@ -60,7 +60,7 @@ import java.lang.annotation.Target;
  * Accessing the <tt>result</tt> closure parameter:
  *
  * <pre>
- *   &#064;Ensures({ result -> result != argument1 })
+ *   &#064;Ensures({ result -&gt; result != argument1 })
  *   def T someOperation(def argument1, def argument2)  {
  *     ...
  *   }
@@ -69,7 +69,7 @@ import java.lang.annotation.Target;
  * Accessing the <tt>old</tt> closure parameter:
  *
  * <pre>
- *   &#064;Ensures({ old -> old.counter + 1 == counter })
+ *   &#064;Ensures({ old -&gt; old.counter + 1 == counter })
  *   def T someOperation(def argument1, def argument2)  {
  *     ...
  *   }
diff --git a/subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java b/subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java
index 26d4c4c..b9635af 100644
--- a/subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java
+++ b/subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java
@@ -46,7 +46,7 @@ import java.lang.annotation.Target;
  * Example:
  *
  * <pre>
- *   &#064;Requires({ argument1 != argument2 && argument2 >= 0 })
+ *   &#064;Requires({ argument1 != argument2 &amp;&amp; argument2 &gt;= 0 })
  *   void someOperation(def argument1, def argument2)  {
  *     ...
  *   }
diff --git a/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/ast/visitor/AnnotationContractParameterVisitor.java b/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/ast/visitor/AnnotationContractParameterVisitor.java
index 9f09d55..a0dc2fe 100644
--- a/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/ast/visitor/AnnotationContractParameterVisitor.java
+++ b/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/ast/visitor/AnnotationContractParameterVisitor.java
@@ -31,7 +31,7 @@ import java.util.List;
 
 /**
  * This {@link BaseVisitor} walks up the class hierarchy for the given {@link org.codehaus.groovy.ast.ClassNode}
- * and adds {@link org.apache.groovy.contracts.annotations.meta.AnnotationContract} annotations to method parameters.
+ * and adds {@link org.apache.groovy.contracts.annotations.meta.ContractElement} annotations to method parameters.
  */
 public class AnnotationContractParameterVisitor extends BaseVisitor {
 
@@ -64,6 +64,6 @@ public class AnnotationContractParameterVisitor extends BaseVisitor {
     @Override
     public void visitAnnotations(AnnotatedNode node) {
         if (!(node instanceof Parameter) || currentMethodNode == null) return;
-        List<AnnotationNode> annotationNodes = AnnotationUtils.hasMetaAnnotations(node, "org.apache.groovy.contracts.annotations.meta.AnnotationContract");
+        List<AnnotationNode> annotationNodes = AnnotationUtils.hasMetaAnnotations(node, "org.apache.groovy.contracts.annotations.meta.ContractElement");
     }
 }
diff --git a/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/generation/BaseGenerator.java b/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/generation/BaseGenerator.java
index 6e2f989..02bf376 100644
--- a/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/generation/BaseGenerator.java
+++ b/subprojects/groovy-contracts/src/main/java/org/apache/groovy/contracts/generation/BaseGenerator.java
@@ -66,9 +66,7 @@ import static org.codehaus.groovy.ast.tools.GeneralUtils.tryCatchS;
 import static org.codehaus.groovy.ast.tools.GeneralUtils.varX;
 
 /**
- * <pe
  * Base class for groovy-contracts code generators.
- * </p>
  */
 public abstract class BaseGenerator {