Top Description Methods
groovy.lang

public @Interface Groovydoc

extends Annotation
Annotations
@Documented
@Target:TYPE, ANNOTATION_TYPE, FIELD, METHOD, CONSTRUCTOR
@Retention:RUNTIME
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target

An annotation to hold the groovydoc for the annotated element at runtime, we call it "Runtime Groovydoc". Runtime Groovydoc is a bit like Python's Documentation Strings and will be useful for IDE and developers who set a high value on documentations. The usage is very simple, just place @ at the beginning of the content of groovydoc, i.e. starts with /**@, then the new parser Parrot will attach the annotation Groovydoc automatically
Since
3.0.0

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String value()