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

Update and improve documentation #1022

Open
kriegaex opened this issue Jan 25, 2024 · 0 comments
Open

Update and improve documentation #1022

kriegaex opened this issue Jan 25, 2024 · 0 comments

Comments

@kriegaex
Copy link

kriegaex commented Jan 25, 2024

Reading https://stackoverflow.com/q/77869970/1082681, it seems as if users are struggling with plugin configuration. The documentation says next to nothing about it and definitely does not resemble the (example projects](https://github.com/freefair/gradle-plugins/tree/main/examples/aspectj), such as this one:

apply plugin: "io.freefair.aspectj"
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
targetCompatibility = "11"
}
dependencies {
implementation "org.aspectj:aspectjrt:1.9.21"
}
compileAspectj {
ajcOptions {
outxml = true
outxmlfile = "bar.xml"
}
}
compileAspectj.ajcOptions.outxml = true
compileAspectj.ajcOptions.outxmlfile = "bar.xml"

Instead, the manual seems to suggest using something like this:

task myAjcTask(type: io.freefair.gradle.plugins.aspectj.AspectjCompile) {
    aspectjClasspath.setFrom configurations.aspectj
    ajcOptions {
        inpath = files()
        aspectpath = files()
    }
}

Instead of having to answer user questions like the one on Stack Overflow, this one or #53, maybe it would be better to be a bit less terse in the documentation. It would be a one-time effort to improve it for the mutual benefit of yourself (less support work) and your users.

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

No branches or pull requests

1 participant