GMaven (OLD... DO NOT USE)
  1. GMaven (OLD... DO NOT USE)
  2. MGROOVY-142

Javadoc plugin must be configured to use generated stubs, docs do not specify this

    Details

    • Type: Bug Bug
    • Status: Closed Closed
    • Priority: Minor Minor
    • Resolution: Cannot Reproduce
    • Affects Version/s: None
    • Fix Version/s: 1.0-rc-4
    • Component/s: site
    • Labels:
      None
    • Number of attachments :
      0

      Description

      I can't javadoc to use the stubs unless I specify it manually in the config with sourcepath. If this is the intended behaviour, it should be documented in the wiki (which I am happy to do), but the current documentation insinuates it should happen automatically.

        Activity

        Hide
        Jason Dillon added a comment -

        I think the trick is to do something like mvn install site so that the normal groovy tasks execute and add the additional paths to the build. I'm really starting to think about just using src/main/java and src/test/java for the java+groovy mixed bits, cause maven's lack of support to deal with other paths (and have other plugins know about them easily) just plain sucks ass.

        Show
        Jason Dillon added a comment - I think the trick is to do something like mvn install site so that the normal groovy tasks execute and add the additional paths to the build. I'm really starting to think about just using src/main/java and src/test/java for the java+groovy mixed bits, cause maven's lack of support to deal with other paths (and have other plugins know about them easily) just plain sucks ass.
        Hide
        Luke Daley added a comment -

        Wouldn't this actually not help though, considering that the plugin must be configured to use `target/generated-sources/groovy-stubs/main` ?

        IMO, it's reasonable to have to have users change the javadoc config. If it can't happen automatically, let me know and I'll write a howto in the wiki for this.

        Show
        Luke Daley added a comment - Wouldn't this actually not help though, considering that the plugin must be configured to use `target/generated-sources/groovy-stubs/main` ? IMO, it's reasonable to have to have users change the javadoc config. If it can't happen automatically, let me know and I'll write a howto in the wiki for this.
        Hide
        Jason Dillon added a comment -

        It should work fine, as those directory get appended to the poms list of source roots when the goal is run. You should not need to configure anything super fancy for javadoc.

        Show
        Jason Dillon added a comment - It should work fine, as those directory get appended to the poms list of source roots when the goal is run. You should not need to configure anything super fancy for javadoc.
        Hide
        Jason Dillon added a comment -

        Anyways, if you have an example project + the mvn command-line you use to make it not work, please attach and I'll look at it.

        Show
        Jason Dillon added a comment - Anyways, if you have an example project + the mvn command-line you use to make it not work, please attach and I'll look at it.
        Hide
        Jason Dillon added a comment -

        Javadoc of stubs appears to work fine for me w/o any additional configuration of the javadoc-maven-plugin.

        Show
        Jason Dillon added a comment - Javadoc of stubs appears to work fine for me w/o any additional configuration of the javadoc-maven-plugin.

          People

          • Assignee:
            Jason Dillon
            Reporter:
            Luke Daley
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: