You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by be...@apache.org on 2025/06/10 06:41:20 UTC
(tapestry-5) 02/02: TAP5-2809: Fix Javadoc warnings
This is an automated email from the ASF dual-hosted git repository.
benw pushed a commit to branch gradle-improvements
in repository https://gitbox.apache.org/repos/asf/tapestry-5.git
commit ebb298eea08e8ad0566fb976ccf1c848b9a28894
Author: Ben Weidig <be...@netzgut.net>
AuthorDate: Tue Jun 10 08:41:07 2025 +0200
TAP5-2809: Fix Javadoc warnings
---
.../internal/services/DocumentLinker.java | 11 ++++++++--
.../services/ajax/AjaxFormUpdateController.java | 2 ++
.../services/ComponentEventRequestFilter.java | 1 +
.../services/ajax/AjaxResponseRenderer.java | 4 +++-
.../services/javascript/JavaScriptStack.java | 7 +++++++
.../services/javascript/JavaScriptSupport.java | 6 ++++++
.../http/internal/services/DefaultCorsHandler.java | 2 +-
.../ValidatingOrderedConfigurationWrapper.java | 2 --
.../ioc/internal/services/cron/CronExpression.java | 24 +++++++++++-----------
.../services/ObjectMapperSource.java | 5 +++--
10 files changed, 44 insertions(+), 20 deletions(-)
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
index 9326f12f0..aefcb3bae 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
@@ -34,6 +34,8 @@ public interface DocumentLinker
* the core libraries have loaded and initialized. Thus difference between core libraries and other libraries
* is new in 5.4, and represents a conflict between asynchronous loading of modules (introduced in 5.4) and
* sequential loading of libraries (in 5.3 and earlier).
+ *
+ * @param libraryURL non-core JavaScript library to add. It cannot be null.
*/
void addLibrary(String libraryURL);
@@ -42,17 +44,20 @@ public interface DocumentLinker
* and is used to bootstrap up to adding non-core libraries.
*
* @since 5.4
+ * @param libraryURL core JavaScript library to add. It cannot be null.
*/
void addCoreLibrary(String libraryURL);
/**
* Adds a link to load a CSS stylesheet.
+ *
+ * @param stylesheet {@link StylesheetLink} to add. It cannot be null.
*/
void addStylesheetLink(StylesheetLink stylesheet);
/**
* Adds a module configuration callback for this request.
- *
+ *
* @param callback a {@link ModuleConfigurationCallback}. It cannot be null.
* @since 5.4
*/
@@ -60,7 +65,7 @@ public interface DocumentLinker
/**
* Adds an ES module configuration callback for this request.
- *
+ *
* @param callback a {@link EsModuleConfigurationCallback}. It cannot be null.
* @since 5.10.0
*/
@@ -101,6 +106,8 @@ public interface DocumentLinker
/**
* Adds ES module initialization.
+ *
+ * @param initialization a {@link EsModuleInitialization} to configure details of the ES module import. It cannot be null.
* @since 5.10.0
*/
void addEsModuleInitialization(EsModuleInitialization initialization);
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ajax/AjaxFormUpdateController.java b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ajax/AjaxFormUpdateController.java
index 0e408c28a..deb599188 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ajax/AjaxFormUpdateController.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/ajax/AjaxFormUpdateController.java
@@ -35,6 +35,8 @@ public interface AjaxFormUpdateController
* Called before starting to render a zone's content; initializes
* the {@link FormSupport} and {@link ValidationTracker} environmentals
* and starts a heartbeat.
+ *
+ * @param writer to write markup to
*/
void setupBeforePartialZoneRender(MarkupWriter writer);
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestFilter.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestFilter.java
index dd3266ef9..e1bb41a1e 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestFilter.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ComponentEventRequestFilter.java
@@ -26,6 +26,7 @@ public interface ComponentEventRequestFilter
*
* @param parameters defining details of the request
* @param handler to delegate to
+ * @throws IOException
*/
void handle(ComponentEventRequestParameters parameters, ComponentEventRequestHandler handler) throws IOException;
}
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java
index af63592d0..557d22ea4 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/ajax/AjaxResponseRenderer.java
@@ -72,6 +72,8 @@ public interface AjaxResponseRenderer
* Adds a rendering filter. Dynamically added filters are only in place during the handling of the current request, and come after any filters
* contributed to the {@link org.apache.tapestry5.services.PartialMarkupRenderer} service.
*
+ * @param filter
+ * a partial markup filter
* @return this renderer, for a fluid interface
*/
AjaxResponseRenderer addFilter(PartialMarkupRendererFilter filter);
@@ -81,7 +83,7 @@ public interface AjaxResponseRenderer
* the callback is invoked before the rest of the rendering pipeline is invoked.
*
* @param callback
- * object o be invoked
+ * object to be invoked
* @return this renderer, for a fluid interface
*/
AjaxResponseRenderer addCallback(JSONCallback callback);
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptStack.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptStack.java
index 777c7a118..ed11aaab4 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptStack.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptStack.java
@@ -49,11 +49,15 @@ public interface JavaScriptStack
* Returns a list of JavaScriptStack names that this stack depends on. Each stack will be processed before
* the current stack (thus a dependency stack's libraries, stylesheets and initialization is emitted before
* the dependent stack).
+ *
+ * @return list of JavaScriptStack dependency names
*/
List<String> getStacks();
/**
* Returns a list of <em>localized</em> assets for JavaScript libraries that form the stack.
+ *
+ * @return list of {@link Asset} this JavaScriptStack if formed of
*/
List<Asset> getJavaScriptLibraries();
@@ -69,6 +73,7 @@ public interface JavaScriptStack
*
* @see ModuleManager
* @see org.apache.tapestry5.SymbolConstants#COMBINE_SCRIPTS
+ * @return list of included modules
* @since 5.4
*/
List<String> getModules();
@@ -77,6 +82,7 @@ public interface JavaScriptStack
* Identifies how to aggregate JavaScript within the stack.
* The default is {@link org.apache.tapestry5.services.javascript.JavaScriptAggregationStrategy#COMBINE_AND_MINIMIZE}.
*
+ * @return how the stack is aggregated
* @since 5.4
*/
JavaScriptAggregationStrategy getJavaScriptAggregationStrategy();
@@ -89,6 +95,7 @@ public interface JavaScriptStack
*
* @deprecated Deprecated in Tapestry 5.4; may be removed in a future release. Implementations
* may return null.
+ * @return how the stack is aggregated
*/
String getInitialization();
}
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java
index 7624497b0..35be83b4e 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/JavaScriptSupport.java
@@ -120,6 +120,8 @@ public interface JavaScriptSupport
* method are aggregated into a call to the Tapestry.init() function. Initialization occurs at
* {@link InitializationPriority#NORMAL} 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
@@ -178,6 +180,7 @@ public interface JavaScriptSupport
* (whereas modules may be loaded in parallel), and all libraries are added before any modules are loaded.
* Because of this, it is preferrable to organize your JavaScript into modules, rather than libraries.
*
+ * @param asset JavaScript library to import
* @return this JavaScriptSupport, for further configuration
* @see org.apache.tapestry5.annotations.Import
*/
@@ -224,6 +227,8 @@ public interface JavaScriptSupport
* Import a Javascript library with an arbitrary URL.
*
* Please refer to the {@linkplain #importJavaScriptLibrary(Asset) notes about libraries vs. modules}.
+ * @param libraryURL JavaScript library to import
+ * @return this JavaScriptSupport, for further configuration
*/
JavaScriptSupport importJavaScriptLibrary(String libraryURL);
@@ -237,6 +242,7 @@ public interface JavaScriptSupport
* focus is set only if the provided priority is greater than the current priority
* @param fieldId
* id of client-side element to take focus
+ * @return this JavaScriptSupport, for further configuration
*/
JavaScriptSupport autofocus(FieldFocusPriority priority, String fieldId);
diff --git a/tapestry-http/src/main/java/org/apache/tapestry5/http/internal/services/DefaultCorsHandler.java b/tapestry-http/src/main/java/org/apache/tapestry5/http/internal/services/DefaultCorsHandler.java
index fed6d529f..1cfe05e9d 100644
--- a/tapestry-http/src/main/java/org/apache/tapestry5/http/internal/services/DefaultCorsHandler.java
+++ b/tapestry-http/src/main/java/org/apache/tapestry5/http/internal/services/DefaultCorsHandler.java
@@ -27,7 +27,7 @@ import org.apache.tapestry5.http.services.CorsHandlerHelper;
* regardless of path. It will also perform preflight requests if
* {@link CorsHandlerHelper#isPreflight(HttpServletRequest)}
* returns <code>true</code>. Most logic is delegated is {@link CorsHandlerHelper}.
- * <p>
+ * </p>
* <p>
* This implementation is inspired by the cors NPM module.
* </p>
diff --git a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/ValidatingOrderedConfigurationWrapper.java b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/ValidatingOrderedConfigurationWrapper.java
index 046eb7a40..7a6cbc1b1 100644
--- a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/ValidatingOrderedConfigurationWrapper.java
+++ b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/ValidatingOrderedConfigurationWrapper.java
@@ -25,8 +25,6 @@ import java.util.Map;
/**
* Wraps a {@link java.util.List} as a {@link org.apache.tapestry5.commons.OrderedConfiguration}, implementing validation of
* values provided to an {@link org.apache.tapestry5.commons.OrderedConfiguration}.
- *
- * @param <T>
*/
public class ValidatingOrderedConfigurationWrapper<T> extends AbstractConfigurationImpl<T> implements
OrderedConfiguration<T>
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 77630245c..ccf368127 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
@@ -21,7 +21,7 @@ import java.util.*;
* expressions provide the ability to specify complex time combinations such as
* "At 8:00am every Monday through Friday" or "At 1:30am every
* last Friday of the month".
- * <P>
+ * <p>
* Cron expressions are comprised of 6 required fields and one optional field
* separated by white space. The fields respectively are described as follows:
*
@@ -84,21 +84,21 @@ import java.util.*;
* <td style="text-align: left;"><code>, - * /</code></td>
* </tr>
* </table>
- * <P>
+ * <p>
* The '*' character is used to specify all values. For example, "*"
* in the minute field means "every minute".
- * <P>
+ * <p>
* The '?' character is allowed for the day-of-month and day-of-week fields. It
* is used to specify 'no specific value'. This is useful when you need to
* specify something in one of the two fields, but not the other.
- * <P>
+ * <p>
* The '-' character is used to specify ranges For example "10-12" in
* the hour field means "the hours 10, 11 and 12".
- * <P>
+ * <p>
* The ',' character is used to specify additional values. For example
* "MON,WED,FRI" in the day-of-week field means "the days Monday,
* Wednesday, and Friday".
- * <P>
+ * <p>
* The '/' character is used to specify increments. For example "0/15"
* in the seconds field means "the seconds 0, 15, 30, and 45". And
* "5/15" in the seconds field means "the seconds 5, 20, 35, and
@@ -110,7 +110,7 @@ import java.util.*;
* on every "nth" value in the given set. Thus "7/6" in the
* month field only turns on month "7", it does NOT mean every 6th
* month, please note that subtlety.
- * <P>
+ * <p>
* The 'L' character is allowed for the day-of-month and day-of-week fields.
* This character is short-hand for "last", but it has different
* meaning in each of the two fields. For example, the value "L" in
@@ -123,7 +123,7 @@ import java.util.*;
* from the last day of the month, such as "L-3" which would mean the third-to-last
* day of the calendar month. <i>When using the 'L' option, it is important not to
* specify lists, or ranges of values, as you'll get confusing/unexpected results.</i>
- * <P>
+ * <p>
* The 'W' character is allowed for the day-of-month field. This character
* is used to specify the weekday (Monday-Friday) nearest the given day. As an
* example, if you were to specify "15W" as the value for the
@@ -135,11 +135,11 @@ import java.util.*;
* 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not
* 'jump' over the boundary of a month's days. The 'W' character can only be
* specified when the day-of-month is a single day, not a range or list of days.
- * <P>
+ * <p>
* The 'L' and 'W' characters can also be combined for the day-of-month
* expression to yield 'LW', which translates to "last weekday of the
* month".
- * <P>
+ * <p>
* The '#' character is allowed for the day-of-week field. This character is
* used to specify "the nth" XXX day of the month. For example, the
* value of "6#3" in the day-of-week field means the third Friday of
@@ -150,7 +150,7 @@ import java.util.*;
* no firing will occur that month. If the '#' character is used, there can
* only be one expression in the day-of-week field ("3#1,6#3" is
* not valid, since there are two expressions).
- * <P>
+ * <p>
* <!--The 'C' character is allowed for the day-of-month and day-of-week fields.
* This character is short-hand for "calendar". This means values are
* calculated against the associated calendar, if any. If no calendar is
@@ -158,7 +158,7 @@ import java.util.*;
* value of "5C" in the day-of-month field means "the first day included by the
* calendar on or after the 5th". A value of "1C" in the day-of-week field
* means "the first day included by the calendar on or after Sunday".-->
- * <P>
+ * <p>
* The legal characters and the names of months and days of the week are not
* case sensitive.
*
diff --git a/tapestry-rest-jackson/src/main/java/org/apache/tapestry5/jacksondatabind/services/ObjectMapperSource.java b/tapestry-rest-jackson/src/main/java/org/apache/tapestry5/jacksondatabind/services/ObjectMapperSource.java
index ea81ca35b..f1cb6caca 100644
--- a/tapestry-rest-jackson/src/main/java/org/apache/tapestry5/jacksondatabind/services/ObjectMapperSource.java
+++ b/tapestry-rest-jackson/src/main/java/org/apache/tapestry5/jacksondatabind/services/ObjectMapperSource.java
@@ -19,12 +19,13 @@ import com.fasterxml.jackson.databind.ObjectMapper;
/**
* <p>
* Service that provides {@link ObjectMapper} instances for specific mapped entity classes.
+ * </p>
* <p>
- * <p>
- * It's defined as an ordered configuration of {@link ObjectMapperSource} instances.
+ * It's defined as an ordered configuration of {@link ObjectMapperSource} instances.
* Calls to {@link #get(Class)} will call the same method in contributed instances until
* one returns a non-null {@link ObjectMapper} instance.
* </p>
+ *
* @see ObjectMapper
* @see MappedEntityManager
* @since 5.8.0