[GROOVY-9858] In generated closures, annotate generated call() methods with @Generated

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.0.7
• Fix Version/s: 2.5.15, 3.0.8, 4.0.0-alpha-3
• Component/s: Compiler
• Assignee: Paul King
• Reporter: Damir Murat
• Created: 15/Dec/20 12:31
• Updated: 02/May/21 09:16
• Resolved: 15/Jan/21 13:47

Description

Closures generated by the Groovy compiler contain both "doCall()" and "call()" methods, where "call()" always delegate to the "doCall()".

Typically, users will use a short form of closure invocation, which Groovy translates to direct call of "doCall()". This means that the generated "call()" method will never get invoked in a typical scenario.

When using JaCoCo for code coverage, it will report the "call()" method as unused.

For these reasons, it looks sensible to annotate all generated "call()" methods with "@Generated". That way "call()" method will not appear in the coverage report, while the "doCall()", which contains the implementation of a closure body, will be reported as covered.