[groovy] branch GROOVY_2_5_X updated: GROOVY-9028: improve wording around 'includes' for @EqualsAndHashCode wrt also using includeFields

[pa...@apache.org]

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

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


The following commit(s) were added to refs/heads/GROOVY_2_5_X by this push:
     new 0eb00e9  GROOVY-9028: improve wording around 'includes' for @EqualsAndHashCode wrt also using includeFields
0eb00e9 is described below

commit 0eb00e925eb6f68943e90e4d3c036e967f2ee2b3
Author: Paul King <pa...@asert.com.au>
AuthorDate: Fri Mar 8 12:42:14 2019 +1000

    GROOVY-9028: improve wording around 'includes' for @EqualsAndHashCode wrt also using includeFields
---
 src/main/groovy/groovy/transform/EqualsAndHashCode.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/main/groovy/groovy/transform/EqualsAndHashCode.java b/src/main/groovy/groovy/transform/EqualsAndHashCode.java
index 14048eaf..51e480d 100644
--- a/src/main/groovy/groovy/transform/EqualsAndHashCode.java
+++ b/src/main/groovy/groovy/transform/EqualsAndHashCode.java
@@ -228,14 +228,14 @@ import java.lang.annotation.Target;
 @GroovyASTTransformationClass("org.codehaus.groovy.transform.EqualsAndHashCodeASTTransformation")
 public @interface EqualsAndHashCode {
     /**
-     * List of field and/or property names to exclude from the equals and hashCode calculations.
+     * List of property names (and field names if includeFields is true) to exclude from the equals and hashCode calculations.
      * Must not be used if 'includes' is used. For convenience, a String with comma separated names
      * can be used in addition to an array (using Groovy's literal list notation) of String values.
      */
     String[] excludes() default {};
 
     /**
-     * List of field and/or property names to include within the equals and hashCode calculations.
+     * List of property names (and field names if includeFields is true) to include within the equals and hashCode calculations.
      * Must not be used if 'excludes' is used. For convenience, a String with comma separated names
      * can be used in addition to an array (using Groovy's literal list notation) of String values.
      * The default value is a special marker value indicating that no includes are defined; all fields