Bug 1254521 - Add return type docs for element.isVisible; r?automatedtester draft
authorAndreas Tolfsen <ato@mozilla.com>
Tue, 08 Mar 2016 13:52:38 +0000
changeset 338107 dadb4135791341f044a3cf2b97fff5291d40d374
parent 338095 05c087337043dd8e71cc27bdb5b9d55fd00aaa26
child 338108 b064cc04ce1277f053e22bb00e0c32293fe56cb6
push id12428
push userbmo:ato@mozilla.com
push dateTue, 08 Mar 2016 14:00:49 +0000
reviewersautomatedtester
bugs1254521
milestone48.0a1
Bug 1254521 - Add return type docs for element.isVisible; r?automatedtester MozReview-Commit-ID: 9tjnHPmYSdq
testing/marionette/element.js
--- a/testing/marionette/element.js
+++ b/testing/marionette/element.js
@@ -809,16 +809,19 @@ element.inViewport = function(el, x = un
  * @param {Window} window
  *     Window object.
  * @param {number=} x
  *     Horizontal offset relative to target.  Defaults to the centre of
  *     the target's bounding box.
  * @param {number=} y
  *     Vertical offset relative to target.  Defaults to the centre of
  *     the target's bounding box.
+ *
+ * @return {boolean}
+ *     True if visible, false otherwise.
  */
 element.isVisible = function(el, x = undefined, y = undefined) {
   let win = el.ownerDocument.defaultView;
 
   // Bug 1094246: webdriver's isShown doesn't work with content xul
   if (!element.isXULElement(el) && !atom.isElementDisplayed(el, win)) {
     return false;
   }