svn commit: r680522 - in /tapestry/tapestry5/trunk/tapestry-ioc/src: main/java/org/apache/tapestry5/ioc/Invocation.java main/java/org/apache/tapestry5/ioc/MethodAdvice.java site/apt/decorator.apt

[hl...@apache.org]

Author: hlship
Date: Mon Jul 28 15:01:36 2008
New Revision: 680522

URL: http://svn.apache.org/viewvc?rev=680522&view=rev
Log:
Fix a few typos in the MethodAdvice and Invocation documentation.

Modified:
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/Invocation.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/MethodAdvice.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/decorator.apt

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/Invocation.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/Invocation.java?rev=680522&r1=680521&r2=680522&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/Invocation.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/Invocation.java Mon Jul 28 15:01:36 2008
@@ -15,7 +15,7 @@
 package org.apache.tapestry5.ioc;
 
 /**
- * A method invocation passed to an {@link org.apache.tapestry5.ioc.MethodAdvice}.
+ * A method invocation passed to a {@link org.apache.tapestry5.ioc.MethodAdvice}.
  */
 public interface Invocation
 {
@@ -54,7 +54,8 @@
     void override(int index, Object newParameter);
 
     /**
-     * Processed with the invocation.  If the invocation results in a <em>runtime</em> exception, that is thrown.
+     * Proceed with the invocation of the advised method.  If the invocation results in a <em>runtime</em> exception,
+     * that is thrown. A checked exception is detected by invoking {@link #isFail()}.
      */
     void proceed();
 
@@ -69,7 +70,7 @@
      *
      * @param throwableClass the type of exception to match
      * @return the exception, if the proceeded invocation threw a checked exception, and the exception is assignable to
-     *         the provided type.
+     *         the provided type.  In other cases, null is returned.
      */
     <T extends Throwable> T getThrown(Class<T> throwableClass);
 

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/MethodAdvice.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/MethodAdvice.java?rev=680522&r1=680521&r2=680522&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/MethodAdvice.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/MethodAdvice.java Mon Jul 28 15:01:36 2008
@@ -17,7 +17,7 @@
 /**
  * For Tapestry IoC, Aspects provide a limited amount of advise, i.e., advising method invocations. That's the only join
  * point available (method invocations of service interface methods); full AOP systems such as AspectJ can do much, much
- * such as advising field access and even object construction.
+ * more, such as advising field access and even object construction.
  *
  * @see org.apache.tapestry5.ioc.services.AspectDecorator
  */

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/decorator.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/decorator.apt?rev=680522&r1=680521&r2=680522&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/decorator.apt (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/decorator.apt Mon Jul 28 15:01:36 2008
@@ -232,13 +232,13 @@
   In the normal success case, you can ask for the return value and even override it before
   returning from the advise() method.
 
-  In other words, you have total control.  Your MethodAdvise can query or change parameters, decide whether
+  In other words, you have total control.  Your MethodAdvice can query or change parameters, decide whether
   it proceed into the original code, it can intercept exceptions that are thrown and replace them, and can
   query or even replace the return value.
 
   The
   {{{../apidocs/org/apache/tapestry5/ioc/services/AspectDecorator.html}AspectDecorator}} service
-  is how you put your MethodAdvise into action.
+  is how you put your MethodAdvice into action.
 
   By way of an example, we'll show an implementation of the LoggingDecorator service: