[java] Fixing JavaDocs for driver classes

SeleniumHQ · May 15, 2024 · 0e7bd2c · 0e7bd2c
1 parent 15319c0
commit 0e7bd2c
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 16 deletions.
diff --git a/java/src/org/openqa/selenium/chrome/ChromeDriverService.java b/java/src/org/openqa/selenium/chrome/ChromeDriverService.java
@@ -33,6 +33,7 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
+import org.openqa.selenium.remote.service.DriverFinder;
 import org.openqa.selenium.remote.service.DriverService;
 
 /** Manages the life and death of a ChromeDriver server. */
@@ -128,8 +129,8 @@ public Capabilities getDefaultDriverOptions() {
   /**
    * Configures and returns a new {@link ChromeDriverService} using the default configuration. In
    * this configuration, the service will use the ChromeDriver executable identified by {@link
-   * org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities)}. Each
-   * service created by this method will be configured to use a free port on the current system.
+   * DriverFinder#getDriverPath()} (DriverService, Capabilities)}. Each service created by this
+   * method will be configured to use a free port on the current system.
    *
    * @return A new ChromeDriverService using the default configuration.
    */

diff --git a/java/src/org/openqa/selenium/edge/EdgeDriverService.java b/java/src/org/openqa/selenium/edge/EdgeDriverService.java
@@ -31,6 +31,7 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
+import org.openqa.selenium.remote.service.DriverFinder;
 import org.openqa.selenium.remote.service.DriverService;
 
 /** Manages the life and death of the MSEdgeDriver */
@@ -117,8 +118,8 @@ public Capabilities getDefaultDriverOptions() {
   /**
    * Configures and returns a new {@link EdgeDriverService} using the default configuration. In this
    * configuration, the service will use the MSEdgeDriver executable identified by the {@link
-   * org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities)}. Each
-   * service created by this method will be configured to use a free port on the current system.
+   * DriverFinder#getDriverPath()} (DriverService, Capabilities)}. Each service created by this
+   * method will be configured to use a free port on the current system.
    *
    * @return A new EdgeDriverService using the default configuration.
    */

diff --git a/java/src/org/openqa/selenium/ie/InternetExplorerDriverService.java b/java/src/org/openqa/selenium/ie/InternetExplorerDriverService.java
@@ -31,6 +31,7 @@
 import java.util.Map;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.remote.service.DriverFinder;
 import org.openqa.selenium.remote.service.DriverService;
 
 /** Manages the life and death of an IEDriverServer. */
@@ -104,8 +105,7 @@ public Capabilities getDefaultDriverOptions() {
   /**
    * Configures and returns a new {@link InternetExplorerDriverService} using the default
    * configuration. In this configuration, the service will use the IEDriverServer executable
-   * identified by the {@link
-   * org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities)}. Each
+   * identified by the {@link DriverFinder#getDriverPath()} (DriverService, Capabilities)}. Each
    * service created by this method will be configured to use a free port on the current system.
    *
    * @return A new InternetExplorerDriverService using the default configuration.

diff --git a/java/src/org/openqa/selenium/remote/NoSuchDriverException.java b/java/src/org/openqa/selenium/remote/NoSuchDriverException.java
@@ -17,14 +17,10 @@
 
 package org.openqa.selenium.remote;
 
-import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
-import org.openqa.selenium.remote.service.DriverService;
+import org.openqa.selenium.remote.service.DriverFinder;
 
-/**
- * Thrown by {@link org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService,
- * Capabilities)}.
- */
+/** Thrown by {@link DriverFinder#getDriverPath()} (DriverService, Capabilities)}. */
 public class NoSuchDriverException extends WebDriverException {
 
   private static final String SUPPORT_URL = BASE_SUPPORT_URL + "/driver_location/";

diff --git a/java/src/org/openqa/selenium/safari/SafariDriverService.java b/java/src/org/openqa/selenium/safari/SafariDriverService.java
@@ -35,6 +35,7 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.net.PortProber;
+import org.openqa.selenium.remote.service.DriverFinder;
 import org.openqa.selenium.remote.service.DriverService;
 
 /** Manages the life and death of SafariDriver. */
@@ -95,8 +96,8 @@ protected Capabilities getDefaultDriverOptions() {
   /**
    * Configures and returns a new {@link SafariDriverService} using the default configuration. In
    * this configuration, the service will use the SafariDriver executable identified by the {@link
-   * org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities)}. Each
-   * service created by this method will be configured to use a free port on the current system.
+   * DriverFinder#getDriverPath()} (DriverService, Capabilities)}. Each service created by this
+   * method will be configured to use a free port on the current system.
    *
    * @return A new SafariDriverService using the default configuration.
    */

diff --git a/java/src/org/openqa/selenium/safari/SafariTechPreviewDriverService.java b/java/src/org/openqa/selenium/safari/SafariTechPreviewDriverService.java
@@ -35,6 +35,7 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.net.PortProber;
+import org.openqa.selenium.remote.service.DriverFinder;
 import org.openqa.selenium.remote.service.DriverService;
 
 /** Manages the life and death of SafariDriver Technology Preview. */
@@ -96,8 +97,7 @@ public Capabilities getDefaultDriverOptions() {
   /**
    * Configures and returns a new {@link SafariTechPreviewDriverService} using the default
    * configuration. In this configuration, the service will use the SafariDriver executable
-   * identified by the {@link
-   * org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities)}. Each
+   * identified by the {@link DriverFinder#getDriverPath()} (DriverService, Capabilities)}. Each
    * service created by this method will be configured to use a free port on the current system.
    *
    * @return A new SafariTechPreviewDriverService using the default configuration.