[GROOVY-8242] Javadoc for Newify is missing some attribute values

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.4.13
• Assignee: John Wagenleitner
• Reporter: Eric Milles
• Created: 30/Jun/17 15:37
• Updated: 06/Mar/18 23:25
• Resolved: 06/Aug/17 04:13

Description

I was looking at thw Newify AST transform. Some of the Javadoc appears incorrect since the annotation requires a value.

 * or this ("Ruby-style"):
 * <pre>
 * {@code @Newify} class MyTreeProcessor {  --  Is this supposed to be @Newify([Tree,Leaf])?
 *     def myTree = Tree.new(Tree.new(Leaf.new("A"), Leaf.new("B")), Leaf.new("C"))
 *     def process() { ... }
 * }
 * </pre>

 * An example showing how to use the annotation at different levels:
 * <pre>
 * {@code @Newify(auto=false, value=Foo)}
 * class Main {
 *     {@code @Newify} // turn auto on for field  --  Is this supposed to be @Newify(BigInteger)?
 *     def field1 = java.math.BigInteger.new(42)
 *     def field2, field3, field4
 *
 *     {@code @Newify(Bar)}
 *     def process() {
 *         field2 = Bar("my bar")
 *     }
 *
 *     {@code @Newify(Baz)}
 *     Main() {
 *         field3 = Foo("my foo")
 *         field4 = Baz("my baz")
 *     }
 * }
 * </pre>

Issue Links

• links to: GitHub Pull Request #579