From 0550e37d7e23bbc8d0fdabe664380035a9bf451c Mon Sep 17 00:00:00 2001 From: Julie Date: Thu, 23 Jan 2014 00:25:02 -0800 Subject: [PATCH] docs(api): regenerate docs api links --- docs/api.md | 148 ++++++++++++++++++++++++++---------------------- docs/gendocs.js | 2 +- 2 files changed, 80 insertions(+), 70 deletions(-) diff --git a/docs/api.md b/docs/api.md index 156540c22..d2d3ee81e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -12,114 +12,120 @@ This file provides an overview and links on where to get more information. API methods and members that are modified or added by Protractor are marked with a `P`. -Documentation generated at 8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a +Documentation generated at fb88e4c9365f4d067ee36a31014c7e67018c5ca0 [WebDriver](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js) and [Protractor](https://github.com/angular/protractor/blob/master/lib/protractor.js) ------------------ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#241) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#242) : `controlFlow` function( ) -> _!webdriver.promise.ControlFlow_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#250) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#251) : `schedule` function( _!webdriver.Command_ _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#302) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#303) : `getSession` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#310) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#311) : `getCapabilities` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#321) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#322) : `getCapability` function( _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#336) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#337) : `quit` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#355) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#356) : `actions` function( ) -> _!webdriver.ActionSequence_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#373) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#374) : `executeScript` function( _!(string|Function)_ _...*_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#422) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#423) : `executeAsyncScript` function( _!(string|Function)_ _...*_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#513) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#514) : `call` function( _!Function_ _Object=_ _...*_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#532) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#533) : `wait` function( _function():boolean_ _number_ _string=_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#548) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#549) : `sleep` function( _number_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#559) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#560) : `getWindowHandle` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#571) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#572) : `getAllWindowHandles` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#583) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#584) : `getPageSource` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#598) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#599) : `close` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#609) [**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L463) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#610) [**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L542) : `get` function( _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#620) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#621) : `getCurrentUrl` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#632) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#633) : `getTitle` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#643) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#644) : `findElement` function( _!(webdriver.Locator|Object.<string>|Element)_ _..._ ) -> _!webdriver.WebElement_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#717) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#718) : `findDomElement_` function( _!Element_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#765) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#766) : `isElementPresent` function( _!(webdriver.Locator|Object.<string>|Element)_ _..._ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#792) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#793) : `findElements` function( _webdriver.Locator|Object.<string>_ _..._ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#828) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#829) : `takeScreenshot` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#847) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#848) : `manage` function( ) -> _!webdriver.WebDriver.Options_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#856) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#857) : `navigate` function( ) -> _!webdriver.WebDriver.Navigation_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#865) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#866) : `switchTo` function( ) -> _!webdriver.WebDriver.TargetLocator_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L235) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L308) : `waitForAngular` function( ) -> _!webdriver.promise.Promise_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L259) : -`wrapWebElement` function( _webdriver.WebElement_ ) +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L337) : +`wrapWebElement` function( _webdriver.WebElement_ ) -> _webdriver.WebElement_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L441) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L520) : `addMockModule` function( _!string_ _!string|Function_ ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L455) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L534) : `clearMockModules` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L498) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L609) : +`getLocationAbsUrl` function( ) + +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L617) : `debugger` function( ) +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L651) : +`findElementsOverrideHelper_` function( _webdriver.WebElement_ _webdriver.Locator_ ) -> _webdriver.WebElement_ + Locator Strategies ------------------ The `findElement`, `findElements`, and `isElementPresent` functions take a _locator strategy_ as their parameter. The following locator strategies -are avaiable) +are available: : @@ -149,25 +155,28 @@ are avaiable) : `Protractor.By.js` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L21) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L21) : +`Protractor.By.addLocator` function( _string_ _function|string_ ) + +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L44) : `Protractor.By.binding` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L43) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L60) : `Protractor.By.select` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L61) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L76) : `Protractor.By.selectedOption` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L79) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L91) : `Protractor.By.input` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L98) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L107) : `Protractor.By.model` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L116) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L122) : `Protractor.By.textarea` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/locators.js#L130) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/locators.js#L138) : `Protractor.By.repeater` function( ) @@ -175,82 +184,83 @@ are avaiable) WebElements ----------- -The `findElement`, `findElements`, and `isElementPresent` functions return -a WebElement object. The following functions are available on WebElements. +The `findElement` function returns a WebElement object and the `findElements` +function returns a promise that resolves to an array of WebElement objects. +The following functions are available on WebElement objects: -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1556) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1559) : `WebElement.getDriver` function( ) -> _!webdriver.WebDriver_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1564) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1567) : `WebElement.toWireValue` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1574) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1577) : `WebElement.schedule_` function( _!webdriver.Command_ _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1591) [**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L382) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1594) [**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L461) : `WebElement.findElement` function( _webdriver.Locator|Object.<string>_ _..._ ) -> _webdriver.WebElement_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1634) [**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L425) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1637) [**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L504) : `WebElement.isElementPresent` function( _webdriver.Locator|Object.<string>_ _..._ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1659) [**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L400) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1662) [**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L479) : `WebElement.findElements` function( _webdriver.Locator|Object.<string>_ _..._ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1686) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1689) : `WebElement.click` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1698) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1701) : `WebElement.sendKeys` function( _...string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1755) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1758) : `WebElement.getTagName` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1767) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1770) : `WebElement.getCssValue` function( _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1791) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1794) : `WebElement.getAttribute` function( _string_ ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1826) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1831) : `WebElement.getText` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1839) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1844) : `WebElement.getSize` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1852) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1857) : `WebElement.getLocation` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1864) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1869) : `WebElement.isEnabled` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1877) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1882) : `WebElement.isSelected` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1889) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1894) : `WebElement.submit` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1903) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1908) : `WebElement.clear` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1917) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1922) : `WebElement.isDisplayed` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1929) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1934) : `WebElement.getOuterHtml` function( ) -> _!webdriver.promise.Promise_ -[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1948) : +[**WD**](https://code.google.com/p/selenium/source/browse/javascript/webdriver/webdriver.js#1953) : `WebElement.getInnerHtml` function( ) -> _!webdriver.promise.Promise_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L87) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L93) : `WebElement.all` function( ) -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L281) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L360) : `WebElement.$` function( _string_ ) -> _!webdriver.WebElement_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L310) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L389) : `WebElement.$$` function( _string_ ) -> _!webdriver.promise.Promise_ -[**P**](https://github.com/angular/protractor/blob/8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a/lib/protractor.js#L363) : +[**P**](https://github.com/angular/protractor/blob/fb88e4c9365f4d067ee36a31014c7e67018c5ca0/lib/protractor.js#L442) : `WebElement.evaluate` function( _string_ ) -> _!webdriver.promise.Promise_ diff --git a/docs/gendocs.js b/docs/gendocs.js index 7d9b66d53..703e865e1 100644 --- a/docs/gendocs.js +++ b/docs/gendocs.js @@ -6,7 +6,7 @@ var mustache = require('mustache'); // and make clear what is webdriver and what is wrapped. But for now, let's // get some docs! -var versionHash ='8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a'; +var versionHash ='fb88e4c9365f4d067ee36a31014c7e67018c5ca0'; var NEW_LINE = /\n\r?/;