Skip to content

Commit

Permalink
Updating the javadocs prior to release.
Browse files Browse the repository at this point in the history
  • Loading branch information
shs96c committed Apr 9, 2013
1 parent 085758c commit 6c40c18
Show file tree
Hide file tree
Showing 24 changed files with 467 additions and 97 deletions.
1 change: 1 addition & 0 deletions docs/api/java/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ <h1 class="bar">All Classes</h1>
<li><a href="org/openqa/selenium/remote/HttpCommandExecutor.html" title="class in org.openqa.selenium.remote" target="classFrame">HttpCommandExecutor</a></li>
<li><a href="com/thoughtworks/selenium/HttpCommandProcessor.html" title="class in com.thoughtworks.selenium" target="classFrame">HttpCommandProcessor</a></li>
<li><a href="org/openqa/selenium/logging/profiler/HttpProfilerLogEntry.html" title="class in org.openqa.selenium.logging.profiler" target="classFrame">HttpProfilerLogEntry</a></li>
<li><a href="org/openqa/selenium/remote/HttpSessionId.html" title="class in org.openqa.selenium.remote" target="classFrame">HttpSessionId</a></li>
<li><a href="org/openqa/selenium/remote/HttpVerb.html" title="enum in org.openqa.selenium.remote" target="classFrame">HttpVerb</a></li>
<li><a href="org/openqa/selenium/lift/find/ImageFinder.html" title="class in org.openqa.selenium.lift.find" target="classFrame">ImageFinder</a></li>
<li><a href="org/openqa/selenium/ImeActivationFailedException.html" title="class in org.openqa.selenium" target="classFrame">ImeActivationFailedException</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/api/java/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ <h1 class="bar">All Classes</h1>
<li><a href="org/openqa/selenium/remote/HttpCommandExecutor.html" title="class in org.openqa.selenium.remote">HttpCommandExecutor</a></li>
<li><a href="com/thoughtworks/selenium/HttpCommandProcessor.html" title="class in com.thoughtworks.selenium">HttpCommandProcessor</a></li>
<li><a href="org/openqa/selenium/logging/profiler/HttpProfilerLogEntry.html" title="class in org.openqa.selenium.logging.profiler">HttpProfilerLogEntry</a></li>
<li><a href="org/openqa/selenium/remote/HttpSessionId.html" title="class in org.openqa.selenium.remote">HttpSessionId</a></li>
<li><a href="org/openqa/selenium/remote/HttpVerb.html" title="enum in org.openqa.selenium.remote">HttpVerb</a></li>
<li><a href="org/openqa/selenium/lift/find/ImageFinder.html" title="class in org.openqa.selenium.lift.find">ImageFinder</a></li>
<li><a href="org/openqa/selenium/ImeActivationFailedException.html" title="class in org.openqa.selenium">ImeActivationFailedException</a></li>
Expand Down
7 changes: 7 additions & 0 deletions docs/api/java/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -2030,6 +2030,13 @@ <h2 title="org.openqa">org.openqa.*</h2>
<td><code><a href="org/openqa/selenium/safari/SafariDriver.html#CLEAN_SESSION_CAPABILITY">CLEAN_SESSION_CAPABILITY</a></code></td>
<td class="colLast"><code>"safari.cleanSession"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.openqa.selenium.safari.SafariDriver.DATA_DIR_CAPABILITY">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="org/openqa/selenium/safari/SafariDriver.html#DATA_DIR_CAPABILITY">DATA_DIR_CAPABILITY</a></code></td>
<td class="colLast"><code>"safari.dataDir"</code></td>
</tr>
</tbody>
</table>
</li>
Expand Down
3 changes: 3 additions & 0 deletions docs/api/java/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ <h2 title="Contents">Contents</h2>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="org/openqa/selenium/SeleneseCommandExecutor.html" title="class in org.openqa.selenium">org.openqa.selenium.SeleneseCommandExecutor</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="com/thoughtworks/selenium/SeleneseTestCase.html" title="class in com.thoughtworks.selenium">com.thoughtworks.selenium.SeleneseTestCase</a>
<div class="block"><i>Please consider updating to junit 4 or above</i></div>
</td>
Expand Down
56 changes: 43 additions & 13 deletions docs/api/java/index-all.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/java/org/openqa/selenium/HasCapabilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2 title="Interface HasCapabilities" class="title">Interface HasCapabilities</h
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/openqa/selenium/android/AndroidDriver.html" title="class in org.openqa.selenium.android">AndroidDriver</a>, <a href="../../../org/openqa/selenium/chrome/ChromeDriver.html" title="class in org.openqa.selenium.chrome">ChromeDriver</a>, <a href="../../../org/openqa/selenium/firefox/FirefoxDriver.html" title="class in org.openqa.selenium.firefox">FirefoxDriver</a>, <a href="../../../org/openqa/selenium/htmlunit/HtmlUnitDriver.html" title="class in org.openqa.selenium.htmlunit">HtmlUnitDriver</a>, <a href="../../../org/openqa/selenium/ie/InternetExplorerDriver.html" title="class in org.openqa.selenium.ie">InternetExplorerDriver</a>, <a href="../../../org/openqa/selenium/iphone/IPhoneDriver.html" title="class in org.openqa.selenium.iphone">IPhoneDriver</a>, <a href="../../../org/openqa/selenium/iphone/IPhoneSimulatorDriver.html" title="class in org.openqa.selenium.iphone">IPhoneSimulatorDriver</a>, <a href="../../../org/openqa/selenium/remote/RemoteWebDriver.html" title="class in org.openqa.selenium.remote">RemoteWebDriver</a>, <a href="../../../org/openqa/selenium/safari/SafariDriver.html" title="class in org.openqa.selenium.safari">SafariDriver</a></dd>
<dd><a href="../../../org/openqa/selenium/android/AndroidDriver.html" title="class in org.openqa.selenium.android">AndroidDriver</a>, <a href="../../../org/openqa/selenium/chrome/ChromeDriver.html" title="class in org.openqa.selenium.chrome">ChromeDriver</a>, <a href="../../../org/openqa/selenium/firefox/FirefoxDriver.html" title="class in org.openqa.selenium.firefox">FirefoxDriver</a>, <a href="../../../org/openqa/selenium/htmlunit/HtmlUnitDriver.html" title="class in org.openqa.selenium.htmlunit">HtmlUnitDriver</a>, <a href="../../../org/openqa/selenium/ie/InternetExplorerDriver.html" title="class in org.openqa.selenium.ie">InternetExplorerDriver</a>, <a href="../../../org/openqa/selenium/iphone/IPhoneDriver.html" title="class in org.openqa.selenium.iphone">IPhoneDriver</a>, <a href="../../../org/openqa/selenium/iphone/IPhoneSimulatorDriver.html" title="class in org.openqa.selenium.iphone">IPhoneSimulatorDriver</a>, <a href="../../../org/openqa/selenium/remote/RemoteWebDriver.html" title="class in org.openqa.selenium.remote">RemoteWebDriver</a>, <a href="../../../org/openqa/selenium/safari/SafariDriver.html" title="class in org.openqa.selenium.safari">SafariDriver</a>, <a href="../../../org/openqa/selenium/WebDriverBackedSelenium.html" title="class in org.openqa.selenium">WebDriverBackedSelenium</a></dd>
</dl>
<hr>
<br>
Expand Down
34 changes: 27 additions & 7 deletions docs/api/java/org/openqa/selenium/SeleneseCommandExecutor.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,10 @@ <h2 title="Class SeleneseCommandExecutor" class="title">Class SeleneseCommandExe
<dd><a href="../../../org/openqa/selenium/remote/CommandExecutor.html" title="interface in org.openqa.selenium.remote">CommandExecutor</a></dd>
</dl>
<hr>
<div class="block"><strong>Deprecated.</strong></div>
<br>
<pre>public class <span class="strong">SeleneseCommandExecutor</span>
<pre>@Deprecated
public class <span class="strong">SeleneseCommandExecutor</span>
extends java.lang.Object
implements <a href="../../../org/openqa/selenium/remote/CommandExecutor.html" title="interface in org.openqa.selenium.remote">CommandExecutor</a></pre>
</li>
Expand All @@ -118,15 +120,21 @@ <h3>Constructor Summary</h3>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#SeleneseCommandExecutor(com.thoughtworks.selenium.CommandProcessor)">SeleneseCommandExecutor</a></strong>(<a href="../../../com/thoughtworks/selenium/CommandProcessor.html" title="interface in com.thoughtworks.selenium">CommandProcessor</a>&nbsp;processor)</code>&nbsp;</td>
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#SeleneseCommandExecutor(com.thoughtworks.selenium.CommandProcessor)">SeleneseCommandExecutor</a></strong>(<a href="../../../com/thoughtworks/selenium/CommandProcessor.html" title="interface in com.thoughtworks.selenium">CommandProcessor</a>&nbsp;processor)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#SeleneseCommandExecutor(com.thoughtworks.selenium.Selenium)">SeleneseCommandExecutor</a></strong>(<a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>&nbsp;instance)</code>&nbsp;</td>
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#SeleneseCommandExecutor(com.thoughtworks.selenium.Selenium)">SeleneseCommandExecutor</a></strong>(<a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>&nbsp;instance)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#SeleneseCommandExecutor(java.net.URL, java.net.URL, org.openqa.selenium.Capabilities)">SeleneseCommandExecutor</a></strong>(java.net.URL&nbsp;seleniumServer,
java.net.URL&nbsp;remoteAddress,
<a href="../../../org/openqa/selenium/Capabilities.html" title="interface in org.openqa.selenium">Capabilities</a>&nbsp;capabilities)</code>&nbsp;</td>
<a href="../../../org/openqa/selenium/Capabilities.html" title="interface in org.openqa.selenium">Capabilities</a>&nbsp;capabilities)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
Expand All @@ -146,15 +154,21 @@ <h3>Method Summary</h3>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#addCommand(java.lang.String, org.openqa.selenium.internal.selenesedriver.SeleneseFunction)">addCommand</a></strong>(java.lang.String&nbsp;methodName,
org.openqa.selenium.internal.selenesedriver.SeleneseFunction&lt;?&gt;&nbsp;command)</code>&nbsp;</td>
org.openqa.selenium.internal.selenesedriver.SeleneseFunction&lt;?&gt;&nbsp;command)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/openqa/selenium/remote/Response.html" title="class in org.openqa.selenium.remote">Response</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#execute(org.openqa.selenium.remote.Command)">execute</a></strong>(<a href="../../../org/openqa/selenium/remote/Command.html" title="class in org.openqa.selenium.remote">Command</a>&nbsp;command)</code>&nbsp;</td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#execute(org.openqa.selenium.remote.Command)">execute</a></strong>(<a href="../../../org/openqa/selenium/remote/Command.html" title="class in org.openqa.selenium.remote">Command</a>&nbsp;command)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#getWrappedSelenium()">getWrappedSelenium</a></strong>()</code>&nbsp;</td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/SeleneseCommandExecutor.html#getWrappedSelenium()">getWrappedSelenium</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
Expand Down Expand Up @@ -187,6 +201,7 @@ <h4>SeleneseCommandExecutor</h4>
<pre>public&nbsp;SeleneseCommandExecutor(java.net.URL&nbsp;seleniumServer,
java.net.URL&nbsp;remoteAddress,
<a href="../../../org/openqa/selenium/Capabilities.html" title="interface in org.openqa.selenium">Capabilities</a>&nbsp;capabilities)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="SeleneseCommandExecutor(com.thoughtworks.selenium.CommandProcessor)">
Expand All @@ -196,6 +211,7 @@ <h4>SeleneseCommandExecutor</h4>
<li class="blockList">
<h4>SeleneseCommandExecutor</h4>
<pre>public&nbsp;SeleneseCommandExecutor(<a href="../../../com/thoughtworks/selenium/CommandProcessor.html" title="interface in com.thoughtworks.selenium">CommandProcessor</a>&nbsp;processor)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="SeleneseCommandExecutor(com.thoughtworks.selenium.Selenium)">
Expand All @@ -205,6 +221,7 @@ <h4>SeleneseCommandExecutor</h4>
<li class="blockList">
<h4>SeleneseCommandExecutor</h4>
<pre>public&nbsp;SeleneseCommandExecutor(<a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>&nbsp;instance)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
Expand All @@ -222,6 +239,7 @@ <h3>Method Detail</h3>
<li class="blockList">
<h4>getWrappedSelenium</h4>
<pre>public&nbsp;<a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>&nbsp;getWrappedSelenium()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="execute(org.openqa.selenium.remote.Command)">
Expand All @@ -231,6 +249,7 @@ <h4>getWrappedSelenium</h4>
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;<a href="../../../org/openqa/selenium/remote/Response.html" title="class in org.openqa.selenium.remote">Response</a>&nbsp;execute(<a href="../../../org/openqa/selenium/remote/Command.html" title="class in org.openqa.selenium.remote">Command</a>&nbsp;command)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/openqa/selenium/remote/CommandExecutor.html#execute(org.openqa.selenium.remote.Command)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/openqa/selenium/remote/CommandExecutor.html" title="interface in org.openqa.selenium.remote">CommandExecutor</a></code></dd>
Expand All @@ -245,6 +264,7 @@ <h4>execute</h4>
<h4>addCommand</h4>
<pre>public&nbsp;void&nbsp;addCommand(java.lang.String&nbsp;methodName,
org.openqa.selenium.internal.selenesedriver.SeleneseFunction&lt;?&gt;&nbsp;command)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ <h3>Constructor Summary</h3>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SessionNotCreatedException.html#SessionNotCreatedException(java.lang.String)">SessionNotCreatedException</a></strong>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/openqa/selenium/SessionNotCreatedException.html#SessionNotCreatedException(java.lang.String, java.lang.Throwable)">SessionNotCreatedException</a></strong>(java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;cause)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
Expand Down Expand Up @@ -203,12 +207,22 @@ <h3>Constructor Detail</h3>
<a name="SessionNotCreatedException(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>SessionNotCreatedException</h4>
<pre>public&nbsp;SessionNotCreatedException(java.lang.String&nbsp;msg)</pre>
</li>
</ul>
<a name="SessionNotCreatedException(java.lang.String, java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SessionNotCreatedException</h4>
<pre>public&nbsp;SessionNotCreatedException(java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;cause)</pre>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
23 changes: 20 additions & 3 deletions docs/api/java/org/openqa/selenium/WebDriverBackedSelenium.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@ <h2 title="Class WebDriverBackedSelenium" class="title">Class WebDriverBackedSel
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>, <a href="../../../org/openqa/selenium/internal/WrapsDriver.html" title="interface in org.openqa.selenium.internal">WrapsDriver</a></dd>
<dd><a href="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</a>, <a href="../../../org/openqa/selenium/HasCapabilities.html" title="interface in org.openqa.selenium">HasCapabilities</a>, <a href="../../../org/openqa/selenium/internal/WrapsDriver.html" title="interface in org.openqa.selenium.internal">WrapsDriver</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">WebDriverBackedSelenium</span>
extends <a href="../../../com/thoughtworks/selenium/DefaultSelenium.html" title="class in com.thoughtworks.selenium">DefaultSelenium</a>
implements <a href="../../../org/openqa/selenium/internal/WrapsDriver.html" title="interface in org.openqa.selenium.internal">WrapsDriver</a></pre>
implements <a href="../../../org/openqa/selenium/HasCapabilities.html" title="interface in org.openqa.selenium">HasCapabilities</a>, <a href="../../../org/openqa/selenium/internal/WrapsDriver.html" title="interface in org.openqa.selenium.internal">WrapsDriver</a></pre>
</li>
</ul>
</div>
Expand Down Expand Up @@ -161,6 +161,10 @@ <h3>Method Summary</h3>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/openqa/selenium/Capabilities.html" title="interface in org.openqa.selenium">Capabilities</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/WebDriverBackedSelenium.html#getCapabilities()">getCapabilities</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/openqa/selenium/WebDriver.html" title="interface in org.openqa.selenium">WebDriver</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/openqa/selenium/WebDriverBackedSelenium.html#getWrappedDriver()">getWrappedDriver</a></strong>()</code>&nbsp;</td>
</tr>
Expand Down Expand Up @@ -224,7 +228,7 @@ <h3>Method Detail</h3>
<a name="getWrappedDriver()">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>getWrappedDriver</h4>
<pre>public&nbsp;<a href="../../../org/openqa/selenium/WebDriver.html" title="interface in org.openqa.selenium">WebDriver</a>&nbsp;getWrappedDriver()</pre>
Expand All @@ -234,6 +238,19 @@ <h4>getWrappedDriver</h4>
<dt><span class="strong">Returns:</span></dt><dd>The driver that contains this element.</dd></dl>
</li>
</ul>
<a name="getCapabilities()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCapabilities</h4>
<pre>public&nbsp;<a href="../../../org/openqa/selenium/Capabilities.html" title="interface in org.openqa.selenium">Capabilities</a>&nbsp;getCapabilities()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/openqa/selenium/HasCapabilities.html#getCapabilities()">getCapabilities</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/openqa/selenium/HasCapabilities.html" title="interface in org.openqa.selenium">HasCapabilities</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The capabilities of the current driver.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 6c40c18

Please sign in to comment.