svn commit: r1363969 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java

[gg...@apache.org]

Author: ggregory
Date: Fri Jul 20 22:08:13 2012
New Revision: 1363969

URL: http://svn.apache.org/viewvc?rev=1363969&view=rev
Log:
Javadoc: Use the active voice.

Modified:
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java?rev=1363969&r1=1363968&r2=1363969&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FilesCache.java Fri Jul 20 22:08:13 2012
@@ -23,14 +23,14 @@ package org.apache.commons.vfs2;
 public interface FilesCache
 {
     /**
-     * add a fileobject to the cache.
+     * Adds a FileObject to the cache.
      *
      * @param file the file
      */
     void putFile(final FileObject file);
 
     /**
-     * add a fileobject to the cache if it isn't already present.
+     * Add a FileObject to the cache if it isn't already present.
      *
      * @param file the file
      * @return true if the file was stored, false otherwise.
@@ -38,7 +38,7 @@ public interface FilesCache
     boolean putFileIfAbsent(final FileObject file);
 
     /**
-     * retrieve a file from the cache by its name.
+     * Retrieve a FileObject from the cache by name.
      *
      * @param filesystem The FileSystem.
      * @param name the name
@@ -47,18 +47,18 @@ public interface FilesCache
     FileObject getFile(final FileSystem filesystem, final FileName name);
 
     /**
-     * purge the entries corresponding to the filesystem.
-     * @param filesystem The FileSystem.
+     * Purges the entries corresponding to the FileSystem.
+     * @param fileSystem The FileSystem.
      */
-    void clear(final FileSystem filesystem);
+    void clear(final FileSystem fileSystem);
 
     /**
-     * purge the whole cache.
+     * Purges the whole cache.
      */
     void close();
 
     /**
-     * removes a file from cache.
+     * Removes a file from cache.
      *
      * @param filesystem filesystem
      * @param name       filename
@@ -66,7 +66,7 @@ public interface FilesCache
     void removeFile(final FileSystem filesystem, final FileName name);
 
     /**
-     * if the cache uses timestamps it could use this method to handle
+     * If the cache uses timestamps it could use this method to handle
      * updates of them.
      *
      * @param file filename