[groovy] branch master updated: GROOVY-10442: @Immutable GroovyDoc examples use @Canonical instead

[pa...@apache.org]

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 cc09844bae GROOVY-10442: @Immutable GroovyDoc examples use @Canonical instead
cc09844bae is described below

commit cc09844bae91927c513c01ccc9d0bea1f180a888
Author: Paul King <pa...@asert.com.au>
AuthorDate: Tue Nov 22 14:19:07 2022 +1000

    GROOVY-10442: @Immutable GroovyDoc examples use @Canonical instead
---
 src/main/groovy/groovy/transform/Immutable.groovy | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/main/groovy/groovy/transform/Immutable.groovy b/src/main/groovy/groovy/transform/Immutable.groovy
index 4c130a3662..e92b9e1a72 100644
--- a/src/main/groovy/groovy/transform/Immutable.groovy
+++ b/src/main/groovy/groovy/transform/Immutable.groovy
@@ -136,7 +136,7 @@ import java.lang.annotation.Target
  * <pre class="groovyTestCase">
  * import groovy.transform.*
  *
- * &#64;Canonical
+ * &#64;Immutable(defaults=true, noArg=false)
  * class Building {
  *     String name
  *     int floors
@@ -165,7 +165,7 @@ import java.lang.annotation.Target
  * assert offices.size() == 2
  * assert offices.name.join(',') == 'Initech office,Wernham Hogg Paper Company'
  *
- * &#64;Canonical
+ * &#64;Immutable
  * &#64;ToString(excludes='age')  // Customize one of the transformations.
  * class Person {
  *     String name