groovy git commit: GROOVY-8257: Incorrect package for Mixin AST transform in online docs

Previous Topic Next Topic
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

groovy git commit: GROOVY-8257: Incorrect package for Mixin AST transform in online docs

Repository: groovy
Updated Branches:
  refs/heads/GROOVY_2_4_X f771ce971 -> 563a7e271

GROOVY-8257: Incorrect package for Mixin AST transform in online docs


Branch: refs/heads/GROOVY_2_4_X
Commit: 563a7e271dd9cff207abaa5a29d30a7ed9d4358b
Parents: f771ce9
Author: paulk <[hidden email]>
Authored: Sat Jul 15 05:12:03 2017 +1000
Committer: paulk <[hidden email]>
Committed: Sat Jul 15 08:20:27 2017 +1000

 .../doc/core-domain-specific-languages.adoc     |  1 +
 src/spec/doc/core-metaprogramming.adoc          | 22 ++++++++++++++++++--
 src/spec/doc/core-traits.adoc                   |  1 +
 3 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/src/spec/doc/core-domain-specific-languages.adoc b/src/spec/doc/core-domain-specific-languages.adoc
index 77c26c2..412c3e8 100644
--- a/src/spec/doc/core-domain-specific-languages.adoc
+++ b/src/spec/doc/core-domain-specific-languages.adoc
@@ -196,6 +196,7 @@ include::{projectdir}/src/spec/test/BaseScriptSpecTest.groovy[tags=use_custom_co
 <3> then create a `GroovyShell` using that configuration
 <4> the script will then extend the base script class, giving direct access to the `name` property and `greet` method
 === The @BaseScript annotation
 As an alternative, it is also possible to use the `@BaseScript` annotation directly into a script:
diff --git a/src/spec/doc/core-metaprogramming.adoc b/src/spec/doc/core-metaprogramming.adoc
index 6e8676e..a4429e4 100644
--- a/src/spec/doc/core-metaprogramming.adoc
+++ b/src/spec/doc/core-metaprogramming.adoc
@@ -1336,6 +1336,13 @@ The annotation attribute `forClass` is not supported for this strategy.
 This category of annotations are aimed at simplifying the implementation of well-known design patterns (delegation,
 singleton, ...) by using a declarative style.
+===== `@groovy.transform.BaseScript`
+`@BaseScript` is used within scripts to indicate that the script should
+extend fron a custom script base class rather than `groovy.lang.Script`.
+See the documentation for <<dsl-basescript,domain specific languages>> for further details.
 ===== `@groovy.lang.Delegate`
@@ -1491,6 +1498,11 @@ _protectedCacheSize>0_ would create an unlimited cache with some results protect
  create a limited cache but without any protection from garbage protection. Setting both would create a limited,
  protected cache.
+===== `@groovy.transform.TailRecursive`
 ===== `@groovy.lang.Singleton`
@@ -1521,7 +1533,7 @@ include::{projectdir}/src/spec/test/ClassDesignASTTransformsTest.groovy[tags=sin
 In this example, we also set the `strict` parameter to false, which allows us to define our own constructor.
-===== `@groovy.transform.Mixin`
+===== `@groovy.lang.Mixin`
 Deprecated. Consider using traits instead.
@@ -2127,6 +2139,12 @@ for testing purposes, or when integrating with third-party libraries which requi
 using <<xform-TypeChecked,type checking>> or <<xform-CompileStatic, static compilation>>. The annotation is described thoroughly in the
 <<section-delegatesto,DSL section>> of this guide.
+===== `@groovy.transform.SelfType`
+`@SelfType` is not an AST transformation but rather a marker interface used
+with traits. See the <<traits-selftype,traits documentation>> for further details.
 ==== Swing patterns
@@ -2215,7 +2233,7 @@ include::{projectdir}/src/spec/test/SwingASTTransformsTest.groovy[tags=vetoable_
 ==== Test assistance
-===== `@groovy.lang.NotYetImplemented`
+===== `@groovy.transform.NotYetImplemented`
 `@NotYetImplemented` is used to invert the result of a JUnit 3/4 test case. It is in particular useful if a feature is not yet implemented but the test is. In that case, it is expected
 that the test fails. Marking it with `@NotYetImplemented` will inverse the result of the test, like in this example:
diff --git a/src/spec/doc/core-traits.adoc b/src/spec/doc/core-traits.adoc
index d443b94..37d5382 100644
--- a/src/spec/doc/core-traits.adoc
+++ b/src/spec/doc/core-traits.adoc
@@ -786,6 +786,7 @@ include::{projectdir}/src/spec/test/TraitsSpecificationTest.groovy[tags=selftype
 If you want to be able to call this in the trait, then you will explicitly need to cast `this` into a `Device`. This can
 quickly become unreadable with explicit casts to this everywhere.
 === The @SelfType annotation
 In order to make this contract explicit, and to make the type checker aware of the _type of itself_, Groovy provides