Skip to content

Commit 4b5fa7d

Browse files
committed
IO-531 - Improve Javadoc for FileUtils.listFiles
This fixes #33
1 parent 8b9fe1b commit 4b5fa7d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/main/java/org/apache/commons/io/FileUtils.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -503,10 +503,11 @@ private static void innerListFiles(final Collection<File> files, final File dire
503503
* in <code>FileFilterUtils.makeCVSAware(null)</code>.
504504
*
505505
* @param directory the directory to search in
506-
* @param fileFilter filter to apply when finding files.
506+
* @param fileFilter filter to apply when finding files. Must not be {@code null},
507+
* use {@link TrueFileFilter.INSTANCE} to match all files in selected directories.
507508
* @param dirFilter optional filter to apply when finding subdirectories.
508509
* If this parameter is {@code null}, subdirectories will not be included in the
509-
* search. Use TrueFileFilter.INSTANCE to match all directories.
510+
* search. Use {@link TrueFileFilter.INSTANCE} to match all directories.
510511
* @return a collection of java.io.File with the matching files
511512
* @see org.apache.commons.io.filefilter.FileFilterUtils
512513
* @see org.apache.commons.io.filefilter.NameFileFilter

0 commit comments

Comments
 (0)