groovy

GroovyDoc should publish info on @Documented annotations

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: GroovyDoc
  • Labels:
  • Number of attachments :
    0

Description

GroovyDoc should publish info on @Documented annotations.

java.lang.annotations.Documented is used to signal the Javadoc app to write out information about the annotated class into the Javadoc. Groovydoc should do the same.

All of our AST Transformations are already marked @Documented

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Peter Niederwieser added a comment -

I wonder why annotations on my Groovy methods show up in Groovydoc, even if the annotation type isn't annotated with @Documented. Is this how Javadoc/Groovydoc is supposed to work? Somehow it seems that @Documented is only intended for class-level annotations.

Show
Peter Niederwieser added a comment - I wonder why annotations on my Groovy methods show up in Groovydoc, even if the annotation type isn't annotated with @Documented. Is this how Javadoc/Groovydoc is supposed to work? Somehow it seems that @Documented is only intended for class-level annotations.
Hide
Permalink
Paul King added a comment -

Currently, @Documented is ignored but Groovydoc does its best to show all annotations. So basically, Groovydoc has no way to hide annotations should you not want them shown.

Show
Paul King added a comment - Currently, @Documented is ignored but Groovydoc does its best to show all annotations. So basically, Groovydoc has no way to hide annotations should you not want them shown.

People

  • Assignee:
    Unassigned
    Reporter:
    Hamlet D'Arcy
Vote (0)
Watch (1)

Dates

  • Created:
    Updated: