wilx opened a new pull request, #299:
URL: https://github.com/apache/maven-dependency-analyzer/pull/299
## Summary
Add concise documentation for the public APIs reported by Javadoc.
The reporting build emitted 19 warnings for missing comments, parameters,
return values, and an exception. This change supplies only the missing
documentation and does not alter runtime behavior.
## Verification
- `mvn -B -V spotless:apply`
- `mvn -B -V clean verify site` with JDK 17: 131 tests passed
- `mvn -B -V -DskipTests -P reporting compile site site:stage` with JDK 17:
passed with no Javadoc warnings
- `mvn -B -V spotless:check`
Following this checklist to help us incorporate your
contribution quickly and easily:
- [x] Your pull request should address just one issue, without pulling in
other changes.
- [x] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- [x] Each commit in the pull request should have a meaningful subject line
and body.
Note that commits might be squashed by a maintainer on merge.
- [ ] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied.
This change has no runtime behavior.
- [x] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
- [ ] You have run the integration tests successfully (`mvn -Prun-its
verify`).
Integration tests were not run because this change only adds Javadocs.
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [x] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
--
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]
