search

asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.
https://github.com/asciidoctor/asciidoclet
Apache License 2.0
133 stars 40 forks source link

Integration with Groovy source code #37

Closed gAmUssA closed 8 years ago

gAmUssA commented 9 years ago

Hello,

I have a question regarding integration of asciidoclet with groovydoc. Looks like groovydoc utility doesn't accept doclet class as a parameter.

Is it possible to do?

Thanks

benevans commented 9 years ago

Looks like the answer is no, @aalmiray tried that recently to no avail: http://groovy.329449.n5.nabble.com/Javadoc-doclet-support-in-GroovyDoc-td5720958.html

mojavelinux commented 9 years ago

FYI, the discussion around Groovydoc has rekindled. They are talking about redesigning it, leaving room for AsciiDoc integration (if not supporting it natively).

msgilligan commented 9 years ago

Any updates on using AsciiDoclet with GroovyDoc?

msgilligan commented 9 years ago

I created Groovy JIRA Issue GROOVY-7395 to request Doclet support in Groovydoc.

johncarl81 commented 9 years ago

No updates currently that I know of.

@msgilligan thanks for creating an issue, let me know if we can be of service implementing this.

aalmiray commented 9 years ago

Support for Asciidoclet (as a matter of fact any standard doclet) is a huge task given that groovydoc is not javadoc compatible API wise. We must revise groovydoc and create a new API. The groovy dev team is aware of this fact.

mojavelinux commented 9 years ago

We must revise groovydoc and create a new API.

I think @johncarl81 will agree that we're perfectly willing to adapt to whatever API groovydoc provides. This may even be a good opportunity to set forth some requirements for such an API / parser given the limitations we've encountered in Javadoc.

johncarl81 commented 9 years ago

Yes, completely agree. In fact, why adapt Groovy's groovydoc-doclet to javadoc-doclets? That seems like a large amount of work considering the crufty javadoclet api. Why don't we just write an Asciidoc specific Grovydoc-doclet? Asciidoclet was extremely easy to get off the ground and I'd hope that a port of it to groovydoc would be equally as easy, if not easier knowing Groovy. :smile:

A quick search of Groovydoc doclet shows that it is possible, but maybe Im wrong. Does Groovy have a Groovydoc plugin for replacement syntax processing?

johncarl81 commented 8 years ago

Im closing this due to inactivity. Creating a Groovydoc is a great idea and I encourage someone to take on the challenge (if I don't get to it first).