diff options
Diffstat (limited to 'testing/marionette/doc/internals')
28 files changed, 398 insertions, 0 deletions
diff --git a/testing/marionette/doc/internals/action.rst b/testing/marionette/doc/internals/action.rst new file mode 100644 index 0000000000..1f466ee2d8 --- /dev/null +++ b/testing/marionette/doc/internals/action.rst @@ -0,0 +1,4 @@ +action module +============= +.. js:autoclass:: action + :members: diff --git a/testing/marionette/doc/internals/addon.rst b/testing/marionette/doc/internals/addon.rst new file mode 100644 index 0000000000..21a3997807 --- /dev/null +++ b/testing/marionette/doc/internals/addon.rst @@ -0,0 +1,7 @@ +addon module +============ + +Addon +----- +.. js:autoclass:: Addon + :members: diff --git a/testing/marionette/doc/internals/assert.rst b/testing/marionette/doc/internals/assert.rst new file mode 100644 index 0000000000..ec143f6679 --- /dev/null +++ b/testing/marionette/doc/internals/assert.rst @@ -0,0 +1,4 @@ +assert module +============= +.. js:autoclass:: assert + :members: diff --git a/testing/marionette/doc/internals/browser.rst b/testing/marionette/doc/internals/browser.rst new file mode 100644 index 0000000000..ed3839b5c9 --- /dev/null +++ b/testing/marionette/doc/internals/browser.rst @@ -0,0 +1,4 @@ +browser module +============== +.. js:autoclass:: event + :members: diff --git a/testing/marionette/doc/internals/capabilities.rst b/testing/marionette/doc/internals/capabilities.rst new file mode 100644 index 0000000000..2ce5d3b19c --- /dev/null +++ b/testing/marionette/doc/internals/capabilities.rst @@ -0,0 +1,22 @@ +capabilities module +=================== + +Timeouts +-------- +.. js:autoclass:: Timeouts + :members: + +PageLoadStrategy +---------------- +.. js:autoclass:: PageLoadStrategy + :members: + +Proxy +----- +.. js:autoclass:: Proxy + :members: + +Capabilities +------------ +.. js:autoclass:: Capabilities + :members: diff --git a/testing/marionette/doc/internals/capture.rst b/testing/marionette/doc/internals/capture.rst new file mode 100644 index 0000000000..a3abd6b152 --- /dev/null +++ b/testing/marionette/doc/internals/capture.rst @@ -0,0 +1,7 @@ +capture module +============== + +capture.canvas +-------------- +.. js:autoclass:: capture.canvas + :members: diff --git a/testing/marionette/doc/internals/cert.rst b/testing/marionette/doc/internals/cert.rst new file mode 100644 index 0000000000..33e00d7d1e --- /dev/null +++ b/testing/marionette/doc/internals/cert.rst @@ -0,0 +1,4 @@ +cert module +=========== +.. js:autoclass:: allowAllCerts + :members: diff --git a/testing/marionette/doc/internals/cookie.rst b/testing/marionette/doc/internals/cookie.rst new file mode 100644 index 0000000000..502c7f4c2b --- /dev/null +++ b/testing/marionette/doc/internals/cookie.rst @@ -0,0 +1,4 @@ +cookie module +============= +.. js:autoclass:: cookie + :members: diff --git a/testing/marionette/doc/internals/dom.rst b/testing/marionette/doc/internals/dom.rst new file mode 100644 index 0000000000..cc09042fb1 --- /dev/null +++ b/testing/marionette/doc/internals/dom.rst @@ -0,0 +1,8 @@ +dom module +========== + +.. js:autoclass:: ContentEventObserverService + :members: + +.. js:autoclass:: WebElementEventTarget + :members: diff --git a/testing/marionette/doc/internals/driver.rst b/testing/marionette/doc/internals/driver.rst new file mode 100644 index 0000000000..2181395c1f --- /dev/null +++ b/testing/marionette/doc/internals/driver.rst @@ -0,0 +1,4 @@ +driver module +============= +.. js:autoclass:: driver + :members: diff --git a/testing/marionette/doc/internals/element.rst b/testing/marionette/doc/internals/element.rst new file mode 100644 index 0000000000..5fabfc2c34 --- /dev/null +++ b/testing/marionette/doc/internals/element.rst @@ -0,0 +1,144 @@ +element module +============== + +element.Store +------------- +.. js:autoclass:: element.Store + :members: + +element.find +------------ +.. js:autofunction:: element.find + +element.findByXPath +------------------- +.. js:autofunction:: element.findByXPath + +element.findByXPathAll +---------------------- +.. js:autofunction:: element.findByXPathAll + +element.findByLinkText +---------------------- +.. js:autofunction:: element.findByLinkText + +element.findByPartialLinkText +----------------------------- +.. js:autofunction:: element.findByPartialLinkText + +element.findClosest +------------------- +.. js:autofunction:: element.findClosest + +element.isCollection +-------------------- +.. js:autofunction:: element.isCollection + +element.isStale +--------------- +.. js:autofunction:: element.isStale + +element.isSelected +------------------ +.. js:autofunction:: element.isSelected + +element.isReadOnly +------------------ +.. js:autofunction:: element.isReadOnly + +element.isDisabled +------------------ +.. js:autofunction:: element.isDisabled + +element.isMutableFormControl +---------------------------- +.. js:autofunction:: element.isMutableFormControl + +element.isEditingHost +--------------------- +.. js:autofunction:: element.isEditingHost + +element.isEditable +------------------ +.. js:autofunction:: element.isEditable + +element.coordinates +------------------- +.. js:autofunction:: element.coordinates + +element.inViewport +------------------ +.. js:autofunction:: element.inViewport + +element.getContainer +--------------------- +.. js:autofunction:: element.getContainer + +element.isInView +---------------- +.. js:autofunction:: element.isInView + +element.isVisible +----------------- +.. js:autofunction:: element.isVisible + +element.isObscured +------------------ +.. js:autofunction:: element.isObscured + +element.getInViewCentrePoint +---------------------------- +.. js:autofunction:: element.getInViewCentrePoint + +element.getPointerInteractablePaintTree +--------------------------------------- +.. js:autofunction:: element.getPointerInteractablePaintTree + +element.scrollIntoView +---------------------- +.. js:autofunction:: element.scrollIntoView + +element.isElement +----------------- +.. js:autofunction:: element.isElement + +element.isDOMElement +-------------------- +.. js:autofunction:: element.isDOMElement + +element.isXULElement +-------------------- +.. js:autofunction:: element.isXULElement + +element.isDOMWindow +-------------------- +.. js:autofunction:: element.isDOMWindow + +element.isBooleanAttribute +-------------------------- +.. js:autofunction:: element.isBooleanAttribute + +ChromeWebElement +---------------- +.. js:autoclass:: ChromeWebElement + :members: + +ContentWebElement +----------------- +.. js:autoclass:: ContentWebElement + :members: + +ContentWebFrame +--------------- +.. js:autoclass:: ContentWebFrame + :members: + +ContentWebWindow +---------------- +.. js:autoclass:: ContentWebWindow + :members: + +WebElement +---------- +.. js:autoclass:: WebElement + :members: diff --git a/testing/marionette/doc/internals/error.rst b/testing/marionette/doc/internals/error.rst new file mode 100644 index 0000000000..fb012af737 --- /dev/null +++ b/testing/marionette/doc/internals/error.rst @@ -0,0 +1,35 @@ +error module +============ + +.. js:autofunction:: error.isError +.. js:autofunction:: error.isWebDriverError +.. js:autofunction:: error.wrap +.. js:autofunction:: error.report +.. js:autofunction:: error.stringify +.. js:autofunction:: stack + +.. js:autoclass:: ElementClickInterceptedError +.. js:autoclass:: ElementNotAccessibleError +.. js:autoclass:: ElementNotInteractableError +.. js:autoclass:: InsecureCertificateError +.. js:autoclass:: InvalidArgumentError +.. js:autoclass:: InvalidCookieDomainError +.. js:autoclass:: InvalidElementStateError +.. js:autoclass:: InvalidSelectorError +.. js:autoclass:: InvalidSessionIDError +.. js:autoclass:: JavaScriptError +.. js:autoclass:: MoveTargetOutOfBoundsError +.. js:autoclass:: NoSuchAlertError +.. js:autoclass:: NoSuchElementError +.. js:autoclass:: NoSuchFrameError +.. js:autoclass:: NoSuchWindowError +.. js:autoclass:: ScriptTimeoutError +.. js:autoclass:: SessionNotCreatedError +.. js:autoclass:: StaleElementReferenceError +.. js:autoclass:: TimeoutError +.. js:autoclass:: UnableToSetCookieError +.. js:autoclass:: UnexpectedAlertOpenError +.. js:autoclass:: UnknownCommandError +.. js:autoclass:: UnknownError +.. js:autoclass:: UnsupportedOperationError +.. js:autoclass:: WebDriverError diff --git a/testing/marionette/doc/internals/evaluate.rst b/testing/marionette/doc/internals/evaluate.rst new file mode 100644 index 0000000000..8cbf4448d6 --- /dev/null +++ b/testing/marionette/doc/internals/evaluate.rst @@ -0,0 +1,4 @@ +evaluate module +=============== +.. js:autoclass:: evaluate + :members: diff --git a/testing/marionette/doc/internals/event.rst b/testing/marionette/doc/internals/event.rst new file mode 100644 index 0000000000..296d1b4bdb --- /dev/null +++ b/testing/marionette/doc/internals/event.rst @@ -0,0 +1,4 @@ +event module +============ +.. js:autoclass:: event + :members: diff --git a/testing/marionette/doc/internals/format.rst b/testing/marionette/doc/internals/format.rst new file mode 100644 index 0000000000..0d90c6375b --- /dev/null +++ b/testing/marionette/doc/internals/format.rst @@ -0,0 +1,11 @@ +format module +============= + + +pprint +------ +.. js:autofunction:: pprint + +truncate +-------- +.. js:autofunction:: truncate diff --git a/testing/marionette/doc/internals/index.rst b/testing/marionette/doc/internals/index.rst new file mode 100644 index 0000000000..a52012e0bf --- /dev/null +++ b/testing/marionette/doc/internals/index.rst @@ -0,0 +1,11 @@ +========= +Internals +========= + +This is an overview of all documented internals in the Marionette server: + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/testing/marionette/doc/internals/interaction.rst b/testing/marionette/doc/internals/interaction.rst new file mode 100644 index 0000000000..298fd5a0f0 --- /dev/null +++ b/testing/marionette/doc/internals/interaction.rst @@ -0,0 +1,4 @@ +interaction module +================== +.. js:autoclass:: interaction + :members: diff --git a/testing/marionette/doc/internals/listener.rst b/testing/marionette/doc/internals/listener.rst new file mode 100644 index 0000000000..4e6b49d0d3 --- /dev/null +++ b/testing/marionette/doc/internals/listener.rst @@ -0,0 +1,2 @@ +listener module +=============== diff --git a/testing/marionette/doc/internals/log.rst b/testing/marionette/doc/internals/log.rst new file mode 100644 index 0000000000..bf8dad1369 --- /dev/null +++ b/testing/marionette/doc/internals/log.rst @@ -0,0 +1,4 @@ +log module +========== +.. js:autoclass:: Log + :members: diff --git a/testing/marionette/doc/internals/message.rst b/testing/marionette/doc/internals/message.rst new file mode 100644 index 0000000000..c44005a5d7 --- /dev/null +++ b/testing/marionette/doc/internals/message.rst @@ -0,0 +1,17 @@ +message module +============== + +Command +------- +.. js:autoclass:: Command + :members: + +Message +------- +.. js:autoclass:: Message + :members: + +Response +-------- +.. js:autoclass:: Response + :members: diff --git a/testing/marionette/doc/internals/modal.rst b/testing/marionette/doc/internals/modal.rst new file mode 100644 index 0000000000..5a9b30ba50 --- /dev/null +++ b/testing/marionette/doc/internals/modal.rst @@ -0,0 +1,4 @@ +modal module +============ +.. js:autoclass:: modal + :members: diff --git a/testing/marionette/doc/internals/navigate.rst b/testing/marionette/doc/internals/navigate.rst new file mode 100644 index 0000000000..4141c79d3c --- /dev/null +++ b/testing/marionette/doc/internals/navigate.rst @@ -0,0 +1,7 @@ +navigate module +=============== + +isLoadEventExpected +------------------- +.. js:autoclass:: navigate.isLoadEventExpected + :members: diff --git a/testing/marionette/doc/internals/packets.rst b/testing/marionette/doc/internals/packets.rst new file mode 100644 index 0000000000..5bc76d48af --- /dev/null +++ b/testing/marionette/doc/internals/packets.rst @@ -0,0 +1,22 @@ +packets module +============== + +RawPacket +--------- +.. js:autoclass:: RawPacket + :members: + +Packet +------ +.. js:autoclass:: Packet + :members: + +JSONPacket +---------- +.. js:autoclass:: JSONPacket + :members: + +BulkPacket +---------- +.. js:autoclass:: BulkPacket + :members: diff --git a/testing/marionette/doc/internals/prefs.rst b/testing/marionette/doc/internals/prefs.rst new file mode 100644 index 0000000000..d54383b70f --- /dev/null +++ b/testing/marionette/doc/internals/prefs.rst @@ -0,0 +1,17 @@ +prefs module +============ + +Branch +------ +.. js:autoclass:: Branch + :members: + +EnvironmentPrefs +---------------- +.. js:autoclass:: EnvironmentPrefs + :members: + +MarionetteBranch +---------------- +.. js:autoclass:: MarionetteBranch + :members: diff --git a/testing/marionette/doc/internals/proxy.rst b/testing/marionette/doc/internals/proxy.rst new file mode 100644 index 0000000000..fe7a775c62 --- /dev/null +++ b/testing/marionette/doc/internals/proxy.rst @@ -0,0 +1,4 @@ +proxy module +============ +.. js:autoclass:: proxy + :members: diff --git a/testing/marionette/doc/internals/reftest.rst b/testing/marionette/doc/internals/reftest.rst new file mode 100644 index 0000000000..85e811850c --- /dev/null +++ b/testing/marionette/doc/internals/reftest.rst @@ -0,0 +1,4 @@ +reftest module +============== +.. js:autoclass:: reftest + :members: diff --git a/testing/marionette/doc/internals/server.rst b/testing/marionette/doc/internals/server.rst new file mode 100644 index 0000000000..8b2f1c391b --- /dev/null +++ b/testing/marionette/doc/internals/server.rst @@ -0,0 +1,12 @@ +server module +============= + +TCPConnection +------------- +.. js:autoclass:: TCPConnection + :members: + +TCPListener +----------- +.. js:autoclass:: TCPListener + :members: diff --git a/testing/marionette/doc/internals/sync.rst b/testing/marionette/doc/internals/sync.rst new file mode 100644 index 0000000000..3ec1ac3f31 --- /dev/null +++ b/testing/marionette/doc/internals/sync.rst @@ -0,0 +1,24 @@ +sync module +=========== + +Provides an assortment of synchronisation primitives. + +.. js:autofunction:: executeSoon + +.. js:autoclass:: MessageManagerDestroyedPromise + :members: + +.. js:autoclass:: PollPromise + :members: + +.. js:autoclass:: Sleep + :members: + +.. js:autoclass:: TimedPromise + :members: + +.. js:autofunction:: waitForEvent + +.. js:autofunction:: waitForMessage + +.. js:autofunction:: waitForObserverTopic |