build: Bump build dependencies (#2291)

valfirst · web-flow · commit 29843c1450ae · 2025-05-23T16:06:35.000+03:00
* build: Bump Gradle from `8.9` to `8.14`

* build: Bump JaCoCo from `0.8.12` to `0.8.13`

* build: Bump Checkstyle from `10.17.0` to `10.23.1`

* fix: Fix Checkstyle violations in Javadocs

New Checkstyle versions introduced a number of improvements/fixes in Javadocs checks, that resulted in new violations reported.

* fix: Fix typo in Javadocs
diff --git a/build.gradle b/build.gradle
@@ -75,7 +75,7 @@ dependencyCheck {
 }
 
 jacoco {
-    toolVersion = '0.8.12'
+    toolVersion = '0.8.13'
 }
 
 tasks.withType(JacocoReport).configureEach {
@@ -91,7 +91,7 @@ jacocoTestReport.dependsOn test
 apply plugin: 'checkstyle'
 
 checkstyle {
-    toolVersion = '10.17.0'
+    toolVersion = '10.23.1'
     configFile = configDirectory.file('appium-style.xml').get().getAsFile()
     showViolations = true
     ignoreFailures = false
@@ -180,7 +180,7 @@ signing {
 }
 
 wrapper {
-    gradleVersion = '8.9'
+    gradleVersion = '8.14'
     distributionType = Wrapper.DistributionType.ALL
 }
 
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradlew b/gradlew
diff --git a/gradlew.bat b/gradlew.bat
diff --git a/src/e2eAndroidTest/java/io/appium/java_client/service/local/ServerBuilderTest.java b/src/e2eAndroidTest/java/io/appium/java_client/service/local/ServerBuilderTest.java
@@ -50,7 +50,7 @@ class ServerBuilderTest {
     private static final String PATH_TO_APPIUM_NODE_IN_PROPERTIES = getProperty(APPIUM_PATH);
 
     /**
-     * This is the path to the stub main.js file
+     * This is the path to the stub main.js file.
      */
     private static final Path PATH_T0_TEST_MAIN_JS = TestUtils.resourcePathToAbsolutePath("main.js");
 
diff --git a/src/main/java/io/appium/java_client/AppiumBy.java b/src/main/java/io/appium/java_client/AppiumBy.java
@@ -84,10 +84,10 @@ public static By androidDataMatcher(final String dataMatcherString) {
     }
 
     /**
-     * Refer to https://developer.android.com/training/testing/ui-automator
+     * Refer to <a href="https://developer.android.com/training/testing/ui-automator">UI Automator</a> .
      *
      * @param uiautomatorText is Android UIAutomator string
-     * @return an instance of {@link AppiumBy.ByAndroidUIAutomator}
+     * @return an instance of {@link ByAndroidUIAutomator}
      */
     public static By androidUIAutomator(final String uiautomatorText) {
         return new ByAndroidUIAutomator(uiautomatorText);
@@ -169,9 +169,9 @@ public static By custom(final String selector) {
      *                    as for OpenCV library.
      * @return an instance of {@link ByImage}
      * @see <a href="https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md">
-     * The documentation on Image Comparison Features</a>
+     *     The documentation on Image Comparison Features</a>
      * @see <a href="https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js">
-     * The settings available for lookup fine-tuning</a>
+     *     The settings available for lookup fine-tuning</a>
      * @since Appium 1.8.2
      */
     public static By image(final String b64Template) {
diff --git a/src/main/java/io/appium/java_client/android/nativekey/KeyEventMetaModifier.java b/src/main/java/io/appium/java_client/android/nativekey/KeyEventMetaModifier.java
@@ -23,103 +23,103 @@ public enum KeyEventMetaModifier {
      */
     SELECTING(0x800),
     /**
-     * <p>This mask is used to check whether one of the ALT meta keys is pressed.</p>
+     * This mask is used to check whether one of the ALT meta keys is pressed.
      *
      * @see AndroidKey#ALT_LEFT
      * @see AndroidKey#ALT_RIGHT
      */
     ALT_ON(0x02),
     /**
-     * <p>This mask is used to check whether the left ALT meta key is pressed.</p>
+     * This mask is used to check whether the left ALT meta key is pressed.
      *
      * @see AndroidKey#ALT_LEFT
      */
     ALT_LEFT_ON(0x10),
     /**
-     * <p>This mask is used to check whether the right the ALT meta key is pressed.</p>
+     * This mask is used to check whether the right the ALT meta key is pressed.
      *
      * @see AndroidKey#ALT_RIGHT
      */
     ALT_RIGHT_ON(0x20),
     /**
-     * <p>This mask is used to check whether one of the SHIFT meta keys is pressed.</p>
+     * This mask is used to check whether one of the SHIFT meta keys is pressed.
      *
      * @see AndroidKey#SHIFT_LEFT
      * @see AndroidKey#SHIFT_RIGHT
      */
     SHIFT_ON(0x1),
     /**
-     * <p>This mask is used to check whether the left SHIFT meta key is pressed.</p>
+     * This mask is used to check whether the left SHIFT meta key is pressed.
      *
      * @see AndroidKey#SHIFT_LEFT
      */
     SHIFT_LEFT_ON(0x40),
     /**
-     * <p>This mask is used to check whether the right SHIFT meta key is pressed.</p>
+     * This mask is used to check whether the right SHIFT meta key is pressed.
      *
      * @see AndroidKey#SHIFT_RIGHT
      */
     SHIFT_RIGHT_ON(0x80),
     /**
-     * <p>This mask is used to check whether the SYM meta key is pressed.</p>
+     * This mask is used to check whether the SYM meta key is pressed.
      */
     SYM_ON(0x4),
     /**
-     * <p>This mask is used to check whether the FUNCTION meta key is pressed.</p>
+     * This mask is used to check whether the FUNCTION meta key is pressed.
      */
     FUNCTION_ON(0x8),
     /**
-     * <p>This mask is used to check whether one of the CTRL meta keys is pressed.</p>
+     * This mask is used to check whether one of the CTRL meta keys is pressed.
      *
      * @see AndroidKey#CTRL_LEFT
      * @see AndroidKey#CTRL_RIGHT
      */
     CTRL_ON(0x1000),
     /**
-     * <p>This mask is used to check whether the left CTRL meta key is pressed.</p>
+     * This mask is used to check whether the left CTRL meta key is pressed.
      *
      * @see AndroidKey#CTRL_LEFT
      */
     CTRL_LEFT_ON(0x2000),
     /**
-     * <p>This mask is used to check whether the right CTRL meta key is pressed.</p>
+     * This mask is used to check whether the right CTRL meta key is pressed.
      *
      * @see AndroidKey#CTRL_RIGHT
      */
     CTRL_RIGHT_ON(0x4000),
     /**
-     * <p>This mask is used to check whether one of the META meta keys is pressed.</p>
+     * This mask is used to check whether one of the META meta keys is pressed.
      *
      * @see AndroidKey#META_LEFT
      * @see AndroidKey#META_RIGHT
      */
     META_ON(0x10000),
     /**
-     * <p>This mask is used to check whether the left META meta key is pressed.</p>
+     * This mask is used to check whether the left META meta key is pressed.
      *
      * @see AndroidKey#META_LEFT
      */
     META_LEFT_ON(0x20000),
     /**
-     * <p>This mask is used to check whether the right META meta key is pressed.</p>
+     * This mask is used to check whether the right META meta key is pressed.
      *
      * @see AndroidKey#META_RIGHT
      */
     META_RIGHT_ON(0x40000),
     /**
-     * <p>This mask is used to check whether the CAPS LOCK meta key is on.</p>
+     * This mask is used to check whether the CAPS LOCK meta key is on.
      *
      * @see AndroidKey#CAPS_LOCK
      */
     CAPS_LOCK_ON(0x100000),
     /**
-     * <p>This mask is used to check whether the NUM LOCK meta key is on.</p>
+     * This mask is used to check whether the NUM LOCK meta key is on.
      *
      * @see AndroidKey#NUM_LOCK
      */
     NUM_LOCK_ON(0x200000),
     /**
-     * <p>This mask is used to check whether the SCROLL LOCK meta key is on.</p>
+     * This mask is used to check whether the SCROLL LOCK meta key is on.
      *
      * @see AndroidKey#SCROLL_LOCK
      */
diff --git a/src/main/java/io/appium/java_client/android/options/EspressoOptions.java b/src/main/java/io/appium/java_client/android/options/EspressoOptions.java
@@ -101,7 +101,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/appium/appium-espresso-driver#capabilities
+ * Provides options specific to the Espresso Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/appium/appium-espresso-driver#capabilities">capabilities documentation</a></p>
  */
 public class EspressoOptions extends BaseOptions<EspressoOptions> implements
         // General options: https://github.com/appium/appium-uiautomator2-driver#general
diff --git a/src/main/java/io/appium/java_client/android/options/UiAutomator2Options.java b/src/main/java/io/appium/java_client/android/options/UiAutomator2Options.java
@@ -107,7 +107,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/appium/appium-uiautomator2-driver#capabilities
+ * Provides options specific to the UiAutomator2 Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/appium/appium-uiautomator2-driver#capabilities">capabilities documentation</a></p>
  */
 public class UiAutomator2Options extends BaseOptions<UiAutomator2Options> implements
         // General options: https://github.com/appium/appium-uiautomator2-driver#general
diff --git a/src/main/java/io/appium/java_client/chromium/ChromiumDriver.java b/src/main/java/io/appium/java_client/chromium/ChromiumDriver.java
@@ -29,10 +29,11 @@
 import java.net.URL;
 
 /**
- * <p>ChromiumDriver is an officially supported Appium driver created to automate Mobile browsers
+ * ChromiumDriver is an officially supported Appium driver created to automate Mobile browsers
  * and web views based on the Chromium engine. The driver uses W3CWebDriver protocol and is built
- * on top of chromium driver server.</p>
+ * on top of chromium driver server.
  * <br>
+ *
  * <p>Read <a href='https://github.com/appium/appium-chromium-driver'>appium-chromium-driver</a>
  * for more details on how to configure and use it.</p>
  */
diff --git a/src/main/java/io/appium/java_client/chromium/options/ChromiumOptions.java b/src/main/java/io/appium/java_client/chromium/options/ChromiumOptions.java
@@ -24,7 +24,7 @@
 import java.util.Map;
 
 /**
- * <p>Options class that sets options for Chromium when testing websites.</p>
+ * Options class that sets options for Chromium when testing websites.
  * <br>
  * @see <a href='https://github.com/appium/appium-chromium-driver#usage'>appium-chromium-driver usage section</a>
  */
diff --git a/src/main/java/io/appium/java_client/flutter/FlutterDriverOptions.java b/src/main/java/io/appium/java_client/flutter/FlutterDriverOptions.java
@@ -13,7 +13,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/AppiumTestDistribution/appium-flutter-integration-driver#capabilities-for-appium-flutter-integration-driver
+ * Provides options specific to the Appium Flutter Integration Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/AppiumTestDistribution/appium-flutter-integration-driver#capabilities-for-appium-flutter-integration-driver">capabilities documentation</a></p>
  */
 public class FlutterDriverOptions extends BaseOptions<FlutterDriverOptions> implements
         SupportsFlutterSystemPortOption<FlutterDriverOptions>,
diff --git a/src/main/java/io/appium/java_client/flutter/FlutterIntegrationTestDriver.java b/src/main/java/io/appium/java_client/flutter/FlutterIntegrationTestDriver.java
@@ -7,8 +7,8 @@
  * Flutter applications, extending WebDriver and providing additional capabilities for
  * interacting with Flutter-specific elements and behaviors.
  *
- * <p> This interface serves as a common entity for drivers that support Flutter applications
- * on different platforms, such as Android and iOS. </p>
+ * <p>This interface serves as a common entity for drivers that support Flutter applications
+ * on different platforms, such as Android and iOS.</p>
  *
  * @see WebDriver
  * @see SupportsGestureOnFlutterElements
diff --git a/src/main/java/io/appium/java_client/gecko/options/GeckoOptions.java b/src/main/java/io/appium/java_client/gecko/options/GeckoOptions.java
@@ -31,7 +31,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/appium/appium-geckodriver#usage
+ * Provides options specific to the Geckodriver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/appium/appium-geckodriver#capabilities">capabilities documentation</a></p>
  */
 public class GeckoOptions extends BaseOptions<GeckoOptions> implements
         SupportsBrowserNameOption<GeckoOptions>,
diff --git a/src/main/java/io/appium/java_client/ios/options/XCUITestOptions.java b/src/main/java/io/appium/java_client/ios/options/XCUITestOptions.java
@@ -119,7 +119,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/appium/appium-xcuitest-driver#capabilities
+ * Provides options specific to the XCUITest Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://appium.github.io/appium-xcuitest-driver/latest/reference/capabilities/">capabilities documentation</a></p>
  */
 public class XCUITestOptions extends BaseOptions<XCUITestOptions> implements
         // General options: https://github.com/appium/appium-xcuitest-driver#general
diff --git a/src/main/java/io/appium/java_client/mac/options/Mac2Options.java b/src/main/java/io/appium/java_client/mac/options/Mac2Options.java
@@ -27,7 +27,10 @@
 import java.util.Optional;
 
 /**
- * https://github.com/appium/appium-mac2-driver#capabilities
+ * Provides options specific to the Appium Mac2 Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/appium/appium-mac2-driver#capabilities">capabilities documentation</a></p>
  */
 public class Mac2Options extends BaseOptions<Mac2Options> implements
         SupportsSystemPortOption<Mac2Options>,
diff --git a/src/main/java/io/appium/java_client/safari/options/SafariOptions.java b/src/main/java/io/appium/java_client/safari/options/SafariOptions.java
@@ -31,7 +31,10 @@
 import java.util.Map;
 
 /**
- * https://github.com/appium/appium-safari-driver#usage
+ * Provides options specific to the Safari Driver.
+ *
+ * <p>For more details, refer to the
+ * <a href="https://github.com/appium/appium-safari-driver#usage">capabilities documentation</a></p>
  */
 public class SafariOptions extends BaseOptions<SafariOptions> implements
         SupportsBrowserNameOption<SafariOptions>,
diff --git a/src/main/java/io/appium/java_client/windows/options/WindowsOptions.java b/src/main/java/io/appium/java_client/windows/options/WindowsOptions.java
@@ -28,7 +28,7 @@
 import java.util.Optional;
 
 /**
- * <a href="https://github.com/appium/appium-windows-driver#usage">https://github.com/appium/appium-windows-driver#usage</a>
+ * <a href="https://github.com/appium/appium-windows-driver#usage">https://github.com/appium/appium-windows-driver#usage</a>.
  */
 public class WindowsOptions extends BaseOptions<WindowsOptions> implements
         SupportsAppOption<WindowsOptions>,

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ dependencyCheck {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`jacoco {`
`78`		`- toolVersion = '0.8.12'`
	`78`	`+ toolVersion = '0.8.13'`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`tasks.withType(JacocoReport).configureEach {`
`@@ -91,7 +91,7 @@ jacocoTestReport.dependsOn test`
`91`	`91`	`apply plugin: 'checkstyle'`
`92`	`92`
`93`	`93`	`checkstyle {`
`94`		`- toolVersion = '10.17.0'`
	`94`	`+ toolVersion = '10.23.1'`
`95`	`95`	`configFile = configDirectory.file('appium-style.xml').get().getAsFile()`
`96`	`96`	`showViolations = true`
`97`	`97`	`ignoreFailures = false`
`@@ -180,7 +180,7 @@ signing {`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`wrapper {`
`183`		`- gradleVersion = '8.9'`
	`183`	`+ gradleVersion = '8.14'`
`184`	`184`	`distributionType = Wrapper.DistributionType.ALL`
`185`	`185`	`}`
`186`	`186`