Bug 1254521 - Add return type docs for element.isVisible; r=automatedtester a=test-only
authorAndreas Tolfsen <ato@mozilla.com>
Tue, 08 Mar 2016 13:52:38 +0000
changeset 323383 f46e839eb42eac95b994d90f9b4190b00c5cd96f
parent 323382 c9166eb24b3fe9dc52f950bbbf55ce43e39fc5ab
child 323384 7055469046c500356fa7d01212df745ea6da11d2
push id5913
push userjlund@mozilla.com
push dateMon, 25 Apr 2016 16:57:49 +0000
treeherdermozilla-beta@dcaf0a6fa115 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersautomatedtester, test-only
bugs1254521
milestone47.0a2
Bug 1254521 - Add return type docs for element.isVisible; r=automatedtester a=test-only MozReview-Commit-ID: 9tjnHPmYSdq
testing/marionette/element.js
--- a/testing/marionette/element.js
+++ b/testing/marionette/element.js
@@ -807,16 +807,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;
   }