You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2012/01/05 19:52:00 UTC

svn commit: r1227747 - in /tapestry/tapestry5/trunk: tapestry-core/src/main/java/org/apache/tapestry5/ tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ tapestry-core/src/main/java/org/apache/tapestry5/services/ tapestry-test/src/main...

Author: hlship
Date: Thu Jan  5 18:51:59 2012
New Revision: 1227747

URL: http://svn.apache.org/viewvc?rev=1227747&view=rev
Log:
Correct some JavaDoc warnings

Modified:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/TapestryMarkers.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentResourcesOperation.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventHandler.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java
    tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
    tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/TapestryTestConfiguration.java
    tapestry/tapestry5/trunk/tapestry5-annotations/src/main/java/org/apache/tapestry5/ioc/annotations/InjectResource.java

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/TapestryMarkers.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/TapestryMarkers.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/TapestryMarkers.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/TapestryMarkers.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-//  Copyright 2008 The Apache Software Foundation
+//  Copyright 2008, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -31,9 +31,10 @@ public class TapestryMarkers
     public static final Marker TAPESTRY = MarkerFactory.getMarker("TAPESTRY");
 
     /**
-     * Logs the final version of the class transformation. This is useful when debugging {@link
-     * org.apache.tapestry5.services.ComponentClassTransformWorker}s, as it shows exactly what transformation operations
-     * occured, at the Java code level.
+     * Logs the final version of the class transformation. This is useful when debugging {@linkplain
+     * org.apache.tapestry5.services.transform.ComponentClassTransformWorker2 component class transformers},
+     * as it shows exactly what transformation operations
+     * occurred, at the Java code level.
      */
     public static final Marker CLASS_TRANSFORMATION = MarkerFactory.getMarker("CLASS_TRANSFORMATION");
 

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentResourcesOperation.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentResourcesOperation.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentResourcesOperation.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ComponentResourcesOperation.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-// Copyright 2007 The Apache Software Foundation
+// Copyright 2007, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,10 +19,11 @@ import org.apache.tapestry5.ComponentRes
 /**
  * A kind of callback that can easily be injected into a transformed class to perform complex work.
  * <p/>
- * These callbacks are often injected into a transformed component class via {@link
- * org.apache.tapestry5.services.ClassTransformation#addInjectedField(Class, String, Object)}. Bear in mind that such
+ * These callbacks are often injected into a transformed component class. Bear in mind that such
  * callbacks must be <em>threadsafe</em>, since every instance of such a class will share a single instance of the
  * operation.
+ *
+ * @deprecated In Tapestry 5.4; use {@link org.apache.tapestry5.plastic.MethodAdvice} and other parts of the new (in 5.3) plastic library.
  */
 public interface ComponentResourcesOperation
 {

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventHandler.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventHandler.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventHandler.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventHandler.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-// Copyright 2010, 2011 The Apache Software Foundation
+// Copyright 2010, 2011, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -18,8 +18,7 @@ import org.apache.tapestry5.runtime.Comp
 import org.apache.tapestry5.runtime.ComponentEvent;
 
 /**
- * Interface used with  {@link org.apache.tapestry5.services.transform.TransformationSupport#addEventHandler(String, int, String, ComponentEventHandler)}} (and, in the old
- * API, {@link ClassTransformation#addComponentEventHandler(String, int, String, ComponentEventHandler)}).
+ * Interface used with  {@link org.apache.tapestry5.services.transform.TransformationSupport#addEventHandler(String, int, String, ComponentEventHandler)}}.
  *
  * @since 5.2.0
  */

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008, 2009, 2010, 2011 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2009, 2010, 2011, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -1535,7 +1535,6 @@ public final class TapestryModule
      * partial page renders.
      * Supports an ordered configuration of {@link org.apache.tapestry5.services.PartialMarkupRendererFilter}s.
      *
-     * @see #contributePartialMarkupRenderer(org.apache.tapestry5.ioc.OrderedConfiguration, org.apache.tapestry5.Asset, org.apache.tapestry5.services.javascript.JavaScriptStackSource, org.apache.tapestry5.internal.services.javascript.JavaScriptStackPathConstructor, org.apache.tapestry5.ioc.services.SymbolSource, AssetSource)
      */
     public PartialMarkupRenderer buildPartialMarkupRenderer(Logger logger,
                                                             List<PartialMarkupRendererFilter> configuration, @Autobuild
@@ -2401,10 +2400,6 @@ public final class TapestryModule
      * <dl>
      * <dt>Ajax</dt>
      * <dd>Determines if the request is Ajax oriented, and redirects to an alternative handler if so</dd>
-     * <dt>ImmediateRender</dt>
-     * <dd>When {@linkplain SymbolConstants#SUPPRESS_REDIRECT_FROM_ACTION_REQUESTS
-     * immediate action response rendering} is enabled, generates the markup response (instead of a page redirect
-     * response, which is the normal behavior)</dd>
      * <dt>Secure</dt>
      * <dd>Sends a redirect if an non-secure request accesses a secure page</dd>
      * </dl>

Modified: tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java (original)
+++ tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-// Copyright 2009, 2010 The Apache Software Foundation
+// Copyright 2009, 2010, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -129,8 +129,7 @@ public abstract class SeleniumTestCase e
      * </table>
      * <p>
      * Tests in the <em>beforeStartup</em> group will be run before the start of Selenium. This can be used to
-     * programmatically override the above parameter values. For an example see
-     * {@link org.apache.tapestry5.integration.reload.ReloadTests#beforeStartup}.
+     * programmatically override the above parameter values.
      * <p>
      * This method will be invoked in <em>each</em> subclass, but is set up to only startup the servers once (it checks
      * the {@link ITestContext} to see if the necessary keys are already present).

Modified: tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/TapestryTestConfiguration.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/TapestryTestConfiguration.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/TapestryTestConfiguration.java (original)
+++ tapestry/tapestry5/trunk/tapestry-test/src/main/java/org/apache/tapestry5/test/TapestryTestConfiguration.java Thu Jan  5 18:51:59 2012
@@ -1,65 +1,65 @@
-//  Copyright 2011 The Apache Software Foundation
-//
-//  Licensed under the Apache License, Version 2.0 (the "License");
-//  you may not use this file except in compliance with the License.
-//  You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-//  Unless required by applicable law or agreed to in writing, software
-//  distributed under the License is distributed on an "AS IS" BASIS,
-//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-//  See the License for the specific language governing permissions and
-//  limitations under the License.
-
-package org.apache.tapestry5.test;
-
-import org.apache.tapestry5.test.SeleniumTestCase;
-
-import java.lang.annotation.*;
-
-/**
- * To be used on Selenium-based integration tests that extend {@link SeleniumTestCase} as an alternative to using a
- * TestNG XML configuration file. Using the XML file, it's intricate to run <em>individual</em> test classes or
- * methods using IDEA's or Eclipse's TestNG integration.
- *
- * <b>Parameters coming from a TestNG XML configuration file take precedence over those supplied with the annotation.</b>
- *
- * Configures the container to be started for the tests and the browser to be used.
- */
-@Target(ElementType.TYPE)
-@Retention(RetentionPolicy.RUNTIME)
-@Documented
-public @interface TapestryTestConfiguration
-{
-    /**
-     * The folder for the web application root relative to the working directory. Defaults to "src/main/webapp".
-     */
-    String webAppFolder() default "src/main/webapp";
-
-    /**
-     * Which container to use. Can be one of {@link SeleniumTestCase.JETTY_7} or {@link SeleniumTestCase.TOMCAT_6}.
-     * Defaults to {@link SeleniumTestCase.JETTY_7}.
-     */
-    String container() default SeleniumTestCase.JETTY_7;
-
-    /**
-     * The context path to make the application available under. Defaults to "", i.e. the context root.
-     */
-    String contextPath() default "";
-
-    /**
-     * The port to listen on for HTTP requests. Defaults to "9090".
-     */
-    String port() default "9090";
-
-    /**
-     * The port to listen on fot HTTPS requests. Defaults to "8443".
-     */
-    String sslPort() default "8443";
-
-    /**
-     * The browser start command to use with Selenium. Defaults to "*firefox".
-     */
-    String browserStartCommand() default "*firefox";
-}
+//  Copyright 2011, 2012 The Apache Software Foundation
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+package org.apache.tapestry5.test;
+
+import org.apache.tapestry5.test.SeleniumTestCase;
+
+import java.lang.annotation.*;
+
+/**
+ * To be used on Selenium-based integration tests that extend {@link SeleniumTestCase} as an alternative to using a
+ * TestNG XML configuration file. Using the XML file, it's intricate to run <em>individual</em> test classes or
+ * methods using IDEA's or Eclipse's TestNG integration.
+ *
+ * <b>Parameters coming from a TestNG XML configuration file take precedence over those supplied with the annotation.</b>
+ *
+ * Configures the container to be started for the tests and the browser to be used.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface TapestryTestConfiguration
+{
+    /**
+     * The folder for the web application root relative to the working directory. Defaults to "src/main/webapp".
+     */
+    String webAppFolder() default "src/main/webapp";
+
+    /**
+     * Which container to use. Can be one of {@link SeleniumTestCase#JETTY_7} or {@link SeleniumTestCase#TOMCAT_6}.
+     * Defaults to {@link SeleniumTestCase#JETTY_7}.
+     */
+    String container() default SeleniumTestCase.JETTY_7;
+
+    /**
+     * The context path to make the application available under. Defaults to "", i.e. the context root.
+     */
+    String contextPath() default "";
+
+    /**
+     * The port to listen on for HTTP requests. Defaults to "9090".
+     */
+    String port() default "9090";
+
+    /**
+     * The port to listen on fot HTTPS requests. Defaults to "8443".
+     */
+    String sslPort() default "8443";
+
+    /**
+     * The browser start command to use with Selenium. Defaults to "*firefox".
+     */
+    String browserStartCommand() default "*firefox";
+}

Modified: tapestry/tapestry5/trunk/tapestry5-annotations/src/main/java/org/apache/tapestry5/ioc/annotations/InjectResource.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry5-annotations/src/main/java/org/apache/tapestry5/ioc/annotations/InjectResource.java?rev=1227747&r1=1227746&r2=1227747&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry5-annotations/src/main/java/org/apache/tapestry5/ioc/annotations/InjectResource.java (original)
+++ tapestry/tapestry5/trunk/tapestry5-annotations/src/main/java/org/apache/tapestry5/ioc/annotations/InjectResource.java Thu Jan  5 18:51:59 2012
@@ -1,4 +1,4 @@
-//  Copyright 2008, 2009 The Apache Software Foundation
+// Copyright 2008, 2009, 2012 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@ import java.lang.annotation.*;
  * Annotation used with field injection when the desired injection value is a resource (such as a service id, service
  * configuration, or logger) and not an object obtained from the {@link org.apache.tapestry5.ioc.services.MasterObjectProvider}.
  * <p/>
- * In Tapestry 5.3, the logic for this was changed so that it is treated the same as {@link @Inject}. This reflects what people usually want.
+ * In Tapestry 5.3, the logic for this was changed so that it is treated the same as {@link Inject}. This reflects what people usually want.
  *
  * @deprecated Deprecated in Tapestry 5.3, to be removed in a later release. Use {@link Inject} instead.
  */