This is an automated email from the ASF dual-hosted git repository.
benweidig pushed a commit to branch javax
in repository https://gitbox.apache.org/repos/asf/tapestry-5.git
The following commit(s) were added to refs/heads/javax by this push:
new f9382320b TAP5-2828: Javadoc min Java version, convention added, minor
fixes
f9382320b is described below
commit f9382320bb31decbf2f10dc42efb96a4fe8e9588
Author: Ben Weidig <[email protected]>
AuthorDate: Tue May 19 09:53:43 2026 +0200
TAP5-2828: Javadoc min Java version, convention added, minor fixes
---
build.gradle | 8 +-------
.../src/main/groovy/tapestry.java-convention.gradle | 3 ++-
.../main/groovy/tapestry.javadoc-convention.gradle | 19 +++++++++++++++++++
settings.gradle | 6 +++++-
.../javascript/EsModuleManagerContribution.java | 13 ++++++-------
.../services/ComponentEventDispatcherTest.java | 2 +-
.../org/apache/tapestry5/test/SeleniumTestCase.java | 4 ++--
7 files changed, 36 insertions(+), 19 deletions(-)
diff --git a/build.gradle b/build.gradle
index b32c83b33..a6a36661e 100755
--- a/build.gradle
+++ b/build.gradle
@@ -4,6 +4,7 @@ import org.apache.tools.ant.filters.ReplaceTokens
plugins {
id 'base'
id 'maven-publish'
+ id 'tapestry.javadoc-convention'
}
description = 'Apache Tapestry 5 Project'
@@ -268,19 +269,12 @@ tasks.register('aggregateJavadoc', Javadoc) {
docTitle "Tapestry API - (${project.version})"
bottom "${project.version} - Copyright © 2003-${thisYear} <a
href=\"http://tapestry.apache.org/\";>The Apache Software Foundation</a>."
setUse(use)
- links 'https://docs.oracle.com/javase/8/docs/api/'
-
tagletPath Collections.unmodifiableList(new ArrayList<>((Set)
configurations.javadoc.files))
// Uncomment jFlags to debug `./gradlew aggregateJavadoc`
// jFlags '-Xdebug',
'-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005'
addStringOption '-source-path',
files(allMainJavaSrcDirs.flatten()).asPath
- addStringOption 'source', '8'
taglets 'org.apache.tapestry5.javadoc.TapestryDocTaglet'
-
- // Javadoc became stricer, so lets do this to actually build for now
- addBooleanOption('html5', true)
- addStringOption('Xdoclint:none', '-quiet')
}
// As part of generating the documentation, ALSO copy any related files:
diff --git a/buildSrc/src/main/groovy/tapestry.java-convention.gradle
b/buildSrc/src/main/groovy/tapestry.java-convention.gradle
index 6787f2a5b..c36eceb56 100644
--- a/buildSrc/src/main/groovy/tapestry.java-convention.gradle
+++ b/buildSrc/src/main/groovy/tapestry.java-convention.gradle
@@ -1,5 +1,5 @@
// Base convention applied to every subproject in root build.gradle via
`subprojects {}`
-// - Java 11 source/target compatibility
+// - Java 8 source/target compatibility
// - 'provided' configuration (compile-only scope, like Maven
<scope>provided</scope>)
// - Dependency version constraints to keep the classpath consistent across
modules
// - JAR manifest: Automatic-Module-Name for JPMS, LICENSE/NOTICE in META-INF
@@ -9,6 +9,7 @@ plugins {
id 'eclipse'
id 'idea'
id 'groovy'
+ id 'tapestry.javadoc-convention'
}
java {
diff --git a/buildSrc/src/main/groovy/tapestry.javadoc-convention.gradle
b/buildSrc/src/main/groovy/tapestry.javadoc-convention.gradle
new file mode 100644
index 000000000..b079a8f68
--- /dev/null
+++ b/buildSrc/src/main/groovy/tapestry.javadoc-convention.gradle
@@ -0,0 +1,19 @@
+// Javadoc convention applied to all subprojects (via
tapestry.java-convention)
+// and to the root project's aggregateJavadoc task.
+// - HTML5 output
+// - Java 8 source parsing
+// - JDK API cross-links
+// - suppress unresolvable cross-module {@link} references
+// - declare @tapestrydoc so per-module builds don't treat it as an unknown
tag
+
+plugins {
+ id 'java-base'
+}
+
+tasks.withType(Javadoc).configureEach {
+ options.addStringOption('Xdoclint:all,-reference', '-quiet')
+ options.addStringOption('source', '8')
+ options.addBooleanOption('html5', true)
+ options.links('https://docs.oracle.com/javase/8/docs/api/')
+ options.tags = ['tapestrydoc:a:Component Documentation']
+}
diff --git a/settings.gradle b/settings.gradle
index 8cc1fe715..63a7eb9db 100644
--- a/settings.gradle
+++ b/settings.gradle
@@ -59,12 +59,16 @@ include('plastic',
'tapestry-openapi-viewer',
'tapestry-rest-jackson')
+if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_11)) {
+ include('tapestry-javadoc')
+}
+
if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_17)) {
include('tapestry-spring')
}
if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)) {
- include('tapestry-javadoc', 'tapestry-latest-java-tests')
+ include('tapestry-latest-java-tests')
}
def isTravisCI = System.getenv('TRAVIS_JOB_ID') != null
diff --git
a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/EsModuleManagerContribution.java
b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/EsModuleManagerContribution.java
index 6997f6c68..60e64c490 100644
---
a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/EsModuleManagerContribution.java
+++
b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/EsModuleManagerContribution.java
@@ -65,7 +65,7 @@ public final class EsModuleManagerContribution
* one module and its URL.
* @param id the module id.
* @param url the module URL.
- * @see EsModuleConfigurationCallback#create(String, String).
+ * @see EsModuleConfigurationCallback#create(String, String)
*/
public static EsModuleManagerContribution base(String id, String url)
{
@@ -82,7 +82,7 @@ public final class EsModuleManagerContribution
{
return new EsModuleManagerContribution(callback, false);
}
-
+
/**
* Contributes a base contribution which sets or overrides
* one module and its URL.
@@ -98,20 +98,20 @@ public final class EsModuleManagerContribution
{
configuration.add(id, base(id, url));
}
-
+
/**
* Creates a global per-request contribution which sets or overrides
* one module and its URL.
* @param id the module id.
* @param url the module URL.
- * @see EsModuleConfigurationCallback#create(String, String).
+ * @see EsModuleConfigurationCallback#create(String, String)
*/
public static EsModuleManagerContribution globalPerRequest(String id,
String url)
{
return new EsModuleManagerContribution(
EsModuleConfigurationCallback.create(id, url), false);
}
-
+
/**
* Contributes a global per-thread contribution which sets or overrides
* one module and its URL.
@@ -127,5 +127,4 @@ public final class EsModuleManagerContribution
{
configuration.add(id, globalPerRequest(id, url));
}
-
-}
\ No newline at end of file
+}
diff --git
a/tapestry-core/src/test/java/org/apache/tapestry5/internal/services/ComponentEventDispatcherTest.java
b/tapestry-core/src/test/java/org/apache/tapestry5/internal/services/ComponentEventDispatcherTest.java
index 60418b59b..1a59e93fa 100644
---
a/tapestry-core/src/test/java/org/apache/tapestry5/internal/services/ComponentEventDispatcherTest.java
+++
b/tapestry-core/src/test/java/org/apache/tapestry5/internal/services/ComponentEventDispatcherTest.java
@@ -78,7 +78,7 @@ public class ComponentEventDispatcherTest extends
InternalBaseTestCase
}
/**
- * @see {@link https://issues.apache.org/jira/browse/TAPESTRY-1949}
+ * @see <a
href="https://issues.apache.org/jira/browse/TAPESTRY-1949";>TAPESTRY-1949</a>
*/
@Test
public void event_on_page_with_name_and_dotted_parameters() throws
Exception
diff --git
a/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
b/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
index 601423725..84884abfa 100644
---
a/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
+++
b/tapestry-test/src/main/java/org/apache/tapestry5/test/SeleniumTestCase.java
@@ -73,14 +73,14 @@ public abstract class SeleniumTestCase extends Assert
implements Selenium
/**
* Default: 15 seconds
*
- * @see {@link TapestryTestConstants#PAGE_LOAD_TIMEOUT_PARAMETER}
+ * @see TapestryTestConstants#PAGE_LOAD_TIMEOUT_PARAMETER
*/
public static final String PAGE_LOAD_TIMEOUT = "15000";
/**
* Default: 15 seconds
*
- * @see {@link TapestryTestConstants#WEBDRIVER_WAIT_TIMEOUT_PARAMETER}
+ * @see TapestryTestConstants#WEBDRIVER_WAIT_TIMEOUT_PARAMETER
* @since 5.10
*/
public static final long WEBDRIVER_WAIT_TIMEOUT = 15L;
