DonalEvans opened a new pull request, #7594:
URL: https://github.com/apache/geode/pull/7594
This PR is intentionally broken up into two commits.
The first commit reduces the number of errors reported in the gradle
build log due to javadocs from over 3000 to 0. It also reduces the
number of warnings reported in the gradle build log due to javadocs
from over 3000 to 0.
After these changes, all published javadocs are now syntactically
correct, although no guarantee is made as to the content of the
documentation. Javadocs in classes that do not produce errors or
warnings in the gradle build log were not touched.
The changes made were:
- Add missing @return, @param and @throws tags
- Fix all errors due to incorrect HTML tag formatting
- Fix all errors due to improperly escaped characters
- Fix all broken @link tags
- Several minor spelling errors and typos fixed where spotted
The first commit comprises 546 files changed, 8498 insertions, and
3648 deletions, and as such, is not realistically reviewable. Given the
benefits of the clean-up and the low impact of any possible mistakes,
a "rubber-stamp" approval is requested form code owners in this case.
In the second commit, javadocs warnings and errors will be output in
the gradle build log, and if any are present, the build will fail.
This will enable developers to know if they have broken existing
javadocs, or if any javadocs they have added are incorrect.
<!-- Thank you for submitting a contribution to Apache Geode. -->
<!-- In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
-->
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced in
the commit message?
- [ ] Has your PR been rebased against the latest commit within the target
branch (typically `develop`)?
- [ ] Is your initial contribution a single, squashed commit?
- [ ] Does `gradlew build` run cleanly?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
<!-- Note:
Please ensure that once the PR is submitted, check Concourse for build
issues and
submit an update to your PR as soon as possible. If you need help, please
send an
email to [email protected].
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
