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
build(gradle): javadoc enhance + namings migration #473
build(gradle): javadoc enhance + namings migration #473
Conversation
i have adding some code block in those point
`base.archivesName` is a `Property<String>`. package names have been unchanged
removes directory while activating task `aggregateJavadoc` clone `element-list` to `package-list` in the same directory adding links - points to specific class documentation. (some of them doesn't have a `package-list` file attached into index of javadoc)
i get the following 2 errors when running aggregateJavadoc, javadoc works fine. It seems like aggregateJavadoc is more strict on validation.
I think we need to replace the h3 with h2 in both html templates and add a |
- paragraph moved to caption table - img is self-closed in html5 - fix sponsor heading - replace heading in overview-single.html
got made some tweaks in requested files |
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 made a few more changes - the name of one module was wrong and i simplified the templates a little because they took up to much space - i think a few useful links are enough, most information should be in the documentation.
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.
One last take before we getting into it.
Co-authored-by: Damian Staszewski <359222+stachu540@users.noreply.github.com>
Co-authored-by: Damian Staszewski <359222+stachu540@users.noreply.github.com>
LGTM Looks like we can push this one. |
Prerequisites for Code Changes
Changes Proposed
aggregateJavadoc
task behavior changeselement-list
aspackage-list
in the same directorypackage-list
file attached into index of javadoc)en
localization - no matter which localization is on your PCartifactId
frombuildSrc
settings.gradle.kts
Additional Information
This is proposal changes to javadoc, which adds Groups into specific packages, changes to javadoc aggregation and adding some links to the other javadoc documentation. Got adding some improvments with Javadoc Overview, constant localization and module names migrated to
settings.gradle.kts
. Each changes are tested. Only left is some typings, some improvments and it is ready to review.