svn commit: r1563233 - in /commons/proper/io/trunk/src/main/java/org/apache/commons/io: FileCleaner.java FileCleaningTracker.java

[gg...@apache.org]

Author: ggregory
Date: Fri Jan 31 19:58:50 2014
New Revision: 1563233

URL: http://svn.apache.org/r1563233
Log:
[IO-424] Javadoc fixes, mostly to appease 1.8.0. Attempt to appease Javadoc 1.8.0 but getting "[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli) on project commons-io: An error has occurred in JavaDocs report generation:
[ERROR] Exit code: 1 - javadoc: warning - Error fetching URL: http://download.oracle.com/javase/6/docs/api
[ERROR] javadoc: warning - Error fetching URL: http://download.oracle.com/javaee/6/api"

Modified:
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java?rev=1563233&r1=1563232&r2=1563233&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java Fri Jan 31 19:58:50 2014
@@ -30,7 +30,7 @@ import java.io.File;
  * example), you should consider stopping the background thread if it is no
  * longer needed. This is done by invoking the method
  * {@link #exitWhenFinished}, typically in
- * {@link javax.servlet.ServletContextListener#contextDestroyed} or similar.
+ * {@link javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)} or similar.
  *
  * @version $Id$
  * @deprecated Use {@link FileCleaningTracker}
@@ -136,7 +136,8 @@ public class FileCleaner {
      * posing a memory leak.
      * <p>
      * This method allows the thread to be terminated. Simply call this method
-     * in the resource cleanup code, such as {@link javax.servlet.ServletContextListener#contextDestroyed}.
+     * in the resource cleanup code, such as 
+     * {@link javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
      * One called, no new objects can be tracked by the file cleaner.
      * @deprecated Use {@link FileCleaningTracker#exitWhenFinished()}.
      */

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java?rev=1563233&r1=1563232&r2=1563233&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java Fri Jan 31 19:58:50 2014
@@ -182,7 +182,8 @@ public class FileCleaningTracker {
      * posing a memory leak.
      * <p>
      * This method allows the thread to be terminated. Simply call this method
-     * in the resource cleanup code, such as {@link javax.servlet.ServletContextListener#contextDestroyed}.
+     * in the resource cleanup code, such as 
+     * {@link javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
      * Once called, no new objects can be tracked by the file cleaner.
      */
     public synchronized void exitWhenFinished() {