Instead of a compilation flag... what about a special GroovyDoc annotation?
/** Foo Bar Baz @runtime-retention */
def mymethod() {}
Because otherwise it's all or nothing, not very granular.
Guillaume
On Fri, Feb 24, 2017 at 5:08 AM, Paul King <[email protected]> wrote:
> I like the idea. I thought perhaps groovy.attach.annotation.groovydoc
> was a bit of a long prop name but I haven't thought of a better one
> yet.
>
> Cheers, Paul.
>
> On Fri, Feb 24, 2017 at 12:46 PM, Daniel Sun <[email protected]>
> wrote:
> > Hi all,
> >
> > I am going to add a new annotation Groovydoc(Retention: RUNTIME),
> > which is configurable(e.g. -Dgroovy.attach.annotation.groovydoc=true)
> and
> > can be attached to target element at compilation time automatically.
> >
> > Groovydoc can be got easily even if Groovy source code is compiled
> > into class files, it is a bit like Python's Documentation Strings and
> will
> > be useful for IDE and developers who set a high value on documentations.
> > BTW, currently groovydoc is attached as metadata of AST node, which is
> only
> > avaliable at compilation time and is a bit hard to get(we have to use
> > CompilationUnit, which is not familiar and friendly to most of Groovy
> > developers)
> >
> > # demo for Python's Documentation Strings
> > def my_function():
> > """Do nothing, but document it.
> > No, really, it doesn't do anything.
> > """
> > pass
> > print(my_function.__doc__) # print the Documentation Strings of the
> > function
> >
> >
> > Any thoughts?
> >
> > Cheers,
> > Daniel.Sun
> >
> >
> >
> > --
> > View this message in context: http://groovy.329449.n5.
> nabble.com/About-a-new-annotation-Groovydoc-tp5738721.html
> > Sent from the Groovy Dev mailing list archive at Nabble.com.
>
--
Guillaume Laforge
Apache Groovy committer & PMC Vice-President
Developer Advocate @ Google Cloud Platform
Blog: http://glaforge.appspot.com/
Social: @glaforge <http://twitter.com/glaforge> / Google+
<https://plus.google.com/u/0/114130972232398734985/posts>
