Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot properly aggregate groovydocs #39

Open
ohr opened this issue Mar 18, 2015 · 2 comments
Open

Cannot properly aggregate groovydocs #39

ohr opened this issue Mar 18, 2015 · 2 comments
Assignees

Comments

@ohr
Copy link

ohr commented Mar 18, 2015

In a multimodule project with mixed java/groovy sources I'd like to generate aggregated javadocs in the root project (for site generation) as well as javadoc jars in the individual subprojects (because you cannot deploy anything to Maven Central without it).

  • So far I use the gplus:generateStubs goal before running the maven:javadoc plugin, but sadly gplus:generateStubs loses all the original javadocs of the Groovy sources (probably a Groovy problem)
  • I considered using the gplus:groovydoc goal, but this has no "aggregate" mode like maven:javadoc has and I neither detected an option to generate a jar file from the javadocs

It would be great if any of the two issues could be improved. Or did I miss something?

@keeganwitt
Copy link
Member

Long story short, yea, Groovy's stub generation code doesn't keep the Javadoc. There's been talk of changing Groovy's model and merging in some of the changes Groovy-Eclipse has in their forked Groovy classes, but this is an issue that's been talked about for years and I don't know when it's ever going to get done. I could fork Groovy's code like GMaven used to, but this makes for some rather onerous maintenance demands and I couldn't think of another option. I discuss why I decided against that approach in the first place on the About page.

As a workaround, you should be able to copy the Groovydoc as files from each module into a single consolidated location with either GMavenPlus's execute goal or the AntRun plugin, right? Then you'd use the Assembly plugin to create a jar from that location. I know that is a bit cumbersome -- I'll have a look at what the Javadoc Plugin does, and maybe I can enhance the Groovydoc goal to offer the option to do that consolidation for you.

@keeganwitt keeganwitt self-assigned this Mar 18, 2015
@keeganwitt
Copy link
Member

Changing the GroovyDoc mojos to implement MavenReport is not trivial. One piece that's still missing is how I'd connect Groovy's Groovydoc-producing classes to a Sink. I'm still investigating.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants