Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java

@@ -357,7 +357,8 @@ private void doDelete(final FileEntry entry) {
     }
 
     /**
-     * Lists the files
+     * Lists the files in {@code file}.
+     *
      * @param file The file to list files for
      * @param entry the parent entry
      * @return The child files
@@ -429,14 +430,14 @@ public void initialize() throws Exception {
     /**
      * Lists the contents of a directory
      *
-     * @param file The file to list the contents of
+     * @param directory The directory to list.
      * @return the directory contents or a zero length array if
      * the empty or the file is not a directory
      */
-    private File[] listFiles(final File file) {
+    private File[] listFiles(final File directory) {
         File[] children = null;
-        if (file.isDirectory()) {
-            children = file.listFiles(fileFilter);
+        if (directory.isDirectory()) {
+            children = directory.listFiles(fileFilter);
         }
         if (children == null) {
             children = FileUtils.EMPTY_FILE_ARRAY;

src/main/java/org/apache/commons/io/monitor/FileEntry.java

@@ -57,13 +57,28 @@ public class FileEntry implements Serializable {
 
     static final FileEntry[] EMPTY_FILE_ENTRY_ARRAY = {};
 
+    /** The parent. */
     private final FileEntry parent;
+
+    /** My children. */
     private FileEntry[] children;
+
+    /** Monitored file. */
     private final File file;
+
+    /** Monitored file name. */
     private String name;
+
+    /** Whether the file exists. */
     private boolean exists;
+
+    /** Whether the file is a directory or not. */
     private boolean directory;
+
+    /** The file's last modified timestamp. */
     private SerializableFileTime lastModified = SerializableFileTime.EPOCH;
+
+    /** The file's length. */
     private long length;
 
     /**
@@ -78,8 +93,8 @@ public FileEntry(final File file) {
     /**
      * Constructs a new monitor for a specified {@link File}.
      *
-     * @param parent The parent
-     * @param file The file being monitored
+     * @param parent The parent.
+     * @param file The file being monitored.
      */
     public FileEntry(final FileEntry parent, final File file) {
         this.file = Objects.requireNonNull(file, "file");

src/main/java/org/apache/commons/io/output/StringBuilderWriter.java

@@ -37,6 +37,8 @@
 public class StringBuilderWriter extends Writer implements Serializable {
 
     private static final long serialVersionUID = -146927496096066153L;
+    
+    /** The append target. */
     private final StringBuilder builder;
 
     /**