Skip to content

[IO-808] more precise Javadoc about when an IllegalArgumentException is thrown#581

Merged
garydgregory merged 6 commits into
apache:masterfrom
elharo:IO-808
Feb 7, 2024
Merged

[IO-808] more precise Javadoc about when an IllegalArgumentException is thrown#581
garydgregory merged 6 commits into
apache:masterfrom
elharo:IO-808

Conversation

@elharo

@elharo elharo commented Feb 7, 2024

Copy link
Copy Markdown
Contributor

Clarify the circumstances under which an IllegalArgumentException is currently thrown. I think these are all the cases where IO-808 proposes using IOExceptions instead. This is an intermediate step that merely documents what the code currently does. Some of these should be changed. @garydgregory @sebbASF

@garydgregory

Copy link
Copy Markdown
Member

Hello @elharo
Please link to Jira URLs for convenience.

@garydgregory

Copy link
Copy Markdown
Member

@elharo
There are lots of build errors where it looks like you mixed up @link for @code:

...
Error:  /home/runner/work/commons-io/commons-io/src/main/java/org/apache/commons/io/FileUtils.java:2442: error: reference not found
Error:       * @throws IllegalArgumentException if {@link srcFile} is a directory
Error:                                                    ^
...

Run mvn by itself before you push to avoid build errors.

@rho66

rho66 commented Feb 7, 2024

Copy link
Copy Markdown

see IO-778 were also IllegalArgumentException is thrown but not documented in Javadoc.

@elharo elharo marked this pull request as ready for review February 7, 2024 14:29
@garydgregory garydgregory changed the title [IO-808] more precise JavaDoc about when an IllegalArgumentException is thrown [IO-808] more precise Javadoc about when an IllegalArgumentException is thrown Feb 7, 2024
@garydgregory garydgregory merged commit 80474fe into apache:master Feb 7, 2024
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.

3 participants