Skip to content

Commit

Permalink
docs: fix javadocs errors
Browse files Browse the repository at this point in the history
  • Loading branch information
andreastt committed Mar 2, 2015
1 parent ebb6c9e commit 5fcb57f
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 31 deletions.
23 changes: 11 additions & 12 deletions java/client/src/org/openqa/selenium/chrome/ChromeDriver.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Copyright 2012 Selenium committers
Copyright 2012 Software Freedom Conservancy
Copyright 2012-2015 Software Freedom Conservancy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -36,27 +36,26 @@
* A {@link WebDriver} implementation that controls a Chrome browser running on the local machine.
* This class is provided as a convenience for easily testing the Chrome browser. The control server
* which each instance communicates with will live and die with the instance.
*
* <p/>
*
* To avoid unnecessarily restarting the ChromeDriver server with each instance, use a
* {@link RemoteWebDriver} coupled with the desired {@link ChromeDriverService}, which is managed
* separately. For example: <pre>{@code
*
*
* import static org.junit.Assert.assertEquals;
*
*
* import org.junit.*;
* import org.junit.runner.RunWith;
* import org.junit.runners.JUnit4;
* import org.openqa.selenium.chrome.ChromeDriverService;
* import org.openqa.selenium.remote.DesiredCapabilities;
* import org.openqa.selenium.remote.RemoteWebDriver;
*
*
* {@literal @RunWith(JUnit4.class)}
* public class ChromeTest extends TestCase {
*
*
* private static ChromeDriverService service;
* private WebDriver driver;
*
*
* {@literal @BeforeClass}
* public static void createAndStartService() {
* service = new ChromeDriverService.Builder()
Expand All @@ -65,23 +64,23 @@
* .build();
* service.start();
* }
*
*
* {@literal @AfterClass}
* public static void createAndStopService() {
* service.stop();
* }
*
*
* {@literal @Before}
* public void createDriver() {
* driver = new RemoteWebDriver(service.getUrl(),
* DesiredCapabilities.chrome());
* }
*
*
* {@literal @After}
* public void quitDriver() {
* driver.quit();
* }
*
*
* {@literal @Test}
* public void testGoogleSearch() {
* driver.get("http://www.google.com");
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*
Copyright 2015 Software Freedom Conservancy
Copyright 2007-2009 Selenium committers
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -96,9 +97,8 @@ protected void type(String text, Finder<WebElement, WebDriver> inputFinder) {
}

/**
* Syntactic sugar to use with {@link org.openqa.selenium.lift.HamcrestWebDriverTestCase type(String, Finder<WebElement,
* WebDriver>)}, e.g. type("cheese", into(textbox())); The into() method simply returns its
* argument.
* Syntactic sugar to use with {@link org.openqa.selenium.lift.HamcrestWebDriverTestCase},
* e.g. type("cheese", into(textbox())); The into() method simply returns its argument.
*/
protected Finder<WebElement, WebDriver> into(Finder<WebElement, WebDriver> input) {
return input;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*
Copyright 2015 Software Freedom Conservancy
Copyright 2007-2010 Selenium committers
Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -19,7 +20,7 @@

/**
* Provides information about the local network interfaces.
* <p/>
*
* Basically an abstraction created to allow stubbing of java.net.NetworkInterface, also soothes
* some of the jdk1.2 idioms from this interface into jdk1.5 idioms.
*/
Expand Down
24 changes: 11 additions & 13 deletions java/client/src/org/openqa/selenium/opera/OperaDriver.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Copyright 2014 Selenium committers
Copyright 2014 Software Freedom Conservancy
Copyright 2014-2015 Software Freedom Conservancy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -15,7 +15,6 @@
limitations under the License.
*/


package org.openqa.selenium.opera;

import org.openqa.selenium.Capabilities;
Expand All @@ -36,27 +35,26 @@
* A {@link WebDriver} implementation that controls a Blink-based Opera browser running on the local
* machine. This class is provided as a convenience for easily testing the Chrome browser. The
* control server which each instance communicates with will live and die with the instance.
*
* <p/>
*
* To avoid unnecessarily restarting the OperaDriver server with each instance, use a
* {@link RemoteWebDriver} coupled with the desired {@link OperaDriverService}, which is managed
* separately. For example: <pre>{@code
*
*
* import static org.junit.Assert.assertEquals;
*
*
* import org.junit.*;
* import org.junit.runner.RunWith;
* import org.junit.runners.JUnit4;
* import org.openqa.selenium.opera.OperaDriverService;
* import org.openqa.selenium.remote.DesiredCapabilities;
* import org.openqa.selenium.remote.RemoteWebDriver;
*
*
* {@literal @RunWith(JUnit4.class)}
* public class OperaTest extends TestCase {
*
*
* private static OperaDriverService service;
* private WebDriver driver;
*
*
* {@literal @BeforeClass}
* public static void createAndStartService() {
* service = new OperaDriverService.Builder()
Expand All @@ -65,23 +63,23 @@
* .build();
* service.start();
* }
*
*
* {@literal @AfterClass}
* public static void createAndStopService() {
* service.stop();
* }
*
*
* {@literal @Before}
* public void createDriver() {
* driver = new RemoteWebDriver(service.getUrl(),
* DesiredCapabilities.opera());
* }
*
*
* {@literal @After}
* public void quitDriver() {
* driver.quit();
* }
*
*
* {@literal @Test}
* public void testGoogleSearch() {
* driver.get("http://www.google.com");
Expand Down
19 changes: 17 additions & 2 deletions java/client/src/org/openqa/selenium/remote/CommandInfo.java
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
/*
Copyright 2015 Software Freedom Conservancy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package org.openqa.selenium.remote;

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

public class CommandInfo {

private final String url;
private final HttpMethod method;

/**
* @deprecated replaced by {@link org.openqa.selenium.remote.CommandInfo(String, HttpMethod)}.
* @deprecated replaced by org.openqa.selenium.remote.CommandInfo(String, HttpMethod).
*/
@Deprecated
public CommandInfo(String url, HttpVerb verb) {
Expand Down

0 comments on commit 5fcb57f

Please sign in to comment.