You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by bo...@apache.org on 2020/04/12 22:40:09 UTC
[tapestry-5] 01/03: Minor: fix some of the javadoc compiler warnings
This is an automated email from the ASF dual-hosted git repository.
bobharner pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tapestry-5.git
commit ce526313a651eef4a4dd3fa4db84a3145ffa16ca
Author: Bob Harner <bo...@gmail.com>
AuthorDate: Sat Nov 3 19:00:47 2018 -0400
Minor: fix some of the javadoc compiler warnings
---
.../main/java/org/apache/tapestry5/clojure/ClojureBuilder.java | 3 +--
.../main/java/org/apache/tapestry5/clojure/FunctionName.java | 2 +-
.../src/main/java/org/apache/tapestry5/clojure/Namespace.java | 2 +-
.../src/main/java/org/apache/tapestry5/ClientElement.java | 2 +-
tapestry-core/src/main/java/org/apache/tapestry5/Field.java | 3 ++-
.../tapestry5/corelib/base/AbstractComponentEventLink.java | 1 +
.../org/apache/tapestry5/corelib/base/AbstractTextField.java | 1 +
.../org/apache/tapestry5/corelib/base/BaseClientElement.java | 3 ++-
.../org/apache/tapestry5/services/ExceptionReportWriter.java | 4 ++++
.../tapestry5/ioc/internal/services/cron/CronExpression.java | 10 ++++++----
.../main/java/org/apache/tapestry5/javadoc/XDocStreamer.java | 5 ++++-
.../java/org/apache/tapestry5/json/modules/JSONModule.java | 1 +
12 files changed, 25 insertions(+), 12 deletions(-)
diff --git a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/ClojureBuilder.java b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/ClojureBuilder.java
index 02ac3a4..ba2ee4e 100644
--- a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/ClojureBuilder.java
+++ b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/ClojureBuilder.java
@@ -23,8 +23,7 @@ public interface ClojureBuilder
* Creates the proxy. Method names are converted to Clojure function names.
*
* @param interfaceType
- * type of interface, must have the {@link Namespace} annotation
- * @param <T>
+ * type of interface. Must have the {@link Namespace} annotation. Not null.
* @return the proxy
* @see MethodToFunctionSymbolMapper
*/
diff --git a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/FunctionName.java b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/FunctionName.java
index 0ad372c..715b669 100644
--- a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/FunctionName.java
+++ b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/FunctionName.java
@@ -34,7 +34,7 @@ import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.SERVICE;
public @interface FunctionName
{
/**
- * The name of the Clojure function to map the method to. This may be a simple name, in which case
+ * @return the name of the Clojure function to map the method to. This may be a simple name, in which case
* it will be a name within the {@link Namespace} of the service interface, or it may be a fully qualified name
* of an arbitrary Clojure function.
*/
diff --git a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/Namespace.java b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/Namespace.java
index 5f2e01d..c984ba1 100644
--- a/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/Namespace.java
+++ b/tapestry-clojure/src/main/java/org/apache/tapestry5/clojure/Namespace.java
@@ -35,7 +35,7 @@ import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.SERVICE;
public @interface Namespace
{
/**
- * The fully qualified namespace that will contain the functions to be exposed as methods.
+ * @return the fully qualified namespace that will contain the functions to be exposed as methods.
*/
String value();
}
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java b/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java
index 5556df4..feb17a4 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/ClientElement.java
@@ -27,7 +27,7 @@ import org.apache.tapestry5.services.javascript.JavaScriptSupport;
public interface ClientElement
{
/**
- * Returns a unique id for the element. This value will be unique for any given rendering of a page. This value is
+ * @return a unique id for the element. This value will be unique for any given rendering of a page. This value is
* intended for use as the id attribute of the client-side element, and will be used with any DHTML/Ajax related
* JavaScript.
*/
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/Field.java b/tapestry-core/src/main/java/org/apache/tapestry5/Field.java
index 0433492..1780aa6 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/Field.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/Field.java
@@ -24,7 +24,7 @@ package org.apache.tapestry5;
public interface Field extends ClientElement
{
/**
- * Returns the value used as the name attribute of the rendered element. This value will be unique within an
+ * @return the value used as the name attribute of the rendered element. This value will be unique within an
* enclosing form, even if the same component renders multiple times.
*
* @see org.apache.tapestry5.services.FormSupport#allocateControlName(String)
@@ -46,6 +46,7 @@ public interface Field extends ClientElement
* disabled field will ignore any value passed up in a form submit request. Care must be taken if the disabled
* status of a field can change between the time the field is rendered and the time the enclosing form is
* submitted.
+ * @return true if disabled, false otherwise
*/
boolean isDisabled();
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractComponentEventLink.java b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractComponentEventLink.java
index 1a2aeb4..9697fa4 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractComponentEventLink.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractComponentEventLink.java
@@ -82,6 +82,7 @@ public abstract class AbstractComponentEventLink extends AbstractLink
*
* @param eventContext
* the context as an object array, possibly null
+ * @return the link, not null
*/
protected abstract Link createLink(Object[] eventContext);
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractTextField.java b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractTextField.java
index 0ae4a09..ed3df46 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractTextField.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/AbstractTextField.java
@@ -204,6 +204,7 @@ public abstract class AbstractTextField extends AbstractField
/**
* Should blank input be ignored (after validation)? This will be true for
* {@link org.apache.tapestry5.corelib.components.PasswordField}.
+ * @return true if blank input should be ignored, false otherwise
*/
protected boolean ignoreBlankInput()
{
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/BaseClientElement.java b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/BaseClientElement.java
index 04da976..e0c9030 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/BaseClientElement.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/base/BaseClientElement.java
@@ -41,8 +41,9 @@ public abstract class BaseClientElement implements ClientElement
protected JavaScriptSupport javaScriptSupport;
/**
- * Invoked (usually from a {@link org.apache.tapestry5.annotations.BeginRender} phase method) to assigned
+ * Invoked (usually from a {@link org.apache.tapestry5.annotations.BeginRender} phase method) to assign
* the element, and clear the clientId (only relevant for components that render in a loop).
+ * @param the element to store
*/
protected void storeElement(Element element)
{
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReportWriter.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReportWriter.java
index 1f834b0..3fdcf30 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReportWriter.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ExceptionReportWriter.java
@@ -28,11 +28,15 @@ public interface ExceptionReportWriter
/**
* Analyzes the exception (using the {@link org.apache.tapestry5.ioc.services.ExceptionAnalyzer} service)
* and then writes the result to the writer.
+ * @param writer the PrintWriter to write to, not null
+ * @param exception the exception to look at, possibly null
*/
void writeReport(PrintWriter writer, Throwable exception);
/**
* Writes the analyzed exception to the writer.
+ * @param writer the PrintWriter to write to, not null
+ * @param exception the exception to look at, possibly null
*/
void writeReport(PrintWriter writer, ExceptionAnalysis exception);
}
diff --git a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/cron/CronExpression.java b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/cron/CronExpression.java
index 82a0bff..93d7764 100644
--- a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/cron/CronExpression.java
+++ b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/cron/CronExpression.java
@@ -344,6 +344,7 @@ public class CronExpression implements Serializable
/**
* Returns the time zone for which this <code>CronExpression</code>
* will be resolved.
+ * @return the time zone, not null
*/
public TimeZone getTimeZone()
{
@@ -358,6 +359,7 @@ public class CronExpression implements Serializable
/**
* Sets the time zone for which this <code>CronExpression</code>
* will be resolved.
+ * @param timeZone the time zone, or null
*/
public void setTimeZone(TimeZone timeZone)
{
@@ -365,8 +367,6 @@ public class CronExpression implements Serializable
}
/**
- * Returns the string representation of the <CODE>CronExpression</CODE>
- *
* @return a string representation of the <CODE>CronExpression</CODE>
*/
@Override
@@ -1667,8 +1667,8 @@ public class CronExpression implements Serializable
* Advance the calendar to the particular hour paying particular attention
* to daylight saving problems.
*
- * @param cal
- * @param hour
+ * @param cal the calendar to change
+ * @param hour the hour of day, 0..23, not null
*/
protected void setCalendarHour(Calendar cal, int hour)
{
@@ -1682,6 +1682,7 @@ public class CronExpression implements Serializable
/**
* NOT YET IMPLEMENTED: Returns the time before the given time
* that the <code>CronExpression</code> matches.
+ * @param endTime the ending time, or null
*/
public Date getTimeBefore(Date endTime)
{
@@ -1692,6 +1693,7 @@ public class CronExpression implements Serializable
/**
* NOT YET IMPLEMENTED: Returns the final time that the
* <code>CronExpression</code> will match.
+ * @return the final time, or null
*/
public Date getFinalFireTime()
{
diff --git a/tapestry-javadoc/src/main/java/org/apache/tapestry5/javadoc/XDocStreamer.java b/tapestry-javadoc/src/main/java/org/apache/tapestry5/javadoc/XDocStreamer.java
index d71c611..63ea599 100644
--- a/tapestry-javadoc/src/main/java/org/apache/tapestry5/javadoc/XDocStreamer.java
+++ b/tapestry-javadoc/src/main/java/org/apache/tapestry5/javadoc/XDocStreamer.java
@@ -300,7 +300,10 @@ public class XDocStreamer
}
- /** Parse the file and write its transformed content to the Writer. */
+ /**
+ * Parse the file and write its transformed content to the Writer.
+ * @throws SAXException if unable to parse the xdoc file
+ */
public void writeContent() throws SAXException
{
SaxHandler handler = new SaxHandler();
diff --git a/tapestry-json/src/main/java/org/apache/tapestry5/json/modules/JSONModule.java b/tapestry-json/src/main/java/org/apache/tapestry5/json/modules/JSONModule.java
index 6afe25b..38022a7 100644
--- a/tapestry-json/src/main/java/org/apache/tapestry5/json/modules/JSONModule.java
+++ b/tapestry-json/src/main/java/org/apache/tapestry5/json/modules/JSONModule.java
@@ -37,6 +37,7 @@ public class JSONModule
* <li>{@link String} to {@link org.apache.tapestry5.json.JSONObject}</li>
* <li>{@link String} to {@link org.apache.tapestry5.json.JSONArray}</li>
* </ul>
+ * @param configuration the configuration to provide the type coercer to
*/
@Contribute(TypeCoercer.class)
public static void provideCoercions(Configuration<CoercionTuple> configuration)