svn commit: r1087483 - /tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java

[hl...@apache.org]

Author: hlship
Date: Thu Mar 31 23:15:18 2011
New Revision: 1087483

URL: http://svn.apache.org/viewvc?rev=1087483&view=rev
Log:
TAP5-73: Improve documentation of IOOperation

Modified:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java?rev=1087483&r1=1087482&r2=1087483&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/IOOperation.java Thu Mar 31 23:15:18 2011
@@ -17,11 +17,18 @@ package org.apache.tapestry5.internal;
 import java.io.IOException;
 
 /**
- * An operation that may throw an IOException.
+ * This interface is similar to {@link Runnable}, except that
+ * the operation may throw an {@link IOException}.
  * 
- * @asince 5.3.0
+ * @since 5.3.0
+ * @see TapestryInternalUtils#performIO(org.apache.tapestry5.ioc.OperationTracker, String, IOOperation)
  */
 public interface IOOperation
 {
+    /**
+     * Perform some work.
+     * 
+     * @throws IOException
+     */
     void perform() throws IOException;
 }