Skip to content

Commit cffe620

Browse files
committed
Javadoc: Some methods were not using the active voices (e.g. "Moves..." instead of "Move...") in the first sentence of the Javadoc.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@610485 13f79535-47bb-0310-9956-ffa450edef68
1 parent ded863b commit cffe620

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ public static Iterator iterateFiles(
398398

399399
//-----------------------------------------------------------------------
400400
/**
401-
* Compare the contents of two files to determine if they are equal or not.
401+
* Compares the contents of two files to determine if they are equal or not.
402402
* <p>
403403
* This method checks to see if the two files are different lengths
404404
* or if they point to the same file, before resorting to byte-by-byte
@@ -771,7 +771,7 @@ public static void copyDirectory(File srcDir, File destDir,
771771
}
772772

773773
/**
774-
* Filtered Copy of a directory to a new location preserving the file dates.
774+
* Copies a filtered directory to a new location preserving the file dates.
775775
* <p>
776776
* This method copies the contents of the specified source directory
777777
* to within the specified destination directory.
@@ -815,7 +815,7 @@ public static void copyDirectory(File srcDir, File destDir,
815815
}
816816

817817
/**
818-
* Filtered Copy of a directory to a new location.
818+
* Copies a filtered directory to a new location.
819819
* <p>
820820
* This method copies the contents of the specified source directory
821821
* to within the specified destination directory.
@@ -964,7 +964,7 @@ public static void copyURLToFile(URL source, File destination) throws IOExceptio
964964

965965
//-----------------------------------------------------------------------
966966
/**
967-
* Recursively delete a directory.
967+
* Deletes a directory recursively.
968968
*
969969
* @param directory directory to delete
970970
* @throws IOException in case deletion is unsuccessful
@@ -983,12 +983,12 @@ public static void deleteDirectory(File directory) throws IOException {
983983
}
984984

985985
/**
986-
* Delete a file. If file is a directory, delete it and all sub-directories.
986+
* Deletes a file, never throwing an exception. If file is a directory, delete it and all sub-directories.
987987
* <p>
988988
* The difference between File.delete() and this method are:
989989
* <ul>
990990
* <li>A directory to be deleted does not have to be empty.</li>
991-
* <li>No exceptions are thrown when a file or directory cannot be deleted.
991+
* <li>No exceptions are thrown when a file or directory cannot be deleted.</li>
992992
* </ul>
993993
*
994994
* @param file file or directory to delete, can be <code>null</code>
@@ -1016,7 +1016,7 @@ public static boolean deleteQuietly(File file) {
10161016
}
10171017

10181018
/**
1019-
* Clean a directory without deleting it.
1019+
* Cleans a directory without deleting it.
10201020
*
10211021
* @param directory directory to clean
10221022
* @throws IOException in case cleaning is unsuccessful
@@ -1174,7 +1174,7 @@ public static List readLines(File file) throws IOException {
11741174
}
11751175

11761176
/**
1177-
* Return an Iterator for the lines in a <code>File</code>.
1177+
* Returns an Iterator for the lines in a <code>File</code>.
11781178
* <p>
11791179
* This method opens an <code>InputStream</code> for the file.
11801180
* When you have finished with the iterator you should close the stream
@@ -1219,7 +1219,7 @@ public static LineIterator lineIterator(File file, String encoding) throws IOExc
12191219
}
12201220

12211221
/**
1222-
* Return an Iterator for the lines in a <code>File</code> using the default encoding for the VM.
1222+
* Returns an Iterator for the lines in a <code>File</code> using the default encoding for the VM.
12231223
*
12241224
* @param file the file to open for input, must not be <code>null</code>
12251225
* @return an Iterator of the lines in the file, never <code>null</code>
@@ -1362,7 +1362,7 @@ public static void writeLines(File file, Collection lines, String lineEnding) th
13621362

13631363
//-----------------------------------------------------------------------
13641364
/**
1365-
* Delete a file. If file is a directory, delete it and all sub-directories.
1365+
* Deletes a file. If file is a directory, delete it and all sub-directories.
13661366
* <p>
13671367
* The difference between File.delete() and this method are:
13681368
* <ul>
@@ -1393,7 +1393,7 @@ public static void forceDelete(File file) throws IOException {
13931393
}
13941394

13951395
/**
1396-
* Schedule a file to be deleted when JVM exits.
1396+
* Schedules a file to be deleted when JVM exits.
13971397
* If file is directory delete it and all sub-directories.
13981398
*
13991399
* @param file file or directory to delete, must not be <code>null</code>
@@ -1409,7 +1409,7 @@ public static void forceDeleteOnExit(File file) throws IOException {
14091409
}
14101410

14111411
/**
1412-
* Recursively schedule directory for deletion on JVM exit.
1412+
* Schedules a directory recursively for deletion on JVM exit.
14131413
*
14141414
* @param directory directory to delete, must not be <code>null</code>
14151415
* @throws NullPointerException if the directory is <code>null</code>
@@ -1425,7 +1425,7 @@ private static void deleteDirectoryOnExit(File directory) throws IOException {
14251425
}
14261426

14271427
/**
1428-
* Clean a directory without deleting it.
1428+
* Cleans a directory without deleting it.
14291429
*
14301430
* @param directory directory to clean, must not be <code>null</code>
14311431
* @throws NullPointerException if the directory is <code>null</code>
@@ -1463,7 +1463,7 @@ private static void cleanDirectoryOnExit(File directory) throws IOException {
14631463
}
14641464

14651465
/**
1466-
* Make a directory, including any necessary but nonexistent parent
1466+
* Makes a directory, including any necessary but nonexistent parent
14671467
* directories. If there already exists a file with specified name or
14681468
* the directory cannot be created then an exception is thrown.
14691469
*
@@ -1492,7 +1492,7 @@ public static void forceMkdir(File directory) throws IOException {
14921492

14931493
//-----------------------------------------------------------------------
14941494
/**
1495-
* Recursively count size of a directory (sum of the length of all files).
1495+
* Counts the size of a directory recursively (sum of the length of all files).
14961496
*
14971497
* @param directory directory to inspect, must not be <code>null</code>
14981498
* @return size of directory in bytes, 0 if directory is security restricted
@@ -1711,7 +1711,7 @@ public static Checksum checksum(File file, Checksum checksum) throws IOException
17111711
}
17121712

17131713
/**
1714-
* Move a directory.
1714+
* Moves a directory.
17151715
* <p>
17161716
* When the destination directory is on another file system, do a "copy and delete".
17171717
*
@@ -1750,7 +1750,7 @@ public static void moveDirectory(File srcDir, File destDir) throws IOException {
17501750
}
17511751

17521752
/**
1753-
* Move a directory to a directory.
1753+
* Moves a directory to another directory.
17541754
*
17551755
* @param src the file to be moved
17561756
* @param destDir the destination file
@@ -1783,7 +1783,7 @@ public static void moveDirectoryToDirectory(File src, File destDir, boolean crea
17831783
}
17841784

17851785
/**
1786-
* Move a file.
1786+
* Moves a file.
17871787
* <p>
17881788
* When the destination file is on another file system, do a "copy and delete".
17891789
*
@@ -1825,7 +1825,7 @@ public static void moveFile(File srcFile, File destFile) throws IOException {
18251825
}
18261826

18271827
/**
1828-
* Move a file to a directory.
1828+
* Moves a file to a directory.
18291829
*
18301830
* @param srcFile the file to be moved
18311831
* @param destDir the destination file
@@ -1857,7 +1857,7 @@ public static void moveFileToDirectory(File srcFile, File destDir, boolean creat
18571857
}
18581858

18591859
/**
1860-
* Move a file or directory to the destination directory.
1860+
* Moves a file or directory to the destination directory.
18611861
* <p>
18621862
* When the destination is on another file system, do a "copy and delete".
18631863
*

0 commit comments

Comments
 (0)