Skip to content

Commit

Permalink
SimonStewart: Updating the javadocs
Browse files Browse the repository at this point in the history 
r16980
  • Loading branch information
@shs96c
shs96c committed May 23, 2012
1 parent 54d347b commit ffc5feb
Show file tree
Hide file tree
Showing 66 changed files with 2,872 additions and 346 deletions.
10 changes: 10 additions & 0 deletions docs/api/java/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,14 @@
<BR>
<A HREF="org/openqa/selenium/remote/DriverCommand.html" title="interface in org.openqa.selenium.remote" target="classFrame"><I>DriverCommand</I></A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverCommandExecutor.html" title="class in org.openqa.selenium.remote.service" target="classFrame">DriverCommandExecutor</A>
<BR>
<A HREF="org/openqa/selenium/android/library/DriverProvider.html" title="interface in org.openqa.selenium.android.library" target="classFrame"><I>DriverProvider</I></A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverService.html" title="class in org.openqa.selenium.remote.service" target="classFrame">DriverService</A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverService.Builder.html" title="class in org.openqa.selenium.remote.service" target="classFrame">DriverService.Builder</A>
<BR>
<A HREF="org/openqa/selenium/support/ui/Duration.html" title="class in org.openqa.selenium.support.ui" target="classFrame">Duration</A>
<BR>
<A HREF="org/openqa/selenium/support/pagefactory/ElementLocator.html" title="interface in org.openqa.selenium.support.pagefactory" target="classFrame"><I>ElementLocator</I></A>
Expand Down Expand Up @@ -363,6 +369,10 @@
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverServer.html" title="class in org.openqa.selenium.ie" target="classFrame">InternetExplorerDriverServer</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.html" title="class in org.openqa.selenium.ie" target="classFrame">InternetExplorerDriverService</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.Builder.html" title="class in org.openqa.selenium.ie" target="classFrame">InternetExplorerDriverService.Builder</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerElement.html" title="class in org.openqa.selenium.ie" target="classFrame">InternetExplorerElement</A>
<BR>
<A HREF="org/openqa/selenium/browserlaunchers/locators/InternetExplorerLocator.html" title="class in org.openqa.selenium.browserlaunchers.locators" target="classFrame">InternetExplorerLocator</A>
Expand Down
10 changes: 10 additions & 0 deletions docs/api/java/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,14 @@
<BR>
<A HREF="org/openqa/selenium/remote/DriverCommand.html" title="interface in org.openqa.selenium.remote"><I>DriverCommand</I></A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverCommandExecutor.html" title="class in org.openqa.selenium.remote.service">DriverCommandExecutor</A>
<BR>
<A HREF="org/openqa/selenium/android/library/DriverProvider.html" title="interface in org.openqa.selenium.android.library"><I>DriverProvider</I></A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverService.html" title="class in org.openqa.selenium.remote.service">DriverService</A>
<BR>
<A HREF="org/openqa/selenium/remote/service/DriverService.Builder.html" title="class in org.openqa.selenium.remote.service">DriverService.Builder</A>
<BR>
<A HREF="org/openqa/selenium/support/ui/Duration.html" title="class in org.openqa.selenium.support.ui">Duration</A>
<BR>
<A HREF="org/openqa/selenium/support/pagefactory/ElementLocator.html" title="interface in org.openqa.selenium.support.pagefactory"><I>ElementLocator</I></A>
Expand Down Expand Up @@ -363,6 +369,10 @@
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverServer.html" title="class in org.openqa.selenium.ie">InternetExplorerDriverServer</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.html" title="class in org.openqa.selenium.ie">InternetExplorerDriverService</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.Builder.html" title="class in org.openqa.selenium.ie">InternetExplorerDriverService.Builder</A>
<BR>
<A HREF="org/openqa/selenium/ie/InternetExplorerElement.html" title="class in org.openqa.selenium.ie">InternetExplorerElement</A>
<BR>
<A HREF="org/openqa/selenium/browserlaunchers/locators/InternetExplorerLocator.html" title="class in org.openqa.selenium.browserlaunchers.locators">InternetExplorerLocator</A>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/java/com/thoughtworks/selenium/DefaultSelenium.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2509,7 +2509,7 @@ <H2>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/thoughtworks/selenium/Selenium.html#addSelection(java.lang.String, java.lang.String)">addSelection</A></CODE> in interface <CODE><A HREF="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)<DT><B>See Also:</B><DD><CODE>for details of option locators</CODE></DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)</DL>
</DD>
</DL>
<HR>
Expand All @@ -2528,7 +2528,7 @@ <H2>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/thoughtworks/selenium/Selenium.html#removeSelection(java.lang.String, java.lang.String)">removeSelection</A></CODE> in interface <CODE><A HREF="../../../com/thoughtworks/selenium/Selenium.html" title="interface in com.thoughtworks.selenium">Selenium</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)<DT><B>See Also:</B><DD><CODE>for details of option locators</CODE></DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)</DL>
</DD>
</DL>
<HR>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/java/com/thoughtworks/selenium/Selenium.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2314,7 +2314,7 @@ <h3><a name="element-filters">Element Filters</a></h3><blockquote>
locator.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)<DT><B>See Also:</B><DD><CODE>for details of option locators</CODE></DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)</DL>
</DD>
</DL>
<HR>
Expand All @@ -2329,7 +2329,7 @@ <h3><a name="element-filters">Element Filters</a></h3><blockquote>
locator.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)<DT><B>See Also:</B><DD><CODE>for details of option locators</CODE></DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - an <a href="#locators">element locator</a> identifying a multi-select box<DD><CODE>optionLocator</CODE> - an option locator (a label by default)</DL>
</DD>
</DL>
<HR>
Expand Down
3 changes: 1 addition & 2 deletions docs/api/java/com/thoughtworks/selenium/SeleniumCommandTimedOutException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,7 @@ <H2>

<P>
<DL>
<DT><B>See Also:</B><DD><CODE>com.thoughtworks.selenium.outbedded.CommandBridge</CODE>,
<A HREF="../../../serialized-form.html#com.thoughtworks.selenium.SeleniumCommandTimedOutException">Serialized Form</A></DL>
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#com.thoughtworks.selenium.SeleniumCommandTimedOutException">Serialized Form</A></DL>
<HR>

<P>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/java/com/thoughtworks/selenium/condition/Condition.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <H2>
<ul>
<li>a message (purely used for displaying purposes)
<li>an implementation of
<CODE>#isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition"><CODE>isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE></A>
</ul>
<P>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/java/com/thoughtworks/selenium/condition/ConditionRunner.Context.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <H2>

<P>
Used by implementations of <A HREF="../../../../com/thoughtworks/selenium/condition/ConditionRunner.html#waitFor(com.thoughtworks.selenium.condition.Condition)"><CODE>ConditionRunner.waitFor(Condition)</CODE></A> to provide context to the
<CODE>Condition#isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE> method
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition"><CODE>isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE></A> method
<P>

<P>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/java/com/thoughtworks/selenium/condition/ConditionRunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <H2>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used by implementations of <A HREF="../../../../com/thoughtworks/selenium/condition/ConditionRunner.html#waitFor(com.thoughtworks.selenium.condition.Condition)"><CODE>waitFor(Condition)</CODE></A> to provide context to the
<CODE>Condition#isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE> method</TD>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition"><CODE>isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE></A> method</TD>
</TR>
</TABLE>
&nbsp;
Expand Down Expand Up @@ -154,7 +154,7 @@ <H2>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition">Condition</A>&nbsp;condition)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As above but with an additonal 'should' phrase narrative used in the event of the condition
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As above but with an additional 'should' phrase narrative used in the event of the condition
failing to become true</TD>
</TR>
</TABLE>
Expand Down Expand Up @@ -203,7 +203,7 @@ <H2>
void <B>waitFor</B>(java.lang.String&nbsp;narrative,
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition">Condition</A>&nbsp;condition)</PRE>
<DL>
<DD>As above but with an additonal 'should' phrase narrative used in the event of the condition
<DD>As above but with an additional 'should' phrase narrative used in the event of the condition
failing to become true
<P>
<DD><DL>
Expand Down
2 changes: 0 additions & 2 deletions docs/api/java/com/thoughtworks/selenium/condition/DefaultConditionRunner.Log4jMonitor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,6 @@ <H2>

<P>
A Log4j implementation of <A HREF="../../../../com/thoughtworks/selenium/condition/DefaultConditionRunner.Monitor.html" title="interface in com.thoughtworks.selenium.condition"><CODE>DefaultConditionRunner.Monitor</CODE></A>.
<p/>

<P>

<P>
Expand Down
2 changes: 0 additions & 2 deletions docs/api/java/com/thoughtworks/selenium/condition/DefaultConditionRunner.NoOpMonitor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,6 @@ <H2>

<P>
A no-op implementation of <A HREF="../../../../com/thoughtworks/selenium/condition/DefaultConditionRunner.Monitor.html" title="interface in com.thoughtworks.selenium.condition"><CODE>DefaultConditionRunner.Monitor</CODE></A>.
<p/>

<P>

<P>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/java/com/thoughtworks/selenium/condition/DefaultConditionRunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ <H2>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition">Condition</A>&nbsp;condition)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As above but with an additonal 'should' phrase narrative used in the event of the condition
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As above but with an additional 'should' phrase narrative used in the event of the condition
failing to become true</TD>
</TR>
</TABLE>
Expand Down Expand Up @@ -399,7 +399,7 @@ <H2>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition">Condition</A>&nbsp;condition)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/thoughtworks/selenium/condition/ConditionRunner.html#waitFor(java.lang.String, com.thoughtworks.selenium.condition.Condition)">ConditionRunner</A></CODE></B></DD>
<DD>As above but with an additonal 'should' phrase narrative used in the event of the condition
<DD>As above but with an additional 'should' phrase narrative used in the event of the condition
failing to become true
<P>
<DD><DL>
Expand Down
4 changes: 1 addition & 3 deletions docs/api/java/com/thoughtworks/selenium/condition/JUnit4AndTestNgConditionRunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@ <H2>
</PRE>

<P>

<p/>
This class throws an <CODE>AssertionError</CODE> when the condition is not met - the same as
This class throws an <CODE>AssertionError</CODE> when the condition is not met - the same as
JUnit4 and TestNG do.
<P>

Expand Down
4 changes: 1 addition & 3 deletions docs/api/java/com/thoughtworks/selenium/condition/JUnitConditionRunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@ <H2>
</PRE>

<P>

<p/>
This class throws an <CODE>AssertionFailedError</CODE> when the condition is not met.
This class throws an <CODE>AssertionFailedError</CODE> when the condition is not met.
<P>

<P>
Expand Down
10 changes: 3 additions & 7 deletions docs/api/java/com/thoughtworks/selenium/condition/package-summary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/thoughtworks/selenium/condition/ConditionRunner.Context.html" title="interface in com.thoughtworks.selenium.condition">ConditionRunner.Context</A></B></TD>
<TD>Used by implementations of <A HREF="../../../../com/thoughtworks/selenium/condition/ConditionRunner.html#waitFor(com.thoughtworks.selenium.condition.Condition)"><CODE>ConditionRunner.waitFor(Condition)</CODE></A> to provide context to the
<CODE>Condition#isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE> method</TD>
<A HREF="../../../../com/thoughtworks/selenium/condition/Condition.html" title="class in com.thoughtworks.selenium.condition"><CODE>isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)</CODE></A> method</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/thoughtworks/selenium/condition/DefaultConditionRunner.Monitor.html" title="interface in com.thoughtworks.selenium.condition">DefaultConditionRunner.Monitor</A></B></TD>
Expand Down Expand Up @@ -129,16 +129,12 @@ <H2>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/thoughtworks/selenium/condition/JUnit4AndTestNgConditionRunner.html" title="class in com.thoughtworks.selenium.condition">JUnit4AndTestNgConditionRunner</A></B></TD>
<TD>
<p/>
This class throws an <CODE>AssertionError</CODE> when the condition is not met - the same as
<TD>This class throws an <CODE>AssertionError</CODE> when the condition is not met - the same as
JUnit4 and TestNG do.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/thoughtworks/selenium/condition/JUnitConditionRunner.html" title="class in com.thoughtworks.selenium.condition">JUnitConditionRunner</A></B></TD>
<TD>
<p/>
This class throws an <CODE>AssertionFailedError</CODE> when the condition is not met.</TD>
<TD>This class throws an <CODE>AssertionFailedError</CODE> when the condition is not met.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/thoughtworks/selenium/condition/Not.html" title="class in com.thoughtworks.selenium.condition">Not</A></B></TD>
Expand Down
18 changes: 18 additions & 0 deletions docs/api/java/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,24 @@ <H1>

<P>

<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="3">org.openqa.selenium.ie.<A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.html" title="class in org.openqa.selenium.ie">InternetExplorerDriverService</A></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<A NAME="org.openqa.selenium.ie.InternetExplorerDriverService.IE_DRIVER_EXE_PROPERTY"><!-- --></A><TD ALIGN="right"><FONT SIZE="-1">
<CODE>public&nbsp;static&nbsp;final&nbsp;java.lang.String</CODE></FONT></TD>
<TD ALIGN="left"><CODE><A HREF="org/openqa/selenium/ie/InternetExplorerDriverService.html#IE_DRIVER_EXE_PROPERTY">IE_DRIVER_EXE_PROPERTY</A></CODE></TD>
<TD ALIGN="right"><CODE>"webdriver.ie.driver"</CODE></TD>
</TR>
</FONT></TD>
</TR>
</TABLE>

<P>

<P>

<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="3">org.openqa.selenium.interactions.touch.<A HREF="org/openqa/selenium/interactions/touch/FlickAction.html" title="class in org.openqa.selenium.interactions.touch">FlickAction</A></TH>
Expand Down
20 changes: 20 additions & 0 deletions docs/api/java/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ <H2>
<B>Contents</B><UL>
<LI><A HREF="#class">Deprecated Classes</A>
<LI><A HREF="#field">Deprecated Fields</A>
<LI><A HREF="#method">Deprecated Methods</A>
<LI><A HREF="#constructor">Deprecated Constructors</A>
</UL>

Expand Down Expand Up @@ -120,6 +121,25 @@ <H2>
</TABLE>
&nbsp;
<P>
<A NAME="method"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Deprecated Methods</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><A HREF="org/openqa/selenium/os/CommandLine.html#find(java.lang.String)">org.openqa.selenium.os.CommandLine.find(String)</A>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<I>Use the commandline itself to execute your command.</I>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><A HREF="org/openqa/selenium/chrome/ChromeDriverService.Builder.html#usingChromeDriverExecutable(java.io.File)">org.openqa.selenium.chrome.ChromeDriverService.Builder.usingChromeDriverExecutable(File)</A>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<I>Use <A HREF="org/openqa/selenium/chrome/ChromeDriverService.Builder.html#usingDriverExecutable(java.io.File)"><CODE>ChromeDriverService.Builder.usingDriverExecutable(File)</CODE></A> instead</I>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="constructor"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
Expand Down
Loading

0 comments on commit ffc5feb

Please sign in to comment.