-
Notifications
You must be signed in to change notification settings - Fork 5
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 gradle task java11doc to task java17doc (and add to CI) #8
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should not work in a CI build, because JavaDoc is generated into a sibling project. Actually, automatic publishing of the JavaDoc works differently in all my projects. I've never seen the point in porting it to this one (too few changes). But I might do it anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intention was not to finally publish the JavaDoc/global homepage/..., but provide checks that the task works.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please don't rename the task. The "big change" was from Java 8 to Java 11 (including the new layout). While java11doc is certainly not the best of names (and plain "javadoc" is taken by gradle), changing this with every LTS version is not helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mdoclet requires Java 17, therefore this taglet must be Java 17 at least. To avoid confusion, I also changed 11 to 17 in the task.
I can undo that but comment to the task that 11 is not supported, but the name is kept for reasons mentioned in this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm aware of the problem with using "java11doc". It is confusing. But so would "java17doc" be in a few years.
I was hesitant about "javadocNG" when I initially wrote this ("NG" already being out of fashion), but maybe you have a good idea for a task name without version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since overview.md
is also generated, I opted for the very short "docs".
Part of #6
17
in the task name and the links to the JavaDoc