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

Rename aggregateJavadocClasspath to align with Gradle conventions #9

Open
wilkinsona opened this issue Apr 28, 2020 · 2 comments
Open
Labels
in: aggregate-javadoc In the AggregateJavadocPlugin type: enhancement A general enhancement

Comments

@wilkinsona
Copy link

wilkinsona commented Apr 28, 2020

Gradle seems to have a convention where a configuration with a name that ends with Classpath is "for consumption by tasks, not for you to declare dependencies". This is the case for compileClasspath, runtimeClasspath, testCompileClasspath, and testRuntimeClasspath. To align with this apparent convention, aggregateJavadocClasspath should perhaps be differently named as it is used for declaring dependencies.

@rwinch
Copy link
Contributor

rwinch commented Apr 28, 2020

What name would you suggest? I'm not a fan of the suggestion of aggregatedJavadoc as the difference is too subtle between the task name and the configuration. It is also not very clear what this is.

Gradle seems to have a convention where a configuration with a name that ends with Classpath is "for consumption by tasks, not for you to declare dependencies".

I didn't come to the same conclusion. Another observation is that the tasks that end in Classpath are used to configure a task's classpath attribute. For example, compileClasspath is used to configure the classpath attribute of the compileJava task. In the same way, aggregateJavadocClasspath is used to configure the classpath attribute of the aggregateJavadoc task. I think the difference is that Javadoc is not quite so complex, so it doesn't need a more complex hierarchy of Configurations like compiling Java code.

@wilkinsona
Copy link
Author

What name would you suggest?

😬 I'm struggling to think of one. I wasn't a huge fan of aggregatedJavadoc when it wrote it, which probably contributed to the thought about avoiding a naming clash or near clash with the task's name. I'll give it some more thought and see if anything occurs to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: aggregate-javadoc In the AggregateJavadocPlugin type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

2 participants