groovy

Groovydoc doesn't support multiple locations in sourcepath

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.6-beta-2
  • Fix Version/s: 1.6-rc-1, 1.5.8, 1.7-beta-1
  • Component/s: Ant integration
  • Labels:
    None
  • Environment:
    Windows XP SP3, Ubuntu 8.10
  • Testcase included:
    yes
  • Patch Submitted:
    Yes
  • Number of attachments :
    1

Description

The groovydoc ant task exposes a sourcepath attribute that currently only supports a Path with a single location.

The code in org/codehaus/groovy/ant/Groovydoc.java handles the reading of multiple path locations, but when it comes to parsing the classes using org/codehaus/groovy/tools/groovydoc/GroovyDocTool.java and org/codehaus/groovy/tools/groovydoc/GroovyRootDocBuilder.java sourcepath is expected to be a string and therefore treated as a single location.

I have attached a patch to support multiple locations in GroovyDocTool.java and GroovyRootDocBuilder.java I have updated the GroovyDocToolTest.java to reflect the changes. There was also a minor change to teh Groovydoc.java file itself.

Activity

Hide
Permalink
Guillaume Laforge added a comment -

Thank you very much, Ben, for this patch!

In case you feel like contributing some more in this area, now that you've dived into GroovyDoc, there are a few other issues you may be interested in working on. There are sub-tasks of GROOVY-3087.
Do you fancy any of them?
Contributions are always most welcome

Show
Guillaume Laforge added a comment - Thank you very much, Ben, for this patch! In case you feel like contributing some more in this area, now that you've dived into GroovyDoc, there are a few other issues you may be interested in working on. There are sub-tasks of GROOVY-3087 . Do you fancy any of them? Contributions are always most welcome

People

  • Assignee:
    Guillaume Laforge
    Reporter:
    Ben Leedham
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: