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

In Groovydoc plugin link to Groovy API is hardcoded to version 2.5.6 #301

Closed
dmurat opened this issue May 10, 2020 · 5 comments
Closed

In Groovydoc plugin link to Groovy API is hardcoded to version 2.5.6 #301

dmurat opened this issue May 10, 2020 · 5 comments
Assignees
Labels
bug Something isn't working
Milestone

Comments

@dmurat
Copy link

dmurat commented May 10, 2020

I'm using Groovy 3.0.3, so it does not suit me to link to the Groovy 2.5.6.

I believe the problem originates from org.kordamp.gradle.plugin.base.plugins.Groovydoc constructor. I'm not quite sure how to handle it. Maybe with some additional configuration option, maybe by adding user-configured entries at the start of the set (if this works) or maybe via some more elaborate resolving mechanism similar to the one used for resolving Java documentation.

I'm using kordamp 0.36.0

Tnx.

@dmurat
Copy link
Author

dmurat commented May 10, 2020

Forgot to mention, the documentation states that default is an empty set. It should enumerate actual defaults. In addition, the link to the Groovy documentation probably should start with https instead of http.

@aalmiray aalmiray self-assigned this May 10, 2020
@aalmiray aalmiray added this to the 0.37.0 milestone May 10, 2020
@aalmiray aalmiray added the bug Something isn't working label May 10, 2020
@aalmiray
Copy link
Collaborator

I think you can override the set by assigning an empty value, then add the link you need

config {
    docs {
        groovydoc {
            links = [] as Set
            options {
                link 'http://docs.groovy-lang.org/3.0.3/html/api/', 'groovy.', 'org.codehaus.groovy.', 'org.apache.groovy.'
            }
        }
    }
}

@dmurat
Copy link
Author

dmurat commented May 10, 2020

It does not work for me. If I set links on groovydoc, Gradle compilation fails. If I move it under options Gradle compilation passes, but links still point to the 2.5.6 version.

@aalmiray
Copy link
Collaborator

Yes, sorry, setting the links property should be in options, my mistake. However, default links from the parent will override your settings. I added a fix for overriding links by URL.

Unfortunately there's no option in 0.36.0 that will let you remove the default link to Groovy 2.5.6.

@dmurat
Copy link
Author

dmurat commented May 10, 2020

Thank you. No problem, I can wait for 0.37.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants