Skip to content

Commit 75898bc

Browse files
committed
Javadoc: Add missing @param
1 parent be60e48 commit 75898bc

22 files changed

+41
-27
lines changed

src/main/java/org/apache/commons/io/file/PathFilter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public interface PathFilter {
3333
* Tests whether or not to include the specified Path in a result.
3434
*
3535
* @param path The Path to test.
36-
* @param attributes the file's basic attributes (TODO may be null).
36+
* @param attributes the path's basic attributes (may be null).
3737
* @return a FileVisitResult
3838
*/
3939
FileVisitResult accept(Path path, BasicFileAttributes attributes);

src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,9 @@ public boolean accept(final File file) {
193193
* If last modification time equals cutoff and newer files are required, file <b>IS NOT</b> selected. If last
194194
* modification time equals cutoff and older files are required, file <b>IS</b> selected.
195195
* </p>
196-
* @param file the File to check
197196
*
197+
* @param file the File to check
198+
* @param attributes the path's basic attributes (may be null).
198199
* @return true if the file name matches
199200
* @since 2.9.0
200201
*/

src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ public boolean accept(final File file) {
8787

8888
/**
8989
* Checks to see if the file can be executed.
90-
* @param file the File to check.
9190
*
91+
* @param file the File to check.
92+
* @param attributes the path's basic attributes (may be null).
9293
* @return {@code true} if the file can be executed, otherwise {@code false}.
9394
* @since 2.9.0
9495
*/

src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@ public boolean accept(final File file) {
9797

9898
/**
9999
* Checks to see if the file can be read.
100-
* @param file the File to check.
101100
*
101+
* @param file the File to check.
102+
* @param attributes the path's basic attributes (may be null).
102103
* @return {@code true} if the file can be read, otherwise {@code false}.
103104
* @since 2.9.0
104105
*/

src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,9 @@ public boolean accept(final File file) {
8585

8686
/**
8787
* Checks to see if the file can be written to.
88-
* @param file the File to check
8988
*
89+
* @param file the File to check
90+
* @param attributes the path's basic attributes (may be null).
9091
* @return {@code true} if the file can be written to, otherwise {@code false}.
9192
* @since 2.9.0
9293
*/

src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,9 @@ public boolean accept(final File file) {
102102

103103
/**
104104
* Checks to see if the file is a directory.
105-
* @param file the File to check
106105
*
106+
* @param file the File to check
107+
* @param attributes the path's basic attributes (may be null).
107108
* @return true if the file is a directory
108109
* @since 2.9.0
109110
*/

src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ public boolean accept(final File file) {
116116

117117
/**
118118
* Checks to see if the file is empty.
119-
* @param file the file or directory to check
120119
*
120+
* @param file the file or directory to check
121+
* @param attributes the path's basic attributes (may be null).
121122
* @return {@code true} if the file or directory is <em>empty</em>, otherwise {@code false}.
122123
* @since 2.9.0
123124
*/

src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public boolean accept(final File dir, final String name) {
8484
* Returns false.
8585
*
8686
* @param file the file to check (ignored)
87-
*
87+
* @param attributes the path's basic attributes (may be null).
8888
* @return false
8989
* @since 2.9.0
9090
*/

src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,9 @@ public boolean accept(final File file) {
102102

103103
/**
104104
* Checks to see if the file is a file.
105-
* @param file the File to check
106105
*
106+
* @param file the File to check
107+
* @param attributes the path's basic attributes (may be null).
107108
* @return true if the file is a file
108109
* @since 2.9.0
109110
*/

src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ public boolean accept(final File file) {
106106

107107
/**
108108
* Checks to see if the file is hidden.
109-
* @param file the File to check
110109
*
111-
* @return {@code true} if the file is
112-
* <em>hidden</em>, otherwise {@code false}.
110+
* @param file the File to check
111+
* @param attributes the path's basic attributes (may be null).
112+
* @return {@code true} if the file is <em>hidden</em>, otherwise {@code false}.
113113
* @since 2.9.0
114114
*/
115115
@Override

0 commit comments

Comments
 (0)