tapestry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hls...@apache.org
Subject svn commit: r1157929 - in /tapestry/tapestry5/trunk: tapestry-core/src/main/java/org/apache/tapestry5/ tapestry-core/src/main/java/org/apache/tapestry5/alerts/ tapestry-core/src/main/java/org/apache/tapestry5/annotations/ tapestry-core/src/main/java/or...
Date Mon, 15 Aug 2011 18:11:54 GMT
Author: hlship
Date: Mon Aug 15 18:11:53 2011
New Revision: 1157929

URL: http://svn.apache.org/viewvc?rev=1157929&view=rev
Log:
Correct JavaDoc warnings and add package info for a couple of packages (more to come)

Added:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/alerts/package-info.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/package-info.java
Modified:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Alerts.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/structure/Page.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/transform/ParameterConduit.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ClassTransformation.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/ContextValueEncoder.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/DataTypeAnalyzer.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MethodAccess.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestParameters.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TapestryModule.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethod.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethodSignature.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/StylesheetOptions.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/messages/ComponentMessagesSource.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentRequestSelectorAnalyzer.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentResourceSelector.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeExpansionModel.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/RegistryBuilder.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/InternalRegistry.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InternalUtils.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/DefaultImplementationBuilder.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/ExceptionInfo.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/FieldValueConduit.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PerThreadValue.java
    tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PipelineBuilder.java

Added: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/alerts/package-info.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/alerts/package-info.java?rev=1157929&view=auto
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/alerts/package-info.java (added)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/alerts/package-info.java Mon Aug 15 18:11:53 2011
@@ -0,0 +1,6 @@
+/**
+ Support for a standard way of presenting alerts to the user, via the {@link org.apache.tapestry5.alerts.AlertManager} service combined with the
+ {@link org.apache.tapestry5.corelib.components.Alerts} component.
+
+ @since 5.3 */
+package org.apache.tapestry5.alerts;
\ No newline at end of file

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Import.java Mon Aug 15 18:11:53 2011
@@ -14,66 +14,57 @@
 
 package org.apache.tapestry5.annotations;
 
-import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.COMPONENT;
-import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN;
-import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
 import org.apache.tapestry5.ioc.annotations.UseWith;
 import org.apache.tapestry5.services.javascript.JavaScriptStack;
 import org.apache.tapestry5.services.javascript.JavaScriptSupport;
 
