Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit e996a90

Browse files
juliemrsjelin
authored andcommitted
docs(runner): move docs for functions added by runner
This will make them present in the generated doc website.
1 parent d15ccdc commit e996a90

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

lib/protractor.js

+30
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,13 @@ var Protractor = function(webdriverInstance, opt_baseUrl, opt_rootElement) {
182182
*/
183183
this.params = {};
184184

185+
/**
186+
* Set by the runner.
187+
*
188+
* @type {q.Promise} Done when the new browser is ready for use
189+
*/
190+
this.ready = null;
191+
185192
/**
186193
* The reset URL to use between page loads.
187194
*
@@ -217,6 +224,29 @@ var Protractor = function(webdriverInstance, opt_baseUrl, opt_rootElement) {
217224
this.debuggerServerPort_;
218225
};
219226

227+
228+
/**
229+
* Get the processed configuration object that is currently being run. This
230+
* will contain the specs and capabilities properties of the current runner
231+
* instance.
232+
*
233+
* Set by the runner.
234+
*
235+
* @return {q.Promise} A promise which resolves to the capabilities object.
236+
*/
237+
Protractor.prototype.getProcessedConfig = null;
238+
239+
/**
240+
* Fork another instance of protractor for use in interactive tests.
241+
*
242+
* Set by the runner.
243+
*
244+
* @param {boolean} opt_useSameUrl Whether to navigate to current url on creation
245+
* @param {boolean} opt_copyMockModules Whether to apply same mock modules on creation
246+
* @return {Protractor} a protractor instance.
247+
*/
248+
Protractor.prototype.forkNewDriverInstance = null;
249+
220250
/**
221251
* The same as {@code webdriver.WebDriver.prototype.executeScript},
222252
* but with a customized description for debugging.

lib/runner.js

-17
Original file line numberDiff line numberDiff line change
@@ -195,30 +195,13 @@ Runner.prototype.createBrowser = function() {
195195
var self = this;
196196

197197

198-
/**
199-
* @type {q.Promise} Done when the new browser is ready for use
200-
*/
201198
browser_.ready =
202199
driver.manage().timeouts().setScriptTimeout(config.allScriptsTimeout);
203200

204-
/**
205-
* Get the processed configuration object that is currently being run. This
206-
* will contain the specs and capabilities properties of the current runner
207-
* instance.
208-
*
209-
* @return {q.Promise} A promise which resolves to the capabilities object.
210-
*/
211201
browser_.getProcessedConfig = function() {
212202
return webdriver.promise.fulfilled(config);
213203
};
214204

215-
/**
216-
* Fork another instance of protractor for use in interactive tests.
217-
*
218-
* @param {boolean} opt_useSameUrl Whether to navigate to current url on creation
219-
* @param {boolean} opt_copyMockModules Whether to apply same mock modules on creation
220-
* @return {Protractor} a protractor instance.
221-
*/
222205
browser_.forkNewDriverInstance = function(opt_useSameUrl, opt_copyMockModules) {
223206
var newBrowser = self.createBrowser();
224207
if (opt_copyMockModules) {

0 commit comments

Comments
 (0)