Bug 1441019 - Add jsautodoc indices. r?whimboo draft
authorAndreas Tolfsen <ato@sny.no>
Thu, 22 Feb 2018 16:33:45 +0000
changeset 759873 985f13094ba1b93cc36e3412c445afea3de9b891
parent 759872 30b2e6eaaae5f4f99fd1bd0aa3ef01b76dbb41fc
child 759874 0cbafc0c0fc05dd592dbd5c58e863c1d4597f488
push id100500
push userbmo:ato@sny.no
push dateMon, 26 Feb 2018 19:31:26 +0000
reviewerswhimboo
bugs1441019
milestone60.0a1
Bug 1441019 - Add jsautodoc indices. r?whimboo This patch adds RST rules to auto-generate jsdoc in the Sphinx documentation published to http://firefox-source-docs.mozilla.org/. Some of the generation rules, especially element.rst, is quite ugly because it appears JS modules all share the same namespace, and there is already a conflict for element. We should investigate this when it becomes a bigger problem. MozReview-Commit-ID: IfGNMPXmPqG
testing/marionette/doc/internals/action.rst
testing/marionette/doc/internals/addon.rst
testing/marionette/doc/internals/assert.rst
testing/marionette/doc/internals/browser.rst
testing/marionette/doc/internals/capture.rst
testing/marionette/doc/internals/cert.rst
testing/marionette/doc/internals/cookie.rst
testing/marionette/doc/internals/dom.rst
testing/marionette/doc/internals/driver.rst
testing/marionette/doc/internals/element.rst
testing/marionette/doc/internals/error.rst
testing/marionette/doc/internals/evaluate.rst
testing/marionette/doc/internals/event.rst
testing/marionette/doc/internals/format.js
testing/marionette/doc/internals/interaction.rst
testing/marionette/doc/internals/listener.rst
testing/marionette/doc/internals/message.rst
testing/marionette/doc/internals/modal.rst
testing/marionette/doc/internals/navigate.rst
testing/marionette/doc/internals/packets.rst
testing/marionette/doc/internals/proxy.rst
testing/marionette/doc/internals/reftest.rst
testing/marionette/doc/internals/server.rst
testing/marionette/doc/internals/session.rst
testing/marionette/doc/internals/sync.rst
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/action.rst
@@ -0,0 +1,4 @@
+action module
+=============
+.. js:autoclass:: action
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/addon.rst
@@ -0,0 +1,4 @@
+addon module
+============
+.. js:autoclass:: addon
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/assert.rst
@@ -0,0 +1,4 @@
+assert module
+=============
+.. js:autoclass:: assert
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/browser.rst
@@ -0,0 +1,4 @@
+browser module
+==============
+.. js:autoclass:: event
+  :members:
new file mode 100644
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/cert.rst
@@ -0,0 +1,4 @@
+cert module
+===========
+.. js:autoclass:: cert
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/cookie.rst
@@ -0,0 +1,4 @@
+cookie module
+=============
+.. js:autoclass:: cookie
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/dom.rst
@@ -0,0 +1,8 @@
+dom module
+==========
+
+.. js:autoclass:: ContentEventObserverService
+  :members:
+
+.. js:autoclass:: WebElementEventTarget
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/driver.rst
@@ -0,0 +1,4 @@
+driver module
+=============
+.. js:autoclass:: driver
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/element.rst
@@ -0,0 +1,148 @@
+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.findAnonymousNodes
+----------------------------
+.. js:autofunction:: element.findAnonymousNodes
+
+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:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/error.rst
@@ -0,0 +1,2 @@
+error module
+============
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/evaluate.rst
@@ -0,0 +1,4 @@
+evaluate module
+===============
+.. js:autoclass:: evaluate
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/event.rst
@@ -0,0 +1,4 @@
+event module
+============
+.. js:autoclass:: event
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/format.js
@@ -0,0 +1,4 @@
+format module
+=============
+.. js:autoclass:: format
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/interaction.rst
@@ -0,0 +1,4 @@
+interaction module
+==================
+.. js:autoclass:: interaction
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/listener.rst
@@ -0,0 +1,2 @@
+listener module
+============
new file mode 100644
--- /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:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/modal.rst
@@ -0,0 +1,4 @@
+modal module
+============
+.. js:autoclass:: modal
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/navigate.rst
@@ -0,0 +1,7 @@
+navigate module
+===============
+
+isLoadEventExpected
+-------------------
+.. js:autoclass:: navigate.isLoadEventExpected
+  :members:
new file mode 100644
--- /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:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/proxy.rst
@@ -0,0 +1,4 @@
+proxy module
+============
+.. js:autoclass:: proxy
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/reftest.rst
@@ -0,0 +1,4 @@
+reftest module
+==============
+.. js:autoclass:: reftest
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/server.rst
@@ -0,0 +1,4 @@
+server module
+=============
+.. js:autoclass:: server
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/session.rst
@@ -0,0 +1,22 @@
+session module
+==============
+
+Timeouts
+--------
+.. js:autoclass:: session.Timeouts
+  :members:
+
+PageLoadStrategy
+----------------
+.. js:autoclass:: session.PageLoadStrategy
+  :members:
+
+Proxy
+-----
+.. js:autoclass:: session.Proxy
+  :members:
+
+Capabilities
+------------
+.. js:autoclass:: session.Capabilities
+  :members:
new file mode 100644
--- /dev/null
+++ b/testing/marionette/doc/internals/sync.rst
@@ -0,0 +1,10 @@
+sync module
+===========
+
+Provides an assortment of synchronisation primitives.
+
+.. js:autoclass:: PollPromise
+  :members:
+
+.. js:autoclass:: TimedPromise
+  :members: