Skip to content

Add missing javadoc for exceptions thrown for invalid arguments#339

Merged
garydgregory merged 1 commit into
apache:masterfrom
dvmarcilio:exception_javadocs
Mar 28, 2022
Merged

Add missing javadoc for exceptions thrown for invalid arguments#339
garydgregory merged 1 commit into
apache:masterfrom
dvmarcilio:exception_javadocs

Conversation

@dvmarcilio

Copy link
Copy Markdown
Contributor

Hello! I added some missing javadoc for NullPointerException and IllegalArgumentException in some Util classes.
I added test assertions only when tests already existed for a method.

For PathUtils.filter(PathFilter, Path... ) the doc was actually inconsistent: mentioning IAE instead of NPE.

Thanks for taking the time to review.

* @throws IOException if setting the last-modified time failed.
* @throws NullPointerException if the parameter is {@code null}
* @throws IOException if an I/O problem occurs.
* @throws IOException if setting the last-modified time failed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Listing each exception type once is enough IMO.

@dvmarcilio dvmarcilio Mar 28, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing @garydgregory. I force pushed a new version merging the two descriptions for IOException in the same line. Does that work?

@garydgregory garydgregory merged commit f343ad1 into apache:master Mar 28, 2022
garydgregory added a commit that referenced this pull request Mar 28, 2022
garydgregory added a commit that referenced this pull request Jan 29, 2025
Remove -nouses directive from maven-bundle-plugin. OSGi package imports
now state 'uses' definitions for package imports, this doesn't affect
JPMS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants