Skip to content

Commit 5a7dfe6

Browse files
committed
Regenerated API docs
1 parent 021367c commit 5a7dfe6

13 files changed

+419
-395
lines changed

doc/api/_static/javadoc/allclasses-frame.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
1212
<div class="indexContainer">
1313
<ul>
1414
<li><a href="org/robotframework/RobotFramework.html" title="class in org.robotframework" target="classFrame">RobotFramework</a></li>
15-
<li><a href="org/robotframework/RobotRunner.html" title="interface in org.robotframework" target="classFrame"><span class="interfaceName">RobotRunner</span></a></li>
16-
<li><a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework" target="classFrame">RunnerFactory</a></li>
15+
<li><a href="org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework" target="classFrame"><span class="interfaceName">RobotPythonRunner</span></a></li>
16+
<li><a href="org/robotframework/RobotRunner.html" title="class in org.robotframework" target="classFrame">RobotRunner</a></li>
1717
</ul>
1818
</div>
1919
</body>

doc/api/_static/javadoc/allclasses-noframe.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
1212
<div class="indexContainer">
1313
<ul>
1414
<li><a href="org/robotframework/RobotFramework.html" title="class in org.robotframework">RobotFramework</a></li>
15-
<li><a href="org/robotframework/RobotRunner.html" title="interface in org.robotframework"><span class="interfaceName">RobotRunner</span></a></li>
16-
<li><a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework">RunnerFactory</a></li>
15+
<li><a href="org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework"><span class="interfaceName">RobotPythonRunner</span></a></li>
16+
<li><a href="org/robotframework/RobotRunner.html" title="class in org.robotframework">RobotRunner</a></li>
1717
</ul>
1818
</div>
1919
</body>

doc/api/_static/javadoc/index-all.html

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -66,29 +66,16 @@
6666
<!-- -->
6767
</a></div>
6868
<!-- ========= END OF TOP NAVBAR ========= -->
69-
<div class="contentContainer"><a href="#I:C">C</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a name="I:C">
69+
<div class="contentContainer"><a href="#I:C">C</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a name="I:C">
7070
<!-- -->
7171
</a>
7272
<h2 class="title">C</h2>
7373
<dl>
74-
<dt><span class="memberNameLink"><a href="org/robotframework/RunnerFactory.html#cleanup--">cleanup()</a></span> - Method in class org.robotframework.<a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework">RunnerFactory</a></dt>
74+
<dt><span class="memberNameLink"><a href="org/robotframework/RobotRunner.html#close--">close()</a></span> - Method in class org.robotframework.<a href="org/robotframework/RobotRunner.html" title="class in org.robotframework">RobotRunner</a></dt>
7575
<dd>
76-
<div class="block">Cleans up the interpreter used for creating runners.</div>
77-
</dd>
78-
<dt><span class="memberNameLink"><a href="org/robotframework/RunnerFactory.html#createRunner--">createRunner()</a></span> - Method in class org.robotframework.<a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework">RunnerFactory</a></dt>
79-
<dd>
80-
<div class="block">Creates and returns an instance of the robot.JarRunner (implemented in
81-
Python), which can be used to execute tests.</div>
76+
<div class="block">Cleans up the Jython interpreter.</div>
8277
</dd>
8378
</dl>
84-
<a name="I:I">
85-
<!-- -->
86-
</a>
87-
<h2 class="title">I</h2>
88-
<dl>
89-
<dt><span class="memberNameLink"><a href="org/robotframework/RunnerFactory.html#interpreter">interpreter</a></span> - Variable in class org.robotframework.<a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework">RunnerFactory</a></dt>
90-
<dd>&nbsp;</dd>
91-
</dl>
9279
<a name="I:M">
9380
<!-- -->
9481
</a>
@@ -118,26 +105,31 @@ <h2 class="title">R</h2>
118105
</dd>
119106
<dt><span class="memberNameLink"><a href="org/robotframework/RobotFramework.html#RobotFramework--">RobotFramework()</a></span> - Constructor for class org.robotframework.<a href="org/robotframework/RobotFramework.html" title="class in org.robotframework">RobotFramework</a></dt>
120107
<dd>&nbsp;</dd>
121-
<dt><a href="org/robotframework/RobotRunner.html" title="interface in org.robotframework"><span class="typeNameLink">RobotRunner</span></a> - Interface in <a href="org/robotframework/package-summary.html">org.robotframework</a></dt>
108+
<dt><a href="org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework"><span class="typeNameLink">RobotPythonRunner</span></a> - Interface in <a href="org/robotframework/package-summary.html">org.robotframework</a></dt>
109+
<dd>
110+
<div class="block">Interface used by <a href="org/robotframework/RobotRunner.html" title="class in org.robotframework"><code>RobotRunner</code></a> internally to
111+
construct the Robot Framework Python class.</div>
112+
</dd>
113+
<dt><a href="org/robotframework/RobotRunner.html" title="class in org.robotframework"><span class="typeNameLink">RobotRunner</span></a> - Class in <a href="org/robotframework/package-summary.html">org.robotframework</a></dt>
122114
<dd>
123-
<div class="block">An interface class that is used for creating a Jython object capable of
124-
running Robot Framework.</div>
115+
<div class="block">AutoCloseable Interface class that internally creates a Jython interpreter,
116+
allows running Robot tests with it, and cleans up the interpreter afterwards
117+
in close.</div>
125118
</dd>
119+
<dt><span class="memberNameLink"><a href="org/robotframework/RobotRunner.html#RobotRunner--">RobotRunner()</a></span> - Constructor for class org.robotframework.<a href="org/robotframework/RobotRunner.html" title="class in org.robotframework">RobotRunner</a></dt>
120+
<dd>&nbsp;</dd>
126121
<dt><span class="memberNameLink"><a href="org/robotframework/RobotFramework.html#run-java.lang.String:A-">run(String[])</a></span> - Static method in class org.robotframework.<a href="org/robotframework/RobotFramework.html" title="class in org.robotframework">RobotFramework</a></dt>
127122
<dd>
128123
<div class="block">Runs Robot Framework.</div>
129124
</dd>
130-
<dt><span class="memberNameLink"><a href="org/robotframework/RobotRunner.html#run-java.lang.String:A-">run(String[])</a></span> - Method in interface org.robotframework.<a href="org/robotframework/RobotRunner.html" title="interface in org.robotframework">RobotRunner</a></dt>
125+
<dt><span class="memberNameLink"><a href="org/robotframework/RobotPythonRunner.html#run-java.lang.String:A-">run(String[])</a></span> - Method in interface org.robotframework.<a href="org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework">RobotPythonRunner</a></dt>
131126
<dd>&nbsp;</dd>
132-
<dt><a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework"><span class="typeNameLink">RunnerFactory</span></a> - Class in <a href="org/robotframework/package-summary.html">org.robotframework</a></dt>
127+
<dt><span class="memberNameLink"><a href="org/robotframework/RobotRunner.html#run-java.lang.String:A-">run(String[])</a></span> - Method in class org.robotframework.<a href="org/robotframework/RobotRunner.html" title="class in org.robotframework">RobotRunner</a></dt>
133128
<dd>
134-
<div class="block">Helper class to create an Jython object and coerce it so that it can be used
135-
from Java.</div>
129+
<div class="block">Runs the tests, but does not cleanup the interpreter afterwards.</div>
136130
</dd>
137-
<dt><span class="memberNameLink"><a href="org/robotframework/RunnerFactory.html#RunnerFactory--">RunnerFactory()</a></span> - Constructor for class org.robotframework.<a href="org/robotframework/RunnerFactory.html" title="class in org.robotframework">RunnerFactory</a></dt>
138-
<dd>&nbsp;</dd>
139131
</dl>
140-
<a href="#I:C">C</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;</div>
132+
<a href="#I:C">C</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;</div>
141133
<!-- ======= START OF BOTTOM NAVBAR ====== -->
142134
<div class="bottomNav"><a name="navbar.bottom">
143135
<!-- -->

doc/api/_static/javadoc/org/robotframework/RobotFramework.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<div class="subNav">
4848
<ul class="navList">
4949
<li>Prev&nbsp;Class</li>
50-
<li><a href="../../org/robotframework/RobotRunner.html" title="interface in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
50+
<li><a href="../../org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
5151
</ul>
5252
<ul class="navList">
5353
<li><a href="../../index.html?org/robotframework/RobotFramework.html" target="_top">Frames</a></li>
@@ -266,7 +266,7 @@ <h4>run</h4>
266266
<div class="subNav">
267267
<ul class="navList">
268268
<li>Prev&nbsp;Class</li>
269-
<li><a href="../../org/robotframework/RobotRunner.html" title="interface in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
269+
<li><a href="../../org/robotframework/RobotPythonRunner.html" title="interface in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
270270
</ul>
271271
<ul class="navList">
272272
<li><a href="../../index.html?org/robotframework/RobotFramework.html" target="_top">Frames</a></li>
Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>RobotPythonRunner</title>
7+
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
8+
<script type="text/javascript" src="../../script.js"></script>
9+
</head>
10+
<body>
11+
<script type="text/javascript"><!--
12+
try {
13+
if (location.href.indexOf('is-external=true') == -1) {
14+
parent.document.title="RobotPythonRunner";
15+
}
16+
}
17+
catch(err) {
18+
}
19+
//-->
20+
var methods = {"i0":6};
21+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
22+
var altColor = "altColor";
23+
var rowColor = "rowColor";
24+
var tableTab = "tableTab";
25+
var activeTableTab = "activeTableTab";
26+
</script>
27+
<noscript>
28+
<div>JavaScript is disabled on your browser.</div>
29+
</noscript>
30+
<!-- ========= START OF TOP NAVBAR ======= -->
31+
<div class="topNav"><a name="navbar.top">
32+
<!-- -->
33+
</a>
34+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
35+
<a name="navbar.top.firstrow">
36+
<!-- -->
37+
</a>
38+
<ul class="navList" title="Navigation">
39+
<li><a href="../../org/robotframework/package-summary.html">Package</a></li>
40+
<li class="navBarCell1Rev">Class</li>
41+
<li><a href="package-tree.html">Tree</a></li>
42+
<li><a href="../../deprecated-list.html">Deprecated</a></li>
43+
<li><a href="../../index-all.html">Index</a></li>
44+
<li><a href="../../help-doc.html">Help</a></li>
45+
</ul>
46+
</div>
47+
<div class="subNav">
48+
<ul class="navList">
49+
<li><a href="../../org/robotframework/RobotFramework.html" title="class in org.robotframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
50+
<li><a href="../../org/robotframework/RobotRunner.html" title="class in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
51+
</ul>
52+
<ul class="navList">
53+
<li><a href="../../index.html?org/robotframework/RobotPythonRunner.html" target="_top">Frames</a></li>
54+
<li><a href="RobotPythonRunner.html" target="_top">No&nbsp;Frames</a></li>
55+
</ul>
56+
<ul class="navList" id="allclasses_navbar_top">
57+
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
58+
</ul>
59+
<div>
60+
<script type="text/javascript"><!--
61+
allClassesLink = document.getElementById("allclasses_navbar_top");
62+
if(window==top) {
63+
allClassesLink.style.display = "block";
64+
}
65+
else {
66+
allClassesLink.style.display = "none";
67+
}
68+
//-->
69+
</script>
70+
</div>
71+
<div>
72+
<ul class="subNavList">
73+
<li>Summary:&nbsp;</li>
74+
<li>Nested&nbsp;|&nbsp;</li>
75+
<li>Field&nbsp;|&nbsp;</li>
76+
<li>Constr&nbsp;|&nbsp;</li>
77+
<li><a href="#method.summary">Method</a></li>
78+
</ul>
79+
<ul class="subNavList">
80+
<li>Detail:&nbsp;</li>
81+
<li>Field&nbsp;|&nbsp;</li>
82+
<li>Constr&nbsp;|&nbsp;</li>
83+
<li><a href="#method.detail">Method</a></li>
84+
</ul>
85+
</div>
86+
<a name="skip.navbar.top">
87+
<!-- -->
88+
</a></div>
89+
<!-- ========= END OF TOP NAVBAR ========= -->
90+
<!-- ======== START OF CLASS DATA ======== -->
91+
<div class="header">
92+
<div class="subTitle">org.robotframework</div>
93+
<h2 title="Interface RobotPythonRunner" class="title">Interface RobotPythonRunner</h2>
94+
</div>
95+
<div class="contentContainer">
96+
<div class="description">
97+
<ul class="blockList">
98+
<li class="blockList">
99+
<hr>
100+
<br>
101+
<pre>public interface <span class="typeNameLabel">RobotPythonRunner</span></pre>
102+
<div class="block">Interface used by <a href="../../org/robotframework/RobotRunner.html" title="class in org.robotframework"><code>RobotRunner</code></a> internally to
103+
construct the Robot Framework Python class.</div>
104+
</li>
105+
</ul>
106+
</div>
107+
<div class="summary">
108+
<ul class="blockList">
109+
<li class="blockList">
110+
<!-- ========== METHOD SUMMARY =========== -->
111+
<ul class="blockList">
112+
<li class="blockList"><a name="method.summary">
113+
<!-- -->
114+
</a>
115+
<h3>Method Summary</h3>
116+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
117+
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
118+
<tr>
119+
<th class="colFirst" scope="col">Modifier and Type</th>
120+
<th class="colLast" scope="col">Method and Description</th>
121+
</tr>
122+
<tr id="i0" class="altColor">
123+
<td class="colFirst"><code>int</code></td>
124+
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/robotframework/RobotPythonRunner.html#run-java.lang.String:A-">run</a></span>(java.lang.String[]&nbsp;args)</code>&nbsp;</td>
125+
</tr>
126+
</table>
127+
</li>
128+
</ul>
129+
</li>
130+
</ul>
131+
</div>
132+
<div class="details">
133+
<ul class="blockList">
134+
<li class="blockList">
135+
<!-- ============ METHOD DETAIL ========== -->
136+
<ul class="blockList">
137+
<li class="blockList"><a name="method.detail">
138+
<!-- -->
139+
</a>
140+
<h3>Method Detail</h3>
141+
<a name="run-java.lang.String:A-">
142+
<!-- -->
143+
</a>
144+
<ul class="blockListLast">
145+
<li class="blockList">
146+
<h4>run</h4>
147+
<pre>int&nbsp;run(java.lang.String[]&nbsp;args)</pre>
148+
</li>
149+
</ul>
150+
</li>
151+
</ul>
152+
</li>
153+
</ul>
154+
</div>
155+
</div>
156+
<!-- ========= END OF CLASS DATA ========= -->
157+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
158+
<div class="bottomNav"><a name="navbar.bottom">
159+
<!-- -->
160+
</a>
161+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
162+
<a name="navbar.bottom.firstrow">
163+
<!-- -->
164+
</a>
165+
<ul class="navList" title="Navigation">
166+
<li><a href="../../org/robotframework/package-summary.html">Package</a></li>
167+
<li class="navBarCell1Rev">Class</li>
168+
<li><a href="package-tree.html">Tree</a></li>
169+
<li><a href="../../deprecated-list.html">Deprecated</a></li>
170+
<li><a href="../../index-all.html">Index</a></li>
171+
<li><a href="../../help-doc.html">Help</a></li>
172+
</ul>
173+
</div>
174+
<div class="subNav">
175+
<ul class="navList">
176+
<li><a href="../../org/robotframework/RobotFramework.html" title="class in org.robotframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
177+
<li><a href="../../org/robotframework/RobotRunner.html" title="class in org.robotframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
178+
</ul>
179+
<ul class="navList">
180+
<li><a href="../../index.html?org/robotframework/RobotPythonRunner.html" target="_top">Frames</a></li>
181+
<li><a href="RobotPythonRunner.html" target="_top">No&nbsp;Frames</a></li>
182+
</ul>
183+
<ul class="navList" id="allclasses_navbar_bottom">
184+
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
185+
</ul>
186+
<div>
187+
<script type="text/javascript"><!--
188+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
189+
if(window==top) {
190+
allClassesLink.style.display = "block";
191+
}
192+
else {
193+
allClassesLink.style.display = "none";
194+
}
195+
//-->
196+
</script>
197+
</div>
198+
<div>
199+
<ul class="subNavList">
200+
<li>Summary:&nbsp;</li>
201+
<li>Nested&nbsp;|&nbsp;</li>
202+
<li>Field&nbsp;|&nbsp;</li>
203+
<li>Constr&nbsp;|&nbsp;</li>
204+
<li><a href="#method.summary">Method</a></li>
205+
</ul>
206+
<ul class="subNavList">
207+
<li>Detail:&nbsp;</li>
208+
<li>Field&nbsp;|&nbsp;</li>
209+
<li>Constr&nbsp;|&nbsp;</li>
210+
<li><a href="#method.detail">Method</a></li>
211+
</ul>
212+
</div>
213+
<a name="skip.navbar.bottom">
214+
<!-- -->
215+
</a></div>
216+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
217+
</body>
218+
</html>

0 commit comments

Comments
 (0)