Skip to content

Commit 5fcb57f

Browse files
committed
docs: fix javadocs errors
1 parent ebb6c9e commit 5fcb57f

File tree

5 files changed

+44
-31
lines changed

5 files changed

+44
-31
lines changed

java/client/src/org/openqa/selenium/chrome/ChromeDriver.java

+11-12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
Copyright 2012 Selenium committers
3-
Copyright 2012 Software Freedom Conservancy
3+
Copyright 2012-2015 Software Freedom Conservancy
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -36,27 +36,26 @@
3636
* A {@link WebDriver} implementation that controls a Chrome browser running on the local machine.
3737
* This class is provided as a convenience for easily testing the Chrome browser. The control server
3838
* which each instance communicates with will live and die with the instance.
39-
*
40-
* <p/>
39+
*
4140
* To avoid unnecessarily restarting the ChromeDriver server with each instance, use a
4241
* {@link RemoteWebDriver} coupled with the desired {@link ChromeDriverService}, which is managed
4342
* separately. For example: <pre>{@code
44-
*
43+
*
4544
* import static org.junit.Assert.assertEquals;
46-
*
45+
*
4746
* import org.junit.*;
4847
* import org.junit.runner.RunWith;
4948
* import org.junit.runners.JUnit4;
5049
* import org.openqa.selenium.chrome.ChromeDriverService;
5150
* import org.openqa.selenium.remote.DesiredCapabilities;
5251
* import org.openqa.selenium.remote.RemoteWebDriver;
53-
*
52+
*
5453
* {@literal @RunWith(JUnit4.class)}
5554
* public class ChromeTest extends TestCase {
56-
*
55+
*
5756
* private static ChromeDriverService service;
5857
* private WebDriver driver;
59-
*
58+
*
6059
* {@literal @BeforeClass}
6160
* public static void createAndStartService() {
6261
* service = new ChromeDriverService.Builder()
@@ -65,23 +64,23 @@
6564
* .build();
6665
* service.start();
6766
* }
68-
*
67+
*
6968
* {@literal @AfterClass}
7069
* public static void createAndStopService() {
7170
* service.stop();
7271
* }
73-
*
72+
*
7473
* {@literal @Before}
7574
* public void createDriver() {
7675
* driver = new RemoteWebDriver(service.getUrl(),
7776
* DesiredCapabilities.chrome());
7877
* }
79-
*
78+
*
8079
* {@literal @After}
8180
* public void quitDriver() {
8281
* driver.quit();
8382
* }
84-
*
83+
*
8584
* {@literal @Test}
8685
* public void testGoogleSearch() {
8786
* driver.get("http://www.google.com");

java/client/src/org/openqa/selenium/lift/HamcrestWebDriverTestCase.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/*
2+
Copyright 2015 Software Freedom Conservancy
23
Copyright 2007-2009 Selenium committers
34
45
Licensed under the Apache License, Version 2.0 (the "License");
@@ -96,9 +97,8 @@ protected void type(String text, Finder<WebElement, WebDriver> inputFinder) {
9697
}
9798

9899
/**
99-
* Syntactic sugar to use with {@link org.openqa.selenium.lift.HamcrestWebDriverTestCase type(String, Finder<WebElement,
100-
* WebDriver>)}, e.g. type("cheese", into(textbox())); The into() method simply returns its
101-
* argument.
100+
* Syntactic sugar to use with {@link org.openqa.selenium.lift.HamcrestWebDriverTestCase},
101+
* e.g. type("cheese", into(textbox())); The into() method simply returns its argument.
102102
*/
103103
protected Finder<WebElement, WebDriver> into(Finder<WebElement, WebDriver> input) {
104104
return input;

java/client/src/org/openqa/selenium/net/NetworkInterfaceProvider.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/*
2+
Copyright 2015 Software Freedom Conservancy
23
Copyright 2007-2010 Selenium committers
34
45
Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +20,7 @@
1920

2021
/**
2122
* Provides information about the local network interfaces.
22-
* <p/>
23+
*
2324
* Basically an abstraction created to allow stubbing of java.net.NetworkInterface, also soothes
2425
* some of the jdk1.2 idioms from this interface into jdk1.5 idioms.
2526
*/

java/client/src/org/openqa/selenium/opera/OperaDriver.java

+11-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
Copyright 2014 Selenium committers
3-
Copyright 2014 Software Freedom Conservancy
3+
Copyright 2014-2015 Software Freedom Conservancy
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
1515
limitations under the License.
1616
*/
1717

18-
1918
package org.openqa.selenium.opera;
2019

2120
import org.openqa.selenium.Capabilities;
@@ -36,27 +35,26 @@
3635
* A {@link WebDriver} implementation that controls a Blink-based Opera browser running on the local
3736
* machine. This class is provided as a convenience for easily testing the Chrome browser. The
3837
* control server which each instance communicates with will live and die with the instance.
39-
*
40-
* <p/>
38+
*
4139
* To avoid unnecessarily restarting the OperaDriver server with each instance, use a
4240
* {@link RemoteWebDriver} coupled with the desired {@link OperaDriverService}, which is managed
4341
* separately. For example: <pre>{@code
44-
*
42+
*
4543
* import static org.junit.Assert.assertEquals;
46-
*
44+
*
4745
* import org.junit.*;
4846
* import org.junit.runner.RunWith;
4947
* import org.junit.runners.JUnit4;
5048
* import org.openqa.selenium.opera.OperaDriverService;
5149
* import org.openqa.selenium.remote.DesiredCapabilities;
5250
* import org.openqa.selenium.remote.RemoteWebDriver;
53-
*
51+
*
5452
* {@literal @RunWith(JUnit4.class)}
5553
* public class OperaTest extends TestCase {
56-
*
54+
*
5755
* private static OperaDriverService service;
5856
* private WebDriver driver;
59-
*
57+
*
6058
* {@literal @BeforeClass}
6159
* public static void createAndStartService() {
6260
* service = new OperaDriverService.Builder()
@@ -65,23 +63,23 @@
6563
* .build();
6664
* service.start();
6765
* }
68-
*
66+
*
6967
* {@literal @AfterClass}
7068
* public static void createAndStopService() {
7169
* service.stop();
7270
* }
73-
*
71+
*
7472
* {@literal @Before}
7573
* public void createDriver() {
7674
* driver = new RemoteWebDriver(service.getUrl(),
7775
* DesiredCapabilities.opera());
7876
* }
79-
*
77+
*
8078
* {@literal @After}
8179
* public void quitDriver() {
8280
* driver.quit();
8381
* }
84-
*
82+
*
8583
* {@literal @Test}
8684
* public void testGoogleSearch() {
8785
* driver.get("http://www.google.com");

java/client/src/org/openqa/selenium/remote/CommandInfo.java

+17-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1+
/*
2+
Copyright 2015 Software Freedom Conservancy
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
117
package org.openqa.selenium.remote;
218

319
import org.openqa.selenium.remote.http.HttpMethod;
420

521
public class CommandInfo {
6-
722
private final String url;
823
private final HttpMethod method;
924

1025
/**
11-
* @deprecated replaced by {@link org.openqa.selenium.remote.CommandInfo(String, HttpMethod)}.
26+
* @deprecated replaced by org.openqa.selenium.remote.CommandInfo(String, HttpMethod).
1227
*/
1328
@Deprecated
1429
public CommandInfo(String url, HttpVerb verb) {

0 commit comments

Comments
 (0)