Author: hlship
Date: Wed Jun 8 18:09:56 2011
New Revision: 1133494
URL: http://svn.apache.org/viewvc?rev=1133494&view=rev
Log:
TAP5-1528: Fix a number of JavaDoc errors and warnings
Modified:
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/InstructionBuilder.java
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java
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/internal/test/TestableRequest.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicTemplate.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/transform/ComponentClassTransformWorker2.java
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/FlowOperations.java
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
tapestry/tapestry5/trunk/tapestry-json/src/main/java/org/apache/tapestry5/json/JSONArray.java
Modified:
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/InstructionBuilder.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/InstructionBuilder.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/InstructionBuilder.java
(original)
+++
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/InstructionBuilder.java
Wed Jun 8 18:09:56 2011
@@ -24,7 +24,7 @@ import java.lang.reflect.Method;
* <p>
* Most methods return the same instance of InstructionBuilder, allowing for a
"fluid" API.
* <p>
- * More complex functionality, such as {@linkplain
#startTryCatch(InstructionBuilderCallback, TryCatchCallback)
+ * More complex functionality, such as {@linkplain
#startTryCatch(TryCatchCallback)
* try/catch blocks}, is more like a DSL (domain specific language), and is
based on callbacks. This looks better in
* Groovy and will be more reasonable once JDK 1.8 closures are available; in
the meantime, it means some deeply nested
* inner classes, but helps ensure that correct bytecode is generated and
helps to limit the amount of bookkeeping is
@@ -157,12 +157,8 @@ public interface InstructionBuilder
* Loads an instance field onto the stack. The plastic class instance
containing the field should already be loaded
* onto the stack (usually, via {@link #loadThis()}).
*
- * @param className
- * name of class containing the field
- * @param fieldName
- * name of the field
- * @param typeName
- * type of field
+ * @param field
+ * identifies name, type and container of field to load
*/
@Opcodes("GETFIELD")
InstructionBuilder getField(PlasticField field);
@@ -225,12 +221,10 @@ public interface InstructionBuilder
* Continue using this InstructionBuilder to define code inside the block,
then call
* methods on the InstructionBlock to define the end of the block and set
up handlers.
*
- * @param tryCallback
- * generates the code that is "inside" the <code>try</code>
- * @param catchCallback
- * generates <code>catch</code> and <code>finally</code> blocks
+ * @param tryCatchCallback
+ * allows generation of try, catch, and finally clauses
*/
- InstructionBuilder startTryCatch(TryCatchCallback catchCallback);
+ InstructionBuilder startTryCatch(TryCatchCallback tryCatchCallback);
/**
* Creates a new, uninitialized instance of the indicated class. This
should be followed
@@ -262,7 +256,6 @@ public interface InstructionBuilder
* the class containing the constructor
* @param argumentTypes
* java type names for each argument of the constructor
- * @return
*/
@Opcodes("INVOKESPECIAL")
InstructionBuilder invokeConstructor(String className, String...
argumentTypes);
@@ -275,7 +268,6 @@ public interface InstructionBuilder
*
* @param depth
* 0 (DUP), 1 (DUP_X1) or 2 (DUP_X2)
- * @return
*/
@Opcodes("DUP, DUP_X1, DUP_X2")
InstructionBuilder dupe(int depth);
@@ -306,8 +298,6 @@ public interface InstructionBuilder
* Swaps the top element of the stack with the next element down. Note
that this can cause problems if the top
* element on the stack
* is a long or double.
- *
- * @return
*/
@Opcodes("SWAP")
InstructionBuilder swap();
@@ -395,14 +385,14 @@ public interface InstructionBuilder
/**
* Stores the value on top of the stack to a local variable (previously
defined by
- * {@link #startVariable(String, String, InstructionBuilderCallback)}.
+ * {@link #startVariable(String, LocalVariableCallback)}.
*/
@Opcodes("ASTORE, ISTORE, LSTORE, FSTORE, DSTORE")
InstructionBuilder storeVariable(LocalVariable variable);
/**
- * Loads a value from a local variable and pushes it onto the stack. The
is defined by
- * {@link #startVariable(String, InstructionBuilderCallback)} and made
available via {@link LocalVariableCallback}.
+ * Loads a value from a local variable and pushes it onto the stack. The
variable is defined by
+ * {@link #startVariable(String, LocalVariableCallback)}.
*/
@Opcodes("ALOAD, ILOAD, LLOAD, FLOAD, DLOAD")
InstructionBuilder loadVariable(LocalVariable variable);
Modified:
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java
(original)
+++
tapestry/tapestry5/trunk/plastic/src/main/java/org/apache/tapestry5/plastic/PlasticField.java
Wed Jun 8 18:09:56 2011
@@ -17,8 +17,7 @@ package org.apache.tapestry5.plastic;
/**
* Represents a field of a class being {@linkplain PlasticClass transformed}.
* <p>
- * No methods of this object should be invoked after the class transformation
is
- * {@linkplain PlasticClass#createInstantiator() completed}.
+ * No methods of this object should be invoked after the class transformation
is completed.
*/
public interface PlasticField extends AnnotationAccess
{
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=1133494&r1=1133493&r2=1133494&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
Wed Jun 8 18:09:56 2011
@@ -25,7 +25,6 @@ import java.lang.annotation.RetentionPol
import java.lang.annotation.Target;
import org.apache.tapestry5.ioc.annotations.UseWith;
-import org.apache.tapestry5.runtime.Component;
import org.apache.tapestry5.services.javascript.JavaScriptStack;
import org.apache.tapestry5.services.javascript.JavaScriptSupport;
@@ -35,7 +34,8 @@ import org.apache.tapestry5.services.jav
* 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 Component#containingPageDidLoad()}
lifecycle method.
+ * Assets are localized during the {@link
org.apache.tapestry5.runtime.Component#containingPageDidLoad()} lifecycle
+ * method.
*
* @see JavaScriptSupport
* @since 5.2.0
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/test/TestableRequest.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/test/TestableRequest.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/test/TestableRequest.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/internal/test/TestableRequest.java
Wed Jun 8 18:09:56 2011
@@ -1,10 +1,10 @@
-// Copyright 2007, 2009 The Apache Software Foundation
+// Copyright 2007, 2009, 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
+// 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,
@@ -27,7 +27,7 @@ public interface TestableRequest extends
{
/**
* Clears the internal parameters map.
- *
+ *
* @return the request for further configuration
*/
TestableRequest clear();
@@ -35,7 +35,7 @@ public interface TestableRequest extends
/**
* Sets the path; the path should begin with a "/" character and contain
everything from there to the start of query
* parameters (if any).
- *
+ *
* @param path
* @return the request for further configuration
*/
@@ -43,14 +43,14 @@ public interface TestableRequest extends
/**
* Sets the locale requested by "the browser".
- *
- * @returns the request for further configuration
+ *
+ * @return the request for further configuration
*/
TestableRequest setLocale(Locale locale);
/**
* Loads a single parameter/value pair. This may define a new parameter,
or add a value to a list of parameters.
- *
+ *
* @return the request for further configuration
*/
TestableRequest loadParameter(String parameterName, String parameterValue);
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicTemplate.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicTemplate.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicTemplate.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/dynamic/DynamicTemplate.java
Wed Jun 8 18:09:56 2011
@@ -14,6 +14,7 @@
package org.apache.tapestry5.services.dynamic;
+import org.apache.tapestry5.corelib.components.Dynamic;
import org.apache.tapestry5.runtime.RenderCommand;
/**
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=1133494&r1=1133493&r2=1133494&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
Wed Jun 8 18:09:56 2011
@@ -43,7 +43,7 @@ public interface ComponentMessagesSource
* @param componentModel
* @param locale
* @return the message catalog for the component, in the indicated locale
- * @deprecated Deprecated in 5.3; use {@link #getMessages(ComponentModel,
ComponentResourceSelector) instead.
+ * @deprecated Deprecated in 5.3; use {@link #getMessages(ComponentModel,
ComponentResourceSelector)} instead.
*/
Messages getMessages(ComponentModel componentModel, Locale locale);
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/transform/ComponentClassTransformWorker2.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/transform/ComponentClassTransformWorker2.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/transform/ComponentClassTransformWorker2.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/transform/ComponentClassTransformWorker2.java
Wed Jun 8 18:09:56 2011
@@ -29,7 +29,7 @@ import org.apache.tapestry5.services.Com
* {@link ComponentClassTransformWorker} are type coerced into this type
automatically.
*
* @since 5.3.0
- * @see {@link PlasticClass}
+ * @see PlasticClass
*/
@UsesOrderedConfiguration(ComponentClassTransformWorker2.class)
public interface ComponentClassTransformWorker2
Modified:
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/FlowOperations.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/FlowOperations.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/FlowOperations.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-func/src/main/java/org/apache/tapestry5/func/FlowOperations.java
Wed Jun 8 18:09:56 2011
@@ -1,3 +1,17 @@
+// 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.func;
import java.util.Comparator;
@@ -55,7 +69,7 @@ public interface FlowOperations<T, FT> e
/**
* Returns the first element in the Flow. Returns null for empty flows,
but remember that null
- * is a valid element within a flow, so use {@link #isEmpty() to determine
if a flow is actually
+ * is a valid element within a flow, so use {@link #isEmpty()} to
determine if a flow is actually
* empty. The first element can be realized without realizing the full
Flow.
*/
T first();
Modified:
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
Wed Jun 8 18:09:56 2011
@@ -1,10 +1,10 @@
-// Copyright 2009 The Apache Software Foundation
+// Copyright 2009, 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
+// 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,
@@ -18,19 +18,18 @@ import org.apache.tapestry5.ioc.MethodAd
import org.slf4j.Logger;
/**
- * A service used in conjuction with a service advisor method to add logging
advice to a service.
- *
+ * A service used in conjunction with a service advisor method to add logging
advice to a service.
+ *
* @since 5.1.0.0
*/
public interface LoggingAdvisor
{
/**
* Adds logging advice to all methods of the object.
- *
- * @param logger log used for debug level logging messages
by the interceptor
+ *
+ * @param logger
+ * log used for debug level logging messages by the interceptor
* @param methodAdviceReceiver
- * @return a new object implementing the interface that can be used in
place of the delegate, providing logging
- * behavior around each method call on the service interface
*/
<T> void addLoggingAdvice(Logger logger, MethodAdviceReceiver
methodAdviceReceiver);
}
Modified:
tapestry/tapestry5/trunk/tapestry-json/src/main/java/org/apache/tapestry5/json/JSONArray.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-json/src/main/java/org/apache/tapestry5/json/JSONArray.java?rev=1133494&r1=1133493&r2=1133494&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-json/src/main/java/org/apache/tapestry5/json/JSONArray.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-json/src/main/java/org/apache/tapestry5/json/JSONArray.java
Wed Jun 8 18:09:56 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2010 The Apache Software Foundation
+// Copyright 2007, 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.
@@ -335,7 +335,7 @@ public final class JSONArray extends JSO
* @param value
* An object value. The value should be a Boolean, Double,
Integer, JSONArray, JSONObject, JSONLiteral,
* Long, or String, or the JSONObject.NULL singleton.
- * @return
+ * @return this array
*/
public JSONArray put(Object value)
{
@@ -357,7 +357,7 @@ public final class JSONArray extends JSO
* @param value
* The value to put into the array. The value should be a
Boolean, Double, Integer, JSONArray,
* JSONObject, JSONString, Long, or String, or the
JSONObject.NULL singeton.
- * @return
+ * @return this array
* @throws RuntimeException
* If the index is negative or if the the value is an invalid
number.
*/