+import java.lang.annotation.*;
+
+import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
+
 /**
  * Annotations to control the importing of JavaScript stacks and libraries as well as stylesheets. This annotation may
  * be placed on a class, in which case importing will occur as part of the {@link SetupRender} render phase.
  * Alternately, the annotation maybe placed on any method (though typically it will be placed on a render phase
  * method) and the import operations will be associated of that method.
- * <p>
- * Assets are localized during the {@link org.apache.tapestry5.runtime.Component#containingPageDidLoad()} lifecycle
+ * <p/>
+ * Assets are localized during the {@link org.apache.tapestry5.runtime.PageLifecycleAdapter#containingPageDidLoad()} lifecycle
  * method.
- * 
+ *
  * @see JavaScriptSupport
  * @since 5.2.0
  */
 @Target(
-{ ElementType.TYPE, ElementType.METHOD })
+        {ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @UseWith(
-{ COMPONENT, MIXIN, PAGE })
+        {COMPONENT, MIXIN, PAGE})
 public @interface Import
 {
     /**
      * JavaScript Stacks to import. Stacks are imported before individual libraries. Note that
      * stacks themselves may have {@linkplain JavaScriptStack#getStacks() dependencies on other
      * stacks}.
-     * 
+     *
      * @see JavaScriptStack
      * @see JavaScriptSupport#importStack(String)
      */
-    String[] stack() default
-    {};
+    String[] stack() default {};
 
     /**
      * JavaScript libraries to import. Each value is an asset path; symbols in each path are expanded. The library may
      * be localized.
-     * 
+     *
      * @see JavaScriptSupport#importJavaScriptLibrary(org.apache.tapestry5.Asset)
      */
-    String[] library() default
-    {};
+    String[] library() default {};
 
     /**
      * Stylesheets to import. Each value is an asset path; symbols in each path are expanded. The stylesheet may be
      * localized. The stylesheet is imported with no options.
-     * 
+     *
      * @see JavaScriptSupport#importStylesheet(org.apache.tapestry5.Asset)
      */
-    String[] stylesheet() default
-    {};
+    String[] stylesheet() default {};
 }

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Alerts.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Alerts.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Alerts.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Alerts.java Mon Aug 15 18:11:53 2011
@@ -30,7 +30,7 @@ import org.apache.tapestry5.services.jav
 /**
  * Renders out an empty {@code <div>} element and provides JavaScript initialization to make the element
  * the container for alerts. After rendering markup (and initialization JavaScript), it
- * {@linkplain org.apache.tapestry5.alerts.AlertStorage#dismissNonPersistent() removes all non-persistent alerts).
+ * {@linkplain org.apache.tapestry5.alerts.AlertStorage#dismissNonPersistent() removes all non-persistent alerts}.
  *
  * @tapestrydoc
  * @since 5.3

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/structure/Page.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/structure/Page.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/structure/Page.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/structure/Page.java Mon Aug 15 18:11:53 2011
@@ -184,7 +184,7 @@ public interface Page
     void pageReset();
 
     /**
-     * Returns time, in milliseconds, that the page was last attached. This is used by the {@link PagePool} to
+     * Returns time, in milliseconds, that the page was last attached. This is used by the {@link org.apache.tapestry5.internal.services.PageSource} service to
      * cull unused pages from memory.
      *
      * @return milliseconds time of last {@link #attached()}} call

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/transform/ParameterConduit.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/transform/ParameterConduit.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/transform/ParameterConduit.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/transform/ParameterConduit.java Mon Aug 15 18:11:53 2011
@@ -17,29 +17,26 @@ package org.apache.tapestry5.internal.tr
 import org.apache.tapestry5.Binding;
 import org.apache.tapestry5.annotations.Parameter;
 import org.apache.tapestry5.internal.InternalComponentResources;
-import org.apache.tapestry5.internal.bindings.LiteralBinding;
-import org.apache.tapestry5.ioc.services.FieldValueConduit;
 import org.apache.tapestry5.ioc.services.TypeCoercer;
 import org.apache.tapestry5.plastic.FieldConduit;
-import org.apache.tapestry5.runtime.Component;
 
 /**
  * A facade around {@link Binding} and {@link InternalComponentResources} that is used to instrument
  * fields with the {@link Parameter} annotation. Extends {@link FieldConduit} so that
  * the get() method implicitly coerces the value to the field's type.
- * <p>
+ * <p/>
  * {@link #get(Object, org.apache.tapestry5.plastic.InstanceContext)} will read from the underlying {@link Binding} and used the {@link TypeCoercer} coerce the value to the
  * parameter field's type. get() also includes a null value check (as per {@link Parameter#allowNull()}.
- * <p>
+ * <p/>
  * {@link #set(Object, org.apache.tapestry5.plastic.InstanceContext, Object)} pushes the value into the binding.
- * 
+ *
  * @since 5.2.0
  */
 public interface ParameterConduit extends FieldConduit<Object>
 {
     /**
      * Determines if the parameter is actually bound.
-     * 
+     *
      * @return true if bound
      */
     boolean isBound();
@@ -50,7 +47,7 @@ public interface ParameterConduit extend
     void reset();
 
     /**
-     * Invoked from the component's {@link Component#containingPageDidLoad()} lifecycle method, to
+     * Invoked from the component's {@link org.apache.tapestry5.runtime.PageLifecycleListener#containingPageDidLoad()} lifecycle method, to
      * finishing initializing
      * the conduit prior to real use.
      */

Added: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/package-info.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/package-info.java?rev=1157929&view=auto
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/package-info.java (added)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/package-info.java Mon Aug 15 18:11:53 2011
@@ -0,0 +1,3 @@
+
+/** Root package for Tapestry, containing a common interfaces and data types used throughout the framework. */
+package org.apache.tapestry5;
\ No newline at end of file

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ClassTransformation.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ClassTransformation.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ClassTransformation.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ClassTransformation.java Mon Aug 15 18:11:53 2011
@@ -54,8 +54,6 @@ import org.slf4j.Logger;
  * The majority of methods concern the <em>declared</em> members (field and methods) of a specific class, rather than
  * any fields or methods inherited from a base class.
  * 
- * @see org.apache.tapestry5.services.TapestryModule#provideOldStyleCassTransformWorkers(
- * org.apache.tapestry5.ioc.OrderedConfiguration, org.apache.tapestry5.services.meta.MetaWorker, ComponentClassResolver)
  * @deprecated In 5.3
  * @see PlasticClass
  */

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=1157929&r1=1157928&r2=1157929&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 Mon Aug 15 18:11:53 2011
@@ -18,7 +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, ComponentEventHandler)}} (and, in the old
+ * 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)}).
  *
  * @since 5.2.0

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ContextValueEncoder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ContextValueEncoder.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ContextValueEncoder.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/ContextValueEncoder.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2008 The Apache Software Foundation
+// Copyright 2008, 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.
@@ -17,13 +17,13 @@ package org.apache.tapestry5.services;
 /**
  * Used to convert values used in event contexts to client string representations and back.
  *
- * @See org.apache.tapestry5.ValueEncoder
+ * @see org.apache.tapestry5.ValueEncoder
  * @see org.apache.tapestry5.ioc.services.TypeCoercer
  */
 public interface ContextValueEncoder
 {
     /**
-     * Converts a context value into a client-side string (that will utltimately be encoded into a URL).
+     * Converts a context value into a client-side string (that will ultimately be encoded into a URL).
      *
      * @param value to convert (may not be null)
      * @return string representation of the value

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/DataTypeAnalyzer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/DataTypeAnalyzer.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/DataTypeAnalyzer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/DataTypeAnalyzer.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008 The Apache Software Foundation
+// Copyright 2007, 2008, 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.
@@ -24,17 +24,17 @@ import org.apache.tapestry5.ioc.services
  * the value of the property, or what kind of interface to use for editing the value of the property. Common property
  * types are "text", "enum", "checkbox", but the list is extensible.
  * <p/>
- * <p>Different strategies for identifying the data type are encapsulated in the DataTypeAnalyzer service, forming a
+ * Different strategies for identifying the data type are encapsulated in the DataTypeAnalyzer service, forming a
  * chain of command.
  * <p/>
  * The DefaultDataTypeAnalyzer service maps property types to data type names.
  * <p/>
  * The DataTypeAnalyzer service is an extensible {@linkplain org.apache.tapestry5.ioc.services.ChainBuilder chain of
- * command), that (by default) includes {@link org.apache.tapestry5.internal.services.AnnotationDataTypeAnalyzer} and
- * the DefaultDataTypeAnalyzer service (ordered last).   It uses an ordered configuration.
+ * command}), that (by default) includes {@link org.apache.tapestry5.internal.services.AnnotationDataTypeAnalyzer} and
+ * the {@link org.apache.tapestry5.internal.services.DefaultDataTypeAnalyzer} service (ordered last).   It uses an ordered configuration.
  *
- * @see Grid
- * @see BeanEditForm
+ * @see org.apache.tapestry5.corelib.components.Grid
+ * @see org.apache.tapestry5.corelib.components.BeanEditForm
  * @see BeanBlockSource
  */
 @UsesOrderedConfiguration(DataTypeAnalyzer.class)

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/LibraryMapping.java Mon Aug 15 18:11:53 2011
@@ -32,8 +32,6 @@ import org.apache.tapestry5.ioc.internal
  * <dt>base</dt>
  * <dd>contains base classes</dd>
  * </dl>
- * 
- * @see org.apache.tapestry5.services.TapestryModule#contributeComponentClassResolver(org.apache.tapestry5.ioc.Configuration)
  */
 public final class LibraryMapping
 {
@@ -43,21 +41,19 @@ public final class LibraryMapping
      * Maps a virtual folder to a package that contains sub-packages for components, pages, etc. The special pathPrefix
      * "" (the empty string) identifies the application. Tapestry defines a special pathPrefix, "core", for the core
      * components.
-     * <p>
+     * <p/>
      * Note that it <em>is</em> allowed to contribute mutiple LibraryMappings with the same prefix to the
      * {@link ComponentClassResolver}, and the results are merged (though conflicts, where the same simple name appears
      * under multiple root packages, is not currently checked for).
-     * 
-     * @param virtualFolderName
-     *            identifies the virtual folder "containing" the pages and components of the library. Prior to Tapestry
-     *            5.2, the name could include a slash, but this is now expressly forbidden.
-     * @param rootPackage
-     *            The root package to search.
+     *
+     * @param virtualFolderName identifies the virtual folder "containing" the pages and components of the library. Prior to Tapestry
+     *                          5.2, the name could include a slash, but this is now expressly forbidden.
+     * @param rootPackage       The root package to search.
      */
     public LibraryMapping(String virtualFolderName, String rootPackage)
     {
         assert InternalUtils.isNonBlank(rootPackage);
-        
+
         if (virtualFolderName.contains("/"))
             throw new RuntimeException(
                     "LibraryMapping path prefixes may no longer contain slashes (as of Tapestry 5.2).");

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MarkupRenderer.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008 The Apache Software Foundation
+// Copyright 2007, 2008, 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.
@@ -25,7 +25,7 @@ import org.apache.tapestry5.ioc.annotati
  * which are used for ordinary page rendering (as opposed to {@linkplain org.apache.tapestry5.services.PartialMarkupRenderer
  * partial page rendering} for Ajax requests). The MarkupRenderer service may be selected using the
  *
- * @{@link org.apache.tapestry5.ioc.annotations.Primary} marker annotation.
+ * @see org.apache.tapestry5.ioc.annotations.Primary
  */
 @UsesOrderedConfiguration(MarkupRendererFilter.class)
 public interface MarkupRenderer

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MethodAccess.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MethodAccess.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MethodAccess.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/MethodAccess.java Mon Aug 15 18:11:53 2011
@@ -22,11 +22,13 @@ import org.apache.tapestry5.plastic.Plas
  * Represents a bridge to an object method, when that method may not be public. A MethodAccess object
  * encapsulates the approach for invoking the method and capturing the result (either the return value,
  * or the checked exception that is thrown).
- * 
- * @since 5.2.0
+ *
  * @see TransformMethod#getAccess()
+ * @see PlasticClass
+ * @see PlasticMethod
+ * @see MethodHandle
+ * @since 5.2.0
  * @deprecated Deprecated in 5.3
- * @see {@link PlasticClass}, {@link {@link PlasticMethod}, {@link MethodHandle}
  */
 public interface MethodAccess
 {
@@ -34,11 +36,9 @@ public interface MethodAccess
      * Invoke the method on the target, passing a number of arguments to the method.
      * If the method throws a RuntimeException, that is passed through unchanged.
      * If the method throws a checked exception, that will be reflected in the invocation result.
-     * 
-     * @param target
-     *            object on which to invoke a method
-     * @param arguments
-     *            arguments to pass to the method
+     *
+     * @param target    object on which to invoke a method
+     * @param arguments arguments to pass to the method
      */
     MethodInvocationResult invoke(Object target, Object... arguments);
 }

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestParameters.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestParameters.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestParameters.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/PageRenderRequestParameters.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2008, 2009, 2010The Apache Software Foundation
+// Copyright 2008, 2009, 2010, 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.
@@ -30,16 +30,22 @@ public class PageRenderRequestParameters
 
     private final EventContext activationContext;
 
-    /** @since 5.2.0 */
+    /**
+     * @since 5.2.0
+     */
     private final boolean loopback;
 
-    /** @deprecated Use {@link #PageRenderRequestParameters(String, EventContext, boolean)  */
+    /**
+     * @deprecated Use {@link #PageRenderRequestParameters(String, EventContext, boolean)}.
+     */
     public PageRenderRequestParameters(String logicalPageName, EventContext activationContext)
     {
         this(logicalPageName, activationContext, false);
     }
 
-    /** @since 5.2.0 */
+    /**
+     * @since 5.2.0
+     */
     public PageRenderRequestParameters(String logicalPageName, EventContext activationContext, boolean loopback)
     {
         assert logicalPageName != null;
@@ -80,10 +86,10 @@ public class PageRenderRequestParameters
 
     /**
      * Is this request a loopback (a request for the same page that rendered it in the first place)?
-     * 
-     * @since 5.2.0
+     *
      * @see TapestryConstants#PAGE_LOOPBACK_PARAMETER_NAME
      * @see PageResetListener
+     * @since 5.2.0
      */
     public boolean isLoopback()
     {

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=1157929&r1=1157928&r2=1157929&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 Mon Aug 15 18:11:53 2011
@@ -957,7 +957,7 @@ public final class TapestryModule
      * <li>Collection to {@link GridDataSource}
      * <li>null to {@link GridDataSource}
      * <li>List to {@link SelectModel}
-     * <li>{@link .ComponentResourcesAware} (typically, a component) to {@link ComponentResources}
+     * <li>{@link ComponentResourcesAware} (typically, a component) to {@link ComponentResources}
      * <li> {@link ComponentResources} to {@link PropertyOverrides}
      * <li>String to {@link Renderable}
      * <li>{@link Renderable} to {@link Block}
@@ -2690,9 +2690,8 @@ public final class TapestryModule
      * even if a user overrides the default
      * service implementation.
      *
-     * @param defaultSource The serivce to decorate
+     * @param defaultSource The service to decorate
      * @param environment
-     * @return
      */
     public static FieldValidatorDefaultSource decorateFieldValidatorDefaultSource(
             final FieldValidatorDefaultSource defaultSource, final Environment environment)

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethod.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethod.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethod.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethod.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2010 The Apache Software Foundation
+// Copyright 2010, 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.
@@ -76,7 +76,6 @@ public interface TransformMethod extends
      * and line number
      * information (when available).
      * 
-     * @param signature
      * @return a string that identifies the class, method name, types of parameters, source file and
      *         source line number
      */

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethodSignature.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethodSignature.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethodSignature.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/TransformMethodSignature.java Mon Aug 15 18:11:53 2011
@@ -252,7 +252,6 @@ public class TransformMethodSignature im
      * of the method and the
      * types of any parameters, omitting return type, exceptions and modifiers.
      *
-     * @return
      */
     public String getMediumDescription()
     {

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java Mon Aug 15 18:11:53 2011
@@ -14,11 +14,7 @@
 
 package org.apache.tapestry5.services.javascript;
 
-import org.apache.tapestry5.Asset;
-import org.apache.tapestry5.ComponentResources;
-import org.apache.tapestry5.FieldFocusPriority;
-import org.apache.tapestry5.RenderSupport;
-import org.apache.tapestry5.SymbolConstants;
+import org.apache.tapestry5.*;
 import org.apache.tapestry5.annotations.Environmental;
 import org.apache.tapestry5.json.JSONArray;
 import org.apache.tapestry5.json.JSONObject;
@@ -29,19 +25,21 @@ import org.apache.tapestry5.services.Env
  * the the key methods. JavaScriptSupport is very stateful, accumulating JavaScript stacks, libraries and initialization
  * code until the end of the main page render; it then updates the rendered DOM (adding &lt;script&gt; tags to the
  * &lt;head&gt; and &lt;body&gt;) before the document is streamed to the client.
- * <p>
+ * <p/>
  * JavaScriptSupport is normally accessed within a component by using the {@link Environmental} annotation on a
  * component field. In addition, JavaScriptSupport may also be accessed as a service (the service
  * {@linkplain EnvironmentalShadowBuilder internally delegates to the current environmental instance}), which is useful
  * for service-layer objects.
- * <p>
+ * <p/>
  * The term "import" is used on many methods to indicate that the indicated resource (stack, library or stylesheet) will
  * only be added to the final Document once.
- * <p>
+ * <p/>
  * The name is slightly a misnomer, since there's a side-line of
- * {@linkplain #importStylesheet(Asset, StylesheetOptions)
- * importing stylesheets} as well.
- * 
+ * {@linkplain #importStylesheet(StylesheetLink)} as well.
+ * <p/>
+ * JavaScriptSupport works equally well inside an Ajax request that produces a JSON-formatted partial page update response.
+ *
+ * @see org.apache.tapestry5.internal.services.DocumentLinker
  * @since 5.2.0
  */
 public interface JavaScriptSupport
@@ -49,9 +47,8 @@ public interface JavaScriptSupport
     /**
      * Allocates a unique id based on the component's id. In some cases, the return value will not precisely match the
      * input value (an underscore and a unique index value may be appended).
-     * 
-     * @param id
-     *            the component id from which a unique id will be generated
+     *
+     * @param id the component id from which a unique id will be generated
      * @return a unique id for this rendering of the page
      * @see org.apache.tapestry5.ioc.util.IdAllocator
      */
@@ -59,32 +56,26 @@ public interface JavaScriptSupport
 
     /**
      * As with {@link #allocateClientId(String)} but uses the id of the component extracted from the resources.
-     * 
-     * @param resources
-     *            of the component which requires an id
+     *
+     * @param resources of the component which requires an id
      * @return a unique id for this rendering of the page
      */
     String allocateClientId(ComponentResources resources);
 
     /**
      * Adds initialization script at {@link InitializationPriority#NORMAL} priority.
-     * 
-     * @param format
-     *            format string (as per {@link String#format(String, Object...)}
-     * @param arguments
-     *            arguments referenced by format specifiers
+     *
+     * @param format    format string (as per {@link String#format(String, Object...)}
+     * @param arguments arguments referenced by format specifiers
      */
     void addScript(String format, Object... arguments);
 
     /**
      * Adds initialization script at the specified priority.
-     * 
-     * @param priority
-     *            priority to use when adding the script
-     * @param format
-     *            format string (as per {@link String#format(String, Object...)}
-     * @param arguments
-     *            arguments referenced by format specifiers
+     *
+     * @param priority  priority to use when adding the script
+     * @param format    format string (as per {@link String#format(String, Object...)}
+     * @param arguments arguments referenced by format specifiers
      */
     void addScript(InitializationPriority priority, String format, Object... arguments);
 
@@ -92,11 +83,9 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * {@link InitializationPriority#NORMAL} priority.
-     * 
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            object to pass to the client-side function
+     *
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    object to pass to the client-side function
      */
     void addInitializerCall(String functionName, JSONObject parameter);
 
@@ -104,11 +93,9 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * {@link InitializationPriority#NORMAL} priority.
-     * 
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            array of parameters to pass to the client-side function
+     *
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    array of parameters to pass to the client-side function
      * @since 5.3
      */
     void addInitializerCall(String functionName, JSONArray parameter);
@@ -117,11 +104,9 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * {@link InitializationPriority#NORMAL} priority.
-     * 
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            array of parameters to pass to the client-side function
+     *
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    array of parameters to pass to the client-side function
      * @since 5.3
      */
     void addInitializerCall(InitializationPriority priority, String functionName, JSONArray parameter);
@@ -130,13 +115,10 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * the specified priority.
-     * 
-     * @param priority
-     *            priority to use when adding the script
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            object to pass to the client-side function
+     *
+     * @param priority     priority to use when adding the script
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    object to pass to the client-side function
      */
     void addInitializerCall(InitializationPriority priority, String functionName, JSONObject parameter);
 
@@ -144,11 +126,9 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * {@link InitializationPriority#NORMAL} priority.
-     * 
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            string to pass to function (typically, a client id)
+     *
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    string to pass to function (typically, a client id)
      */
     void addInitializerCall(String functionName, String parameter);
 
@@ -156,29 +136,25 @@ public interface JavaScriptSupport
      * Adds a call to a client-side function inside the Tapestry.Initializer namespace. Calls to this
      * method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
      * the specified priority.
-     * 
-     * @param priority
-     *            priority to use when adding the script
-     * @param functionName
-     *            name of client-side function (within Tapestry.Initializer namespace) to execute
-     * @param parameter
-     *            string to pass to function (typically, a client id)
+     *
+     * @param priority     priority to use when adding the script
+     * @param functionName name of client-side function (within Tapestry.Initializer namespace) to execute
+     * @param parameter    string to pass to function (typically, a client id)
      */
     void addInitializerCall(InitializationPriority priority, String functionName, String parameter);
 
     /**
      * Imports a JavaScript library as part of the rendered page. Libraries are added in the order
      * they are first imported; duplicate imports are ignored.
-     * 
-     * @see IncludeJavaScriptLibrary
+     *
+     * @see org.apache.tapestry5.annotations.Import
      */
     void importJavaScriptLibrary(Asset asset);
 
     /**
      * A convenience method that wraps the Asset as a {@link StylesheetLink}.
-     * 
-     * @param stylesheet
-     *            asset for the stylesheet
+     *
+     * @param stylesheet asset for the stylesheet
      * @see #importStylesheet(StylesheetLink)
      */
     void importStylesheet(Asset stylesheet);
@@ -186,9 +162,8 @@ public interface JavaScriptSupport
     /**
      * Imports a Cascading Style Sheet file as part of the rendered page. Stylesheets are added in the
      * order they are first imported; duplicate imports are ignored.
-     * 
-     * @param stylesheetLink
-     *            encapsulates the link URL plus any additional options
+     *
+     * @param stylesheetLink encapsulates the link URL plus any additional options
      */
     void importStylesheet(StylesheetLink stylesheetLink);
 
@@ -198,9 +173,8 @@ public interface JavaScriptSupport
      * {@linkplain SymbolConstants#COMBINE_SCRIPTS JavaScript aggregation} in enabled, the stack will be represented by
      * a single virtual URL; otherwise the individual asset URLs of the stack
      * will be added to the document.
-     * 
-     * @param stackName
-     *            the name of the stack (case is ignored); the stack must exist
+     *
+     * @param stackName the name of the stack (case is ignored); the stack must exist
      */
     void importStack(String stackName);
 
@@ -214,11 +188,9 @@ public interface JavaScriptSupport
      * precedence over a merely required field, and over a field that is optional. The value
      * {@link org.apache.tapestry5.FieldFocusPriority#OVERRIDE} can be used to force a particular field to receive
      * focus.
-     * 
-     * @param priority
-     *            focus is set only if the provided priority is greater than the current priority
-     * @param fieldId
-     *            id of client-side element to take focus
+     *
+     * @param priority focus is set only if the provided priority is greater than the current priority
+     * @param fieldId  id of client-side element to take focus
      */
     void autofocus(FieldFocusPriority priority, String fieldId);
 }

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/StylesheetOptions.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/StylesheetOptions.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/StylesheetOptions.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/StylesheetOptions.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2010 The Apache Software Foundation
+// Copyright 2010, 29011 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,7 +18,7 @@ import org.apache.tapestry5.internal.Tap
 
 /**
  * Provides options to describe options associated with importing a stylesheet onto a page.
- * 
+ *
  * @since 5.2.0
  */
 public class StylesheetOptions
@@ -49,8 +49,8 @@ public class StylesheetOptions
      * The Internet Explorer condition associated with the link. When non-blank, the
      * &lt;link&gt; element will be written inside a specially formatted comment interpreted
      * by Internet Explorer. Usually null.
-     * 
-     * @see http://en.wikipedia.org/wiki/Conditional_comment
+     *
+     * @see <a href="http://en.wikipedia.org/wiki/Conditional_comment">http://en.wikipedia.org/wiki/Conditional_comment</a>
      */
     public String getCondition()
     {

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/messages/ComponentMessagesSource.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/messages/ComponentMessagesSource.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/messages/ComponentMessagesSource.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/messages/ComponentMessagesSource.java Mon Aug 15 18:11:53 2011
@@ -14,8 +14,6 @@
 
 package org.apache.tapestry5.services.messages;
 
-import java.util.Locale;
-
 import org.apache.tapestry5.ioc.Messages;
 import org.apache.tapestry5.ioc.Resource;
 import org.apache.tapestry5.ioc.annotations.NotLazy;
@@ -24,6 +22,8 @@ import org.apache.tapestry5.model.Compon
 import org.apache.tapestry5.services.InvalidationEventHub;
 import org.apache.tapestry5.services.pageload.ComponentResourceSelector;
 
+import java.util.Locale;
+
 /**
  * Used to connect a Tapestry component to its message catalog, or to obtain the application catalog (that all
  * component message catalogs extend from). The application catalog is defined by the collection of {@link Resource}s
@@ -39,7 +39,7 @@ public interface ComponentMessagesSource
      * Used to obtain a {@link Messages} instance for a particular component, within a particular locale. If the
      * component extends from another component, then its localized properties will merge with its parent's properties
      * (with the subclass overriding the super class on any conflicts).
-     * 
+     *
      * @param componentModel
      * @param locale
      * @return the message catalog for the component, in the indicated locale
@@ -51,9 +51,9 @@ public interface ComponentMessagesSource
      * Used to obtain a {@link Messages} instance for a particular component, using a particular selector. If the
      * component extends from another component, then its localized properties will merge with its parent's properties
      * (with the subclass overriding the super class on any conflicts).
-     * 
+     *
      * @param componentModel
-     * @param locale
+     * @param selector       determined correct version of messages to obtain
      * @return the message catalog for the component, in the indicated selector
      * @since 5.3
      */
@@ -61,14 +61,14 @@ public interface ComponentMessagesSource
 
     /**
      * Gets the Messages derived from the application's message catalog.
-     * 
+     *
      * @since 5.2.0
      */
     Messages getApplicationCatalog(Locale locale);
 
     /**
      * Returns the event hub that allows listeners to be notified when any underlying message catalog file is changed.
-     * 
+     *
      * @since 5.1.0.0
      */
     @NotLazy

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentRequestSelectorAnalyzer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentRequestSelectorAnalyzer.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentRequestSelectorAnalyzer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentRequestSelectorAnalyzer.java Mon Aug 15 18:11:53 2011
@@ -18,7 +18,7 @@ import org.apache.tapestry5.ioc.services
 
 /**
  * Determines the {@link ComponentResourceSelector} for the current request. This is often based on cookies, query
- * parameters, or other details available in the {@link Request}. The default implementation simply wraps the
+ * parameters, or other details available in the {@link org.apache.tapestry5.services.Request}. The default implementation simply wraps the
  * {@linkplain ThreadLocale current locale} as a ComponentResourceSelector. A custom implementation may
  * {@linkplain ComponentResourceSelector#withAxis(Class, Object) add additional axes} to the selector.
  * 

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentResourceSelector.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentResourceSelector.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentResourceSelector.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/pageload/ComponentResourceSelector.java Mon Aug 15 18:11:53 2011
@@ -55,7 +55,7 @@ public final class ComponentResourceSele
      *
      * @param axisType  non-blank axis key
      * @param axisValue non-null axis value
-     * @return
+     * @return new selector including axis value
      */
     public <T> ComponentResourceSelector withAxis(Class<T> axisType, T axisValue)
     {
@@ -116,8 +116,6 @@ public final class ComponentResourceSele
     /**
      * Returns a string identifying the locale, and any additional axis types and values.  Example,
      * "en" or "fr com.example.Skin=RED".
-     *
-     * @return
      */
     public String toShortString()
     {

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeExpansionModel.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeExpansionModel.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeExpansionModel.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeExpansionModel.java Mon Aug 15 18:11:53 2011
@@ -21,7 +21,7 @@ import org.apache.tapestry5.corelib.comp
  * implementation} simply stores a set of {@linkplain TreeNode#getId() unique node
  * ids} to identify expanded nodes. The expansion model is updated whenever folders are expanded or
  * collapsed on the client side.
- * 
+ *
  * @since 5.3
  * @see Tree
  */
@@ -29,10 +29,10 @@ public interface TreeExpansionModel<T>
 {
     /**
      * Returns true if the node has been previously {@linkplain #markExpanded(TreeNode) expanded}.
-     * 
+     *
      * @param node
      *            node to check for expansion
-     * @return
+     * @return  true if expanded
      */
     boolean isExpanded(TreeNode<T> node);
 

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/RegistryBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/RegistryBuilder.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/RegistryBuilder.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/RegistryBuilder.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008, 2009, 2010 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2009, 2010, 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.
@@ -14,11 +14,6 @@
 
 package org.apache.tapestry5.ioc;
 
-import java.lang.reflect.AnnotatedElement;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Set;
-
 import org.apache.tapestry5.ioc.annotations.SubModule;
 import org.apache.tapestry5.ioc.def.ModuleDef;
 import org.apache.tapestry5.ioc.internal.DefaultModuleDefImpl;
@@ -35,6 +30,11 @@ import org.apache.tapestry5.ioc.services
 import org.apache.tapestry5.ioc.services.TapestryIOCModule;
 import org.slf4j.Logger;
 
+import java.lang.reflect.AnnotatedElement;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Set;
+
 /**
  * Used to construct the IoC {@link org.apache.tapestry5.ioc.Registry}. This class is <em>not</em> thread-safe. The
  * Registry, once created, <em>is</em> thread-safe.
@@ -106,7 +106,7 @@ public final class RegistryBuilder
 
     /**
      * Adds a number of modules (as module classes) to the registry, returning the builder for further configuration.
-     * 
+     *
      * @see org.apache.tapestry5.ioc.annotations.SubModule
      */
     public RegistryBuilder add(Class... moduleClasses)
@@ -145,7 +145,7 @@ public final class RegistryBuilder
     /**
      * Adds a modle class (specified by fully qualified class name) to the registry, returning the builder
      * for further configuration.
-     * 
+     *
      * @see org.apache.tapestry5.ioc.annotations.SubModule
      */
     public RegistryBuilder add(String classname)
@@ -157,8 +157,7 @@ public final class RegistryBuilder
             Class builderClass = Class.forName(classname, true, classLoader);
 
             add(builderClass);
-        }
-        catch (Exception ex)
+        } catch (Exception ex)
         {
             throw new RuntimeException(String.format("Failure loading Tapestry IoC module class %s: %s", classname,
                     InternalUtils.toMessage(ex), ex));
@@ -194,11 +193,9 @@ public final class RegistryBuilder
      * Constructs the registry, adds a {@link ModuleDef} and a number of modules (as module classes) to the registry and
      * performs registry startup. The returned registry is ready to use. The caller is must not invoke
      * {@link org.apache.tapestry5.ioc.Registry#performRegistryStartup()}.
-     * 
-     * @param moduleDef
-     *            {@link ModuleDef} to add
-     * @param moduleClasses
-     *            modules (as module classes) to add
+     *
+     * @param moduleDef     {@link ModuleDef} to add
+     * @param moduleClasses modules (as module classes) to add
      * @return {@link Registry}
      * @since 5.2.0
      */
@@ -222,11 +219,8 @@ public final class RegistryBuilder
      * Constructs the registry, adds a number of modules (as module classes) to the registry and
      * performs registry startup. The returned registry is ready to use. The caller is must not invoke
      * {@link org.apache.tapestry5.ioc.Registry#performRegistryStartup()}.
-     * 
-     * @param moduleDef
-     *            {@link ModuleDef} to add
-     * @param moduleClasses
-     *            modules (as module classes) to add
+     *
+     * @param moduleClasses modules (as module classes) to add
      * @return {@link Registry}
      * @since 5.2.0
      */

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/InternalRegistry.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/InternalRegistry.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/InternalRegistry.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/InternalRegistry.java Mon Aug 15 18:11:53 2011
@@ -14,23 +14,17 @@
 
 package org.apache.tapestry5.ioc.internal;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import org.apache.tapestry5.ioc.AnnotationProvider;
-import org.apache.tapestry5.ioc.ObjectLocator;
-import org.apache.tapestry5.ioc.OperationTracker;
-import org.apache.tapestry5.ioc.Registry;
-import org.apache.tapestry5.ioc.ServiceAdvisor;
-import org.apache.tapestry5.ioc.ServiceDecorator;
-import org.apache.tapestry5.ioc.ServiceLifecycle2;
+import org.apache.tapestry5.ioc.*;
 import org.apache.tapestry5.ioc.def.ServiceDef3;
 import org.apache.tapestry5.ioc.services.ClassFab;
 import org.apache.tapestry5.ioc.services.RegistryShutdownHub;
 import org.slf4j.Logger;
 
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
 /**
  * Internal view of the module registry, adding additional methods needed by modules.
  */
@@ -39,28 +33,22 @@ public interface InternalRegistry extend
     /**
      * As with {@link org.apache.tapestry5.ioc.Registry#getObject(Class, org.apache.tapestry5.ioc.AnnotationProvider)},
      * but handles the {@link org.apache.tapestry5.ioc.annotations.Local} annotation.
-     * 
-     * @param objectType
-     *            type of object o be injected
-     * @param annotationProvider
-     *            access to annotations at point of injection
-     * @param locator
-     *            used to resolve any subsequent injections
-     * @param localModule
-     *            module to limit services to, if Local annotaton present
+     *
+     * @param objectType         type of object o be injected
+     * @param annotationProvider access to annotations at point of injection
+     * @param locator            used to resolve any subsequent injections
+     * @param localModule        module to limit services to, if Local annotaton present
      * @return the service or object
      */
     <T> T getObject(Class<T> objectType, AnnotationProvider annotationProvider, ObjectLocator locator,
-            Module localModule);
+                    Module localModule);
 
     /**
      * Returns a service lifecycle by service scope name.
-     * 
-     * @param scope
-     *            the name of the service scope (case insensitive)
+     *
+     * @param scope the name of the service scope (case insensitive)
      * @return the lifecycle corresponding to the scope
-     * @throws RuntimeException
-     *             if the lifecycle name does not match a known lifecycle
+     * @throws RuntimeException if the lifecycle name does not match a known lifecycle
      */
     ServiceLifecycle2 getServiceLifecycle(String scope);
 
@@ -73,7 +61,7 @@ public interface InternalRegistry extend
 
     /**
      * Searches for advisors for a particular service, returning them in order of application.
-     * 
+     *
      * @since 5.1.0.0
      */
     List<ServiceAdvisor> findAdvisorsForService(ServiceDef3 serviceDef);
@@ -81,12 +69,10 @@ public interface InternalRegistry extend
     /**
      * Builds up an unordered collection by invoking service contributor methods that target the service (from any
      * module, unless the service is private).
-     * 
+     *
      * @param <T>
-     * @param serviceDef
-     *            defines the service for which configuration data is being assembled
-     * @param valueType
-     *            identifies the type of object allowed into the collection
+     * @param serviceDef defines the service for which configuration data is being assembled
+     * @param valueType  identifies the type of object allowed into the collection
      * @return the final collection
      */
     <T> Collection<T> getUnorderedConfiguration(ServiceDef3 serviceDef, Class<T> valueType);
@@ -95,28 +81,24 @@ public interface InternalRegistry extend
      * Builds up an ordered collection by invoking service contributor methods that target the service (from any module,
      * unless the service is private). Once all values have been added (each with an id, and pre/post constraints), the
      * values are ordered, null values dropped, and the final sorted list is returned.
-     * 
+     *
      * @param <T>
-     * @param serviceDef
-     *            defines the service for which configuration data is being assembled
-     * @param valueType
-     *            identifies the type of object allowed into the collection
+     * @param serviceDef defines the service for which configuration data is being assembled
+     * @param valueType  identifies the type of object allowed into the collection
      * @return the final ordered list
      */
     <T> List<T> getOrderedConfiguration(ServiceDef3 serviceDef, Class<T> valueType);
 
     /**
-     * Builds up a map of key/value pairs by invoking service contribution methods that tharget the service (from any
+     * Builds up a map of key/value pairs by invoking service contribution methods that target the service (from any
      * module, unless the service is private). Values and keys may not be null. Invalid values (keys or values that are
      * the wrong type, or duplicate keys) result in warnings and are ignored.
-     * 
-     * @param <K, V>
-     * @param serviceDef
-     *            defines the service for which configuration data is being assembled
-     * @param keyType
-     *            identifies the type of key object allowed into the map
-     * @param valueType
-     *            identifies the type of value object allowed into the map
+     *
+     * @param <K>
+     * @param <V>
+     * @param serviceDef defines the service for which configuration data is being assembled
+     * @param keyType    identifies the type of key object allowed into the map
+     * @param valueType  identifies the type of value object allowed into the map
      * @return the final ordered list
      */
     <K, V> Map<K, V> getMappedConfiguration(ServiceDef3 serviceDef, Class<K> keyType, Class<V> valueType);
@@ -124,16 +106,15 @@ public interface InternalRegistry extend
     /**
      * Convieience for creating a new {@link org.apache.tapestry5.ioc.services.ClassFab} instance using a
      * {@link org.apache.tapestry5.ioc.services.ClassFactory}.
-     * 
-     * @param serviceInterface
-     *            the interface to be implemented by the provided class
+     *
+     * @param serviceInterface the interface to be implemented by the provided class
      */
     ClassFab newClass(Class serviceInterface);
 
     /**
      * Given an input string that <em>may</em> contain symbols, returns the string with any and all symbols fully
      * expanded.
-     * 
+     *
      * @param input
      * @return expanded input
      */
@@ -142,7 +123,7 @@ public interface InternalRegistry extend
     /**
      * Returns a logger for the service, which consists of the Module's {@link Module#getLoggerName() log name} suffixed
      * with a period and the service id.
-     * 
+     *
      * @param serviceId
      * @return the logger for the service
      */
@@ -151,14 +132,14 @@ public interface InternalRegistry extend
     /**
      * Creates a just-in-time (and possibly, live reloading) proxy for the indicated class and interface, using the
      * provided locator to autobuild the implementationClass (when necessary).
-     * 
+     *
      * @since 5.2.0
      */
     <T> T proxy(Class<T> interfaceClass, Class<? extends T> implementationClass, ObjectLocator locator);
 
     /**
      * Returns a Set of Annotation classes that are used as service markers.
-     * 
+     *
      * @since 5.2.0
      */
     Set<Class> getMarkerAnnotations();

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InternalUtils.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InternalUtils.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InternalUtils.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InternalUtils.java Mon Aug 15 18:11:53 2011
@@ -1296,7 +1296,7 @@ public class InternalUtils
     }
 
     /**
-     * Wraps a {@lihk Coercion} as a {@link Mapper}.
+     * Wraps a {@link Coercion} as a {@link Mapper}.
      * 
      * @since 5.2.0
      */

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/DefaultImplementationBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/DefaultImplementationBuilder.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/DefaultImplementationBuilder.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/DefaultImplementationBuilder.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2006 The Apache Software Foundation
+// Copyright 2006, 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.
@@ -28,7 +28,7 @@ public interface DefaultImplementationBu
      *
      * @param <S>
      * @param serviceInterface
-     * @return
+     * @return implementation of service interface
      */
     <S> S createDefaultImplementation(Class<S> serviceInterface);
 }

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/ExceptionInfo.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/ExceptionInfo.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/ExceptionInfo.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/ExceptionInfo.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2008, 2010 The Apache Software Foundation
+// Copyright 2006, 2008, 2010, 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.
@@ -18,8 +18,8 @@ import java.util.List;
 
 /**
  * Contains information about an analyzed exception.
- * 
- * @see {@link org.apache.tapestry5.ioc.services.ExceptionAnalysis}
+ *
+ * @see ExceptionAnalysis
  */
 public interface ExceptionInfo
 {

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/FieldValueConduit.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/FieldValueConduit.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/FieldValueConduit.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/FieldValueConduit.java Mon Aug 15 18:11:53 2011
@@ -19,26 +19,26 @@ import org.apache.tapestry5.plastic.Plas
 
 /**
  * Used as a replacement for a field.
- * 
+ *
+ * @see PlasticField
+ * @see FieldConduit
  * @since 5.2.0
  * @deprecated Deprecated in 5.3, using Plastic equivalents
- * @see {@link PlasticField}, {@link FieldConduit}
  */
 public interface FieldValueConduit
 {
 
     /**
      * Reads the current value of the field.
-     * 
+     *
      * @return current value (possibly null)
      */
     Object get();
 
     /**
      * Sets the value of the field
-     * 
-     * @param newValue
-     *            to be captured
+     *
+     * @param newValue to be captured
      */
     void set(Object newValue);
 

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PerThreadValue.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PerThreadValue.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PerThreadValue.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PerThreadValue.java Mon Aug 15 18:11:53 2011
@@ -15,16 +15,22 @@
 package org.apache.tapestry5.ioc.services;
 
 /**
- * A wrapper around {@link PerthreadManager#get(Object)} and {@link PerthreadManager#put(Object, Object)}.
- * 
+ * Provides access to per-thread (and, by extension, per-request) data, managed by the {@link PerthreadManager}.
+ * A PerThreadValue stores a particular type of information.
+ *
+ * @see org.apache.tapestry5.ioc.services.PerthreadManager#createValue()
  * @since 5.2.0
  */
 public interface PerThreadValue<T>
 {
-    /** Is a value stored (even null)? */
+    /**
+     * Is a value stored (even null)?
+     */
     boolean exists();
 
-    /** Reads the current per-thread value, or returns null if no value has been stored. */
+    /**
+     * Reads the current per-thread value, or returns null if no value has been stored.
+     */
     T get();
 
     /**
@@ -33,6 +39,8 @@ public interface PerThreadValue<T>
      */
     T get(T defaultValue);
 
-    /** Sets the current per-thread value, then returns that value. */
+    /**
+     * Sets the current per-thread value, then returns that value.
+     */
     T set(T newValue);
 }

Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PipelineBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PipelineBuilder.java?rev=1157929&r1=1157928&r2=1157929&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PipelineBuilder.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PipelineBuilder.java Mon Aug 15 18:11:53 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007 The Apache Software Foundation
+// Copyright 2006, 2007, 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.
@@ -19,7 +19,7 @@ import org.slf4j.Logger;
 import java.util.List;
 
 /**
- * Creates a pipeline from a service inteface and an ordered list of filters. Each filter is defined in terms of a
+ * Creates a pipeline from a service interface and an ordered list of filters. Each filter is defined in terms of a
  * filter interface: the filter interface is a variant of the service interface, where each method has an additional
  * parameter that is an instance of the service interface. Typically, this service parameter (often named "delegate") is
  * either the first or the last parameter of each method.
@@ -33,7 +33,7 @@ import java.util.List;
  * terminator. In fact, it may be indirectly invoking methods on the next filter in the pipeline via a bridge instance.
  * <p/>
  * The builder is fairly smart about matching up service interface methods to filter interface methods, but keeping it
- * simple is also a good idea.
+ * simple is also a good idea.  By convention, the final parameter of each filter method is the delegate object (the bridge or terminator).
  */
 public interface PipelineBuilder
 {
@@ -43,8 +43,8 @@ public interface PipelineBuilder
      * @param <S>              service type
      * @param <F>              filter type
      * @param logger           logs any warnings generated when constructing the pipeline
-     * @param serviceInterface
-     * @param filterInterface
+     * @param serviceInterface defines the interface for the pipeline
+     * @param filterInterface  the filter interface, contributed into the pipeline
      * @param filters          sorted list of filters
      * @param terminator       end of the pipeline
      * @return an object that encapsulates the filters and the terminator
@@ -55,13 +55,13 @@ public interface PipelineBuilder
      * Creates a pipeline from just the filters. A {@link DefaultImplementationBuilder default implementation} is
      * created as the terminator.
      *
-     * @param <S>
-     * @param <F>
-     * @param logger
-     * @param serviceInterface
-     * @param filterInterface
-     * @param filters
-     * @return
+     * @param <S>              service type
+     * @param <F>              filter type
+     * @param logger           logs any warnings generated when constructing the pipeline
+     * @param serviceInterface defines the interface for the pipeline
+     * @param filterInterface  the filter interface, contributed into the pipeline
+     * @param filters          sorted list of filters
+     * @return an object that encapsulates the filters and the default implementation
      */
     <S, F> S build(Logger logger, Class<S> serviceInterface, Class<F> filterInterface, List<F> filters);
 



Mime
View raw message