codeceptjs 2.1.3 → 2.2.1

package/docs/build/Nightmare.js

@@ -81,6 +81,9 @@ class Nightmare extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 
@@ -393,21 +396,18 @@ class Nightmare extends Helper {
 
   /**
    * Opens a web page in a browser. Requires relative or absolute url.
-If url starts with `/`, opens a web page of a site defined in `url` config parameter.
-
-```js
-I.amOnPage('/'); // opens main page of website
-I.amOnPage('https://github.com'); // opens github
-I.amOnPage('/login'); // opens a login page
-```
-
-@param url url path or global url.
-   *
-   * In a second argument a list of request headers can be passed:
-   *
+   * If url starts with `/`, opens a web page of a site defined in `url` config parameter.
+   * 
    * ```js
-   * I.amOnPage('/auth', { 'x-my-custom-header': 'some value' })
+   * I.amOnPage('/'); // opens main page of website
+   * I.amOnPage('https://github.com'); // opens github
+   * I.amOnPage('/login'); // opens a login page
    * ```
+   * 
+   * @param {string} url url path or global url.
+   * {--end--}
+   * @param headers {object} list of request headers can be passed
+   *
    */
   async amOnPage(url, headers = null) {
     if (!(/^\w+\:\/\//.test(url))) {
@@ -427,8 +427,13 @@ I.amOnPage('/login'); // opens a login page
 
   /**
    * Checks that title contains text.
-
-@param text text value to check.
+   * 
+   * ```js
+   * I.seeInTitle('Home Page');
+   * ```
+   * 
+   * @param {string} text text value to check.
+   * {--end--}
    */
   async seeInTitle(text) {
     const title = await this.browser.title();
@@ -437,8 +442,13 @@ I.amOnPage('/login'); // opens a login page
 
   /**
    * Checks that title does not contain text.
-
-@param text text value to check.
+   * 
+   * ```js
+   * I.dontSeeInTitle('Error');
+   * ```
+   * 
+   * @param {string} text value to check.
+   * {--end--}
    */
   async dontSeeInTitle(text) {
     const title = await this.browser.title();
@@ -447,11 +457,14 @@ I.amOnPage('/login'); // opens a login page
 
   /**
    * Retrieves a page title and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let title = await I.grabTitle();
-```
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let title = await I.grabTitle();
+   * ```
+   * 
+   * @returns {Promise<string>} title
+   * {--end--}
    */
   async grabTitle() {
     return this.browser.title();
@@ -459,12 +472,15 @@ let title = await I.grabTitle();
 
   /**
    * Get current URL from browser.
-Resumes test execution, so should be used inside an async function.
-
-```js
-let url = await I.grabCurrentUrl();
-console.log(`Current URL is [${url}]`);
-```
+   * Resumes test execution, so should be used inside an async function.
+   * 
+   * ```js
+   * let url = await I.grabCurrentUrl();
+   * console.log(`Current URL is [${url}]`);
+   * ```
+   * 
+   * @returns {Promise<string>} current URL
+   * {--end--}
    */
   async grabCurrentUrl() {
     return this.browser.url();
@@ -472,12 +488,13 @@ console.log(`Current URL is [${url}]`);
 
   /**
    * Checks that current url contains a provided fragment.
-
-```js
-I.seeInCurrentUrl('/register'); // we are on registration page
-```
-
-@param url value to check.
+   * 
+   * ```js
+   * I.seeInCurrentUrl('/register'); // we are on registration page
+   * ```
+   * 
+   * @param {string} url a fragment to check
+   * {--end--}
    */
   async seeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -486,8 +503,9 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
   /**
    * Checks that current url does not contain a provided fragment.
-
-@param url value to check.
+   * 
+   * @param {string} url value to check.
+   * {--end--}
    */
   async dontSeeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -496,15 +514,16 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
   /**
    * Checks that current url is equal to provided one.
-If a relative url provided, a configured url will be prepended to it.
-So both examples will work:
-
-```js
-I.seeCurrentUrlEquals('/register');
-I.seeCurrentUrlEquals('http://my.site.com/register');
-```
-
-@param url value to check.
+   * If a relative url provided, a configured url will be prepended to it.
+   * So both examples will work:
+   * 
+   * ```js
+   * I.seeCurrentUrlEquals('/register');
+   * I.seeCurrentUrlEquals('http://my.site.com/register');
+   * ```
+   * 
+   * @param {string} url value to check.
+   * {--end--}
    */
   async seeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -513,9 +532,15 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
   /**
    * Checks that current url is not equal to provided one.
-If a relative url provided, a configured url will be prepended to it.
-
-@param url value to check.
+   * If a relative url provided, a configured url will be prepended to it.
+   * 
+   * ```js
+   * I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
+   * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
+   * ```
+   * 
+   * @param {string} url value to check.
+   * {--end--}
    */
   async dontSeeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -524,15 +549,16 @@ If a relative url provided, a configured url will be prepended to it.
 
   /**
    * Checks that a page contains a visible text.
-Use context parameter to narrow down the search.
-
-```js
-I.see('Welcome'); // text welcome on a page
-I.see('Welcome', '.content'); // text inside .content div
-I.see('Register', {css: 'form.register'}); // use strict locator
-```
-@param text expected on page.
-@param context (optional) element located by CSS|Xpath|strict locator in which to search for text.
+   * Use context parameter to narrow down the search.
+   * 
+   * ```js
+   * I.see('Welcome'); // text welcome on a page
+   * I.see('Welcome', '.content'); // text inside .content div
+   * I.see('Register', {css: 'form.register'}); // use strict locator
+   * ```
+   * @param {string} text expected on page.
+   * @param {string|object} context (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+   * {--end--}
    */
   async see(text, context = null) {
     return proceedSee.call(this, 'assert', text, context);
@@ -540,13 +566,17 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
   /**
    * Opposite to `see`. Checks that a text is not present on a page.
-Use context parameter to narrow down the search.
-
-```js
-I.dontSee('Login'); // assume we are already logged in
-```
-@param text is not present.
-@param context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+   * Use context parameter to narrow down the search.
+   * 
+   * ```js
+   * I.dontSee('Login'); // assume we are already logged in.
+   * I.dontSee('Login', '.nav'); // no login inside .nav element
+   * ```
+   * 
+   * @param {string} text which is not present.
+   * @param {string|object} context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+   *
+   * {--end--}
    */
   dontSee(text, context = null) {
     return proceedSee.call(this, 'negate', text, context);
@@ -554,12 +584,13 @@ I.dontSee('Login'); // assume we are already logged in
 
   /**
    * Checks that a given Element is visible
-Element is located by CSS or XPath.
-
-```js
-I.seeElement('#modal');
-```
-@param locator located by CSS|XPath|strict locator.
+   * Element is located by CSS or XPath.
+   * 
+   * ```js
+   * I.seeElement('#modal');
+   * ```
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * {--end--}
    */
   async seeElement(locator) {
     locator = new Locator(locator, 'css');
@@ -571,8 +602,13 @@ I.seeElement('#modal');
 
   /**
    * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
-
-@param locator located by CSS|XPath|Strict locator.
+   * 
+   * ```js
+   * I.dontSeeElement('.modal'); // modal is not shown
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|Strict locator.
+   * {--end--}
    */
   async dontSeeElement(locator) {
     locator = new Locator(locator, 'css');
@@ -585,12 +621,13 @@ I.seeElement('#modal');
 
   /**
    * Checks that a given Element is present in the DOM
-Element is located by CSS or XPath.
-
-```js
-I.seeElementInDOM('#modal');
-```
-@param locator located by CSS|XPath|strict locator.
+   * Element is located by CSS or XPath.
+   * 
+   * ```js
+   * I.seeElementInDOM('#modal');
+   * ```
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * {--end--}
    */
   async seeElementInDOM(locator) {
     locator = new Locator(locator, 'css');
@@ -600,8 +637,13 @@ I.seeElementInDOM('#modal');
 
   /**
    * Opposite to `seeElementInDOM`. Checks that element is not on page.
-
-@param locator located by CSS|XPath|Strict locator.
+   * 
+   * ```js
+   * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|Strict locator.
+   * {--end--}
    */
   async dontSeeElementInDOM(locator) {
     locator = new Locator(locator, 'css');
@@ -611,11 +653,12 @@ I.seeElementInDOM('#modal');
 
   /**
    * Checks that the current page contains the given string in its raw source code.
-
-```js
-I.seeInSource('<h1>Green eggs &amp; ham</h1>');
-```
-@param text value to check.
+   * 
+   * ```js
+   * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
+   * ```
+   * @param {string} text value to check.
+   * {--end--}
    */
   async seeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -624,9 +667,13 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
   /**
    * Checks that the current page does not contains the given string in its raw source code.
-
-@param text value to check.
-
+   * 
+   * ```js
+   * I.dontSeeInSource('<!--'); // no comments in source
+   * ```
+   * 
+   * @param {string} value to check.
+   * {--end--}
    */
   async dontSeeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -634,28 +681,34 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
   }
 
   /**
-   * asserts that an element appears a given number of times in the DOM
+   * Asserts that an element appears a given number of times in the DOM.
    * Element is located by label or name or CSS or XPath.
-   *
+   * 
+   * 
    * ```js
    * I.seeNumberOfElements('#submitBtn', 1);
    * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} num number of elements.
+   * {--end--}
    */
-  async seeNumberOfElements(selector, num) {
-    const elements = await this._locate(selector);
-    return equals(`expected number of elements (${selector}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
+  async seeNumberOfElements(locator, num) {
+    const elements = await this._locate(locator);
+    return equals(`expected number of elements (${locator}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
   }
 
   /**
    * Asserts that an element is visible a given number of times.
-Element is located by CSS or XPath.
-
-```js
-I.seeNumberOfVisibleElements('.buttons', 3);
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param num number of elements.
+   * Element is located by CSS or XPath.
+   * 
+   * ```js
+   * I.seeNumberOfVisibleElements('.buttons', 3);
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} num number of elements.
+   * {--end--}
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
@@ -664,12 +717,14 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
   /**
    * Grab number of visible elements by locator.
-
-```js
-I.grabNumberOfVisibleElements('p');
-```
-
-@param locator located by CSS|XPath|strict locator.
+   * 
+   * ```js
+   * let numOfElements = await I.grabNumberOfVisibleElements('p');
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @returns {Promise<number>} number of visible elements
+   * {--end--}
    */
   async grabNumberOfVisibleElements(locator) {
     locator = new Locator(locator, 'css');
@@ -684,29 +739,30 @@ I.grabNumberOfVisibleElements('p');
 
   /**
    * Perform a click on a link or a button, given by a locator.
-If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
-For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
-For images, the "alt" attribute and inner text of any parent links are searched.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-// simple link
-I.click('Logout');
-// button of form
-I.click('Submit');
-// CSS button
-I.click('#form input[type=submit]');
-// XPath
-I.click('//form/*[@type=submit]');
-// link in context
-I.click('Logout', '#nav');
-// using strict locator
-I.click({css: 'nav a.login'});
-```
-
-@param locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param context (optional) element to search in CSS|XPath|Strict locator.
+   * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+   * For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+   * For images, the "alt" attribute and inner text of any parent links are searched.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * // simple link
+   * I.click('Logout');
+   * // button of form
+   * I.click('Submit');
+   * // CSS button
+   * I.click('#form input[type=submit]');
+   * // XPath
+   * I.click('//form/*[@type=submit]');
+   * // link in context
+   * I.click('Logout', '#nav');
+   * // using strict locator
+   * I.click({css: 'nav a.login'});
+   * ```
+   * 
+   * @param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+   * @param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * {--end--}
    */
   async click(locator, context = null) {
     const el = await findClickable.call(this, locator, context);
@@ -717,17 +773,18 @@ I.click({css: 'nav a.login'});
 
   /**
    * Performs a double-click on an element matched by link|button|label|CSS or XPath.
-Context can be specified as second parameter to narrow search.
-
-```js
-I.doubleClick('Edit');
-I.doubleClick('Edit', '.actions');
-I.doubleClick({css: 'button.accept'});
-I.doubleClick('.btn.edit');
-```
-
-@param locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param context (optional) element to search in CSS|XPath|Strict locator.
+   * Context can be specified as second parameter to narrow search.
+   * 
+   * ```js
+   * I.doubleClick('Edit');
+   * I.doubleClick('Edit', '.actions');
+   * I.doubleClick({css: 'button.accept'});
+   * I.doubleClick('.btn.edit');
+   * ```
+   * 
+   * @param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+   * @param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * {--end--}
    */
   async doubleClick(locator, context = null) {
     const el = await findClickable.call(this, locator, context);
@@ -739,19 +796,19 @@ I.doubleClick('.btn.edit');
 
   /**
    * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
-
-```js
-// right click element with id el
-I.rightClick('#el');
-// right click link or button with text "Click me"
-I.rightClick('Click me');
-// right click button with text "Click me" inside .context
-I.rightClick('Click me', '.context');
-```
-
-@param locator clickable element located by CSS|XPath|strict locator.
-@param context (optional) element located by CSS|XPath|strict locator.
-
+   * 
+   * ```js
+   * // right click element with id el
+   * I.rightClick('#el');
+   * // right click link or button with text "Click me"
+   * I.rightClick('Click me');
+   * // right click button with text "Click me" inside .context
+   * I.rightClick('Click me', '.context');
+   * ```
+   * 
+   * @param {string|object} locator clickable element located by CSS|XPath|strict locator.
+   * @param {string|object} context (optional, `null` by default) element located by CSS|XPath|strict locator.
+   * {--end--}
    */
   async rightClick(locator, context = null) {
     const el = await findClickable.call(this, locator, context);
@@ -763,16 +820,17 @@ I.rightClick('Click me', '.context');
 
   /**
    * Moves cursor to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-```js
-I.moveCursorTo('.tooltip');
-I.moveCursorTo('#submit', 5,5);
-```
-
-@param locator located by CSS|XPath|strict locator.
-@param offsetX (optional) X-axis offset.
-@param offsetY (optional) Y-axis offset.
+   * Extra shift can be set with offsetX and offsetY options.
+   * 
+   * ```js
+   * I.moveCursorTo('.tooltip');
+   * I.moveCursorTo('#submit', 5,5);
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {number} offsetX (optional, `0` by default) X-axis offset.
+   * @param {number} offsetY (optional, `0` by default) Y-axis offset.
+   * {--end--}
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
     locator = new Locator(locator, 'css');
@@ -785,30 +843,31 @@ I.moveCursorTo('#submit', 5,5);
 
   /**
    * Executes sync script on a page.
-Pass arguments to function as additional parameters.
-Will return execution result to a test.
-In this case you should use async function and await to receive results.
-
-Example with jQuery DatePicker:
-
-```js
-// change date of jQuery DatePicker
-I.executeScript(function() {
-  // now we are inside browser context
-  $('date').datetimepicker('setDate', new Date());
-});
-```
-Can return values. Don't forget to use `await` to get them.
-
-```js
-let date = await I.executeScript(function(el) {
-  // only basic types can be returned
-  return $(el).datetimepicker('getDate').toString();
-}, '#date'); // passing jquery selector
-```
-
-@param fn function to be executed in browser context.
-@param ...args args to be passed to function.
+   * Pass arguments to function as additional parameters.
+   * Will return execution result to a test.
+   * In this case you should use async function and await to receive results.
+   * 
+   * Example with jQuery DatePicker:
+   * 
+   * ```js
+   * // change date of jQuery DatePicker
+   * I.executeScript(function() {
+   *   // now we are inside browser context
+   *   $('date').datetimepicker('setDate', new Date());
+   * });
+   * ```
+   * Can return values. Don't forget to use `await` to get them.
+   * 
+   * ```js
+   * let date = await I.executeScript(function(el) {
+   *   // only basic types can be returned
+   *   return $(el).datetimepicker('getDate').toString();
+   * }, '#date'); // passing jquery selector
+   * ```
+   * 
+   * @param {string|function} fn function to be executed in browser context.
+   * @param ...args args to be passed to function.
+   * {--end--}
    *
    * Wrapper for synchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2)
    */
@@ -819,28 +878,29 @@ let date = await I.executeScript(function(el) {
 
   /**
    * Executes async script on page.
-Provided function should execute a passed callback (as first argument) to signal it is finished.
-
-Example: In Vue.js to make components completely rendered we are waiting for [nextTick](https://vuejs.org/v2/api/#Vue-nextTick).
-
-```js
-I.executeAsyncScript(function(done) {
-  Vue.nextTick(done); // waiting for next tick
-});
-```
-
-By passing value to `done()` function you can return values.
-Additional arguments can be passed as well, while `done` function is always last parameter in arguments list.
-
-```js
-let val = await I.executeAsyncScript(function(url, done) {
-  // in browser context
-  $.ajax(url, { success: (data) => done(data); }
-}, 'http://ajax.callback.url/');
-```
-
-@param fn function to be executed in browser context.
-@param ...args args to be passed to function.
+   * Provided function should execute a passed callback (as first argument) to signal it is finished.
+   * 
+   * Example: In Vue.js to make components completely rendered we are waiting for [nextTick](https://vuejs.org/v2/api/#Vue-nextTick).
+   * 
+   * ```js
+   * I.executeAsyncScript(function(done) {
+   *   Vue.nextTick(done); // waiting for next tick
+   * });
+   * ```
+   * 
+   * By passing value to `done()` function you can return values.
+   * Additional arguments can be passed as well, while `done` function is always last parameter in arguments list.
+   * 
+   * ```js
+   * let val = await I.executeAsyncScript(function(url, done) {
+   *   // in browser context
+   *   $.ajax(url, { success: (data) => done(data); }
+   * }, 'http://ajax.callback.url/');
+   * ```
+   * 
+   * @param {string|function} fn function to be executed in browser context.
+   * @param ...args args to be passed to function.
+   * {--end--}
    *
    * Wrapper for asynchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2).
    * Unlike NightmareJS implementation calling `done` will return its first argument.
@@ -852,10 +912,11 @@ let val = await I.executeAsyncScript(function(url, done) {
 
   /**
    * Resize the current window to provided width and height.
-First parameter can be set to `maximize`.
-
-@param width width in pixels or `maximize`.
-@param height height in pixels.
+   * First parameter can be set to `maximize`.
+   * 
+   * @param {number} width width in pixels or `maximize`.
+   * @param {number} height height in pixels.
+   * {--end--}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -866,17 +927,18 @@ First parameter can be set to `maximize`.
 
   /**
    * Selects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.checkOption('#agree');
-I.checkOption('I Agree to Terms and Conditions');
-I.checkOption('agree', '//form');
-```
-@param field checkbox located by label | name | CSS | XPath | strict locator.
-@param context (optional) element located by CSS | XPath | strict locator.
+   * Element is located by label or name or CSS or XPath.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * I.checkOption('#agree');
+   * I.checkOption('I Agree to Terms and Conditions');
+   * I.checkOption('agree', '//form');
+   * ```
+   * @param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
+   * @param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * {--end--}
    */
   async checkOption(field, context = null) {
     const els = await findCheckable.call(this, field, context);
@@ -886,22 +948,44 @@ I.checkOption('agree', '//form');
   }
 
   /**
-   * Fills a text field or textarea, after clearing its value, with the given string.
-Field is located by name, label, CSS, or XPath.
-
-```js
-// by label
-I.fillField('Email', 'hello@world.com');
-// by name
-I.fillField('password', secret('123456'));
-// by CSS
-I.fillField('form#login input[name=username]', 'John');
-// or by strict locator
-I.fillField({css: 'form#login input[name=username]'}, 'John');
-```
-@param field located by label|name|CSS|XPath|strict locator.
-@param value text value to fill.
+   * Unselects a checkbox or radio button.
+   * Element is located by label or name or CSS or XPath.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * I.uncheckOption('#agree');
+   * I.uncheckOption('I Agree to Terms and Conditions');
+   * I.uncheckOption('agree', '//form');
+   * ```
+   * @param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
+   * @param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * {--end--}
+   */
+  async uncheckOption(field, context = null) {
+    const els = await findCheckable.call(this, field, context);
+    assertElementExists(els[0], field, 'Checkbox or radio');
+    return this.browser.evaluate(els => window.codeceptjs.unCheckEl(els[0]), els)
+      .wait(this.options.waitForAction);
+  }
 
+  /**
+   * Fills a text field or textarea, after clearing its value, with the given string.
+   * Field is located by name, label, CSS, or XPath.
+   * 
+   * ```js
+   * // by label
+   * I.fillField('Email', 'hello@world.com');
+   * // by name
+   * I.fillField('password', secret('123456'));
+   * // by CSS
+   * I.fillField('form#login input[name=username]', 'John');
+   * // or by strict locator
+   * I.fillField({css: 'form#login input[name=username]'}, 'John');
+   * ```
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string} value text value to fill.
+   * {--end--}
    */
   async fillField(field, value) {
     const el = await findField.call(this, field);
@@ -912,13 +996,14 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
   /**
    * Clears a `<textarea>` or text `<input>` element's value.
-
-```js
-I.clearField('Email');
-I.clearField('user[email]');
-I.clearField('#email');
-```
-@param field located by label|name|CSS|XPath|strict locator.
+   * 
+   * ```js
+   * I.clearField('Email');
+   * I.clearField('user[email]');
+   * I.clearField('#email');
+   * ```
+   * @param {string|object} editable field located by label|name|CSS|XPath|strict locator.
+   * {--end--}
    */
   async clearField(field) {
     return this.fillField(field, '');
@@ -926,13 +1011,14 @@ I.clearField('#email');
 
   /**
    * Appends text to a input field or textarea.
-Field is located by name, label, CSS or XPath
-
-```js
-I.appendField('#myTextField', 'appended');
-```
-@param field located by label|name|CSS|XPath|strict locator
-@param value text value to append.
+   * Field is located by name, label, CSS or XPath
+   * 
+   * ```js
+   * I.appendField('#myTextField', 'appended');
+   * ```
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator
+   * @param {string} value text value to append.
+   * {--end--}
    */
   async appendField(field, value) {
     const el = await findField.call(this, field);
@@ -943,16 +1029,17 @@ I.appendField('#myTextField', 'appended');
 
   /**
    * Checks that the given input field or textarea equals to given value.
-For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
-
-```js
-I.seeInField('Username', 'davert');
-I.seeInField({css: 'form textarea'},'Type your comment here');
-I.seeInField('form input[type=hidden]','hidden_value');
-I.seeInField('#searchform input','Search');
-```
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+   * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
+   * 
+   * ```js
+   * I.seeInField('Username', 'davert');
+   * I.seeInField({css: 'form textarea'},'Type your comment here');
+   * I.seeInField('form input[type=hidden]','hidden_value');
+   * I.seeInField('#searchform input','Search');
+   * ```
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string} value value to check.
+   * {--end--}
    */
   async seeInField(field, value) {
     return proceedSeeInField.call(this, 'assert', field, value);
@@ -960,10 +1047,16 @@ I.seeInField('#searchform input','Search');
 
   /**
    * Checks that value of input field or textare doesn't equal to given value
-Opposite to `seeInField`.
-
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+   * Opposite to `seeInField`.
+   * 
+   * ```js
+   * I.dontSeeInField('email', 'user@user.com'); // field by name
+   * I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
+   * ```
+   * 
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string} value value to check.
+   * {--end--}
    */
   async dontSeeInField(field, value) {
     return proceedSeeInField.call(this, 'negate', field, value);
@@ -999,13 +1092,15 @@ Opposite to `seeInField`.
 
   /**
    * Verifies that the specified checkbox is checked.
-
-```js
-I.seeCheckboxIsChecked('Agree');
-I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
-I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
-```
-@param field located by label|name|CSS|XPath|strict locator.
+   * 
+   * ```js
+   * I.seeCheckboxIsChecked('Agree');
+   * I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
+   * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
+   * ```
+   * 
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * {--end--}
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -1013,8 +1108,15 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
   /**
    * Verifies that the specified checkbox is not checked.
-
-@param field located by label|name|CSS|XPath|strict locator.
+   * 
+   * ```js
+   * I.dontSeeeCheckboxIsChedcked('#agree'); // located by ID
+   * I.dontSeeeCheckboxIsChedcked('I agree to terms'); // located by label
+   * I.dontSeeeCheckboxIsChedcked('agree'); // located by name
+   * ```
+   * 
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * {--end--}
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -1022,21 +1124,21 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
   /**
    * Attaches a file to element located by label, name, CSS or XPath
-Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
-File will be uploaded to remote system (if tests are running remotely).
-
-```js
-I.attachFile('Avatar', 'data/avatar.jpg');
-I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
-```
-
-@param locator field located by label|name|CSS|XPath|strict locator.
-@param pathToFile local file path relative to codecept.json config file.
+   * Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
+   * File will be uploaded to remote system (if tests are running remotely).
+   * 
+   * ```js
+   * I.attachFile('Avatar', 'data/avatar.jpg');
+   * I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
+   * ```
+   * 
+   * @param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {string} pathToFile local file path relative to codecept.json config file.
+   * {--end--}
    *
-   * ##### Limitations:
+   * Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more](https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs))
    *
-   * * works only with CSS selectors.
-   * * doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more](https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs))
+   * @param locator CSS locator (XPath not allowed)
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -1054,14 +1156,16 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
   /**
    * Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let pin = await I.grabTextFrom('#pin');
-```
-If multiple elements found returns an array of texts.
-
-@param locator element located by CSS|XPath|strict locator.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let pin = await I.grabTextFrom('#pin');
+   * ```
+   * If multiple elements found returns an array of texts.
+   * 
+   * @param locator element located by CSS|XPath|strict locator.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
    */
   async grabTextFrom(locator) {
     locator = new Locator(locator, 'css');
@@ -1078,12 +1182,14 @@ If multiple elements found returns an array of texts.
 
   /**
    * Retrieves a value from a form element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let email = await I.grabValueFrom('input[name=email]');
-```
-@param locator field located by label|name|CSS|XPath|strict locator.
+   * Resumes test execution, so **should be used inside async function with `await`** operator.
+   * 
+   * ```js
+   * let email = await I.grabValueFrom('input[name=email]');
+   * ```
+   * @param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
    */
   async grabValueFrom(locator) {
     const el = await findField.call(this, locator);
@@ -1093,14 +1199,16 @@ let email = await I.grabValueFrom('input[name=email]');
 
   /**
    * Retrieves an attribute from an element located by CSS or XPath and returns it to test.
-An array as a result will be returned if there are more than one matched element.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let hint = await I.grabAttributeFrom('#tooltip', 'title');
-```
-@param locator element located by CSS|XPath|strict locator.
-@param attr attribute name.
+   * An array as a result will be returned if there are more than one matched element.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let hint = await I.grabAttributeFrom('#tooltip', 'title');
+   * ```
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {string} attr attribute name.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
    */
   async grabAttributeFrom(locator, attr) {
     locator = new Locator(locator, 'css');
@@ -1118,14 +1226,16 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
   /**
    * Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-If more than one element is found - an array of HTMLs returned.
-
-```js
-let postHTML = await I.grabHTMLFrom('#post');
-```
-
-@param locator element located by CSS|XPath|strict locator.
+   * Resumes test execution, so **should be used inside async function with `await`** operator.
+   * If more than one element is found - an array of HTMLs returned.
+   * 
+   * ```js
+   * let postHTML = await I.grabHTMLFrom('#post');
+   * ```
+   * 
+   * @param locator element located by CSS|XPath|strict locator.
+   * @returns {Promise<string>} HTML code for an element
+   * {--end--}
    */
   async grabHTMLFrom(locator) {
     locator = new Locator(locator, 'css');
@@ -1149,25 +1259,26 @@ let postHTML = await I.grabHTMLFrom('#post');
 
   /**
    * Selects an option in a drop-down select.
-Field is searched by label | name | CSS | XPath.
-Option is selected by visible text or by value.
-
-```js
-I.selectOption('Choose Plan', 'Monthly'); // select by label
-I.selectOption('subscription', 'Monthly'); // match option by text
-I.selectOption('subscription', '0'); // or by value
-I.selectOption('//form/select[@name=account]','Premium');
-I.selectOption('form select[name=account]', 'Premium');
-I.selectOption({css: 'form select[name=account]'}, 'Premium');
-```
-
-Provide an array for the second argument to select multiple options.
-
-```js
-I.selectOption('Which OS do you use?', ['Android', 'iOS']);
-```
-@param select field located by label|name|CSS|XPath|strict locator.
-@param option visible text or value of option.
+   * Field is searched by label | name | CSS | XPath.
+   * Option is selected by visible text or by value.
+   * 
+   * ```js
+   * I.selectOption('Choose Plan', 'Monthly'); // select by label
+   * I.selectOption('subscription', 'Monthly'); // match option by text
+   * I.selectOption('subscription', '0'); // or by value
+   * I.selectOption('//form/select[@name=account]','Premium');
+   * I.selectOption('form select[name=account]', 'Premium');
+   * I.selectOption({css: 'form select[name=account]'}, 'Premium');
+   * ```
+   * 
+   * Provide an array for the second argument to select multiple options.
+   * 
+   * ```js
+   * I.selectOption('Which OS do you use?', ['Android', 'iOS']);
+   * ```
+   * @param {string|object} select field located by label|name|CSS|XPath|strict locator.
+   * @param {string|array} option visible text or value of option.
+   * {--end--}
    */
   async selectOption(select, option) {
     const fetchAndCheckOption = function (el, locator) {
@@ -1211,12 +1322,13 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
   /**
    * Sets a cookie.
-
-```js
-I.setCookie({name: 'auth', value: true});
-```
-
-@param cookie cookie JSON object.
+   * 
+   * ```js
+   * I.setCookie({name: 'auth', value: true});
+   * ```
+   * 
+   * @param {object} cookie a cookie object.
+   * {--end--}
    *
    * Wrapper for `.cookies.set(cookie)`.
    * [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie)
@@ -1227,12 +1339,13 @@ I.setCookie({name: 'auth', value: true});
 
   /**
    * Checks that cookie with given name exists.
-
-```js
-I.seeCookie('Auth');
-```
-
-@param name cookie name.
+   * 
+   * ```js
+   * I.seeCookie('Auth');
+   * ```
+   * 
+   * @param {string} name cookie name.
+   * {--end--}
    *
    */
   async seeCookie(name) {
@@ -1242,8 +1355,13 @@ I.seeCookie('Auth');
 
   /**
    * Checks that cookie with given name does not exist.
-
-@param name cookie name.
+   * 
+   * ```js
+   * I.dontSeeCookie('auth'); // no auth cookie
+   * ```
+   * 
+   * @param {string} name cookie name.
+   * {--end--}
    */
   async dontSeeCookie(name) {
     const res = await this.browser.cookies.get(name);
@@ -1252,25 +1370,21 @@ I.seeCookie('Auth');
 
   /**
    * Gets a cookie object by name.
-If none provided gets all cookies.
-* Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let cookie = await I.grabCookie('auth');
-assert(cookie.value, '123456');
-```
-
-@param name (optional) cookie name.
-   *
-   * Returns cookie in JSON format. If name not passed returns all cookies for this domain.
-   *
-   * Multiple cookies can be received by passing query object:
-   *
+   * If none provided gets all cookies.
+   * * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
    * ```js
-   * I.grabCookie({ secure: true});
+   * let cookie = await I.grabCookie('auth');
+   * assert(cookie.value, '123456');
    * ```
+   * 
+   * @param [name=null] cookie name.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
+   *
+   * @returns Promise<object> Cookie in JSON format. If name not passed returns all cookies for this domain.
    *
-   * If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
+   * Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
    */
   async grabCookie(name) {
     return this.browser.cookies.get(name);
@@ -1278,14 +1392,15 @@ assert(cookie.value, '123456');
 
   /**
    * Clears a cookie by name,
-if none provided clears all cookies.
-
-```js
-I.clearCookie();
-I.clearCookie('test');
-```
-
-@param cookie (optional) cookie name.
+   * if none provided clears all cookies.
+   * 
+   * ```js
+   * I.clearCookie();
+   * I.clearCookie('test');
+   * ```
+   * 
+   * @param {string} cookie (optional, `null` by default) cookie name
+   * {--end--}
    */
   async clearCookie(cookie) {
     if (!cookie) {
@@ -1296,21 +1411,22 @@ I.clearCookie('test');
 
   /**
    * Waits for a function to return true (waits for 1 sec by default).
-Running in browser context.
-
-```js
-I.waitForFunction(fn[, [args[, timeout]])
-```
-
-```js
-I.waitForFunction(() => window.requests == 0);
-I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
-I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
-```
-
-@param fn to be executed in browser context.
-@param argsOrSec (optional) arguments for function or seconds.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Running in browser context.
+   * 
+   * ```js
+   * I.waitForFunction(fn[, [args[, timeout]])
+   * ```
+   * 
+   * ```js
+   * I.waitForFunction(() => window.requests == 0);
+   * I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+   * I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
+   * ```
+   * 
+   * @param {string|function} fn to be executed in browser context.
+   * @param {array|number} argsOrSec (optional, `1` by default) arguments for function or seconds.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -1327,13 +1443,13 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
   /**
    * Pauses execution for a number of seconds.
-
-```js
-I.wait(2); // wait 2 secs
-```
-
-@param sec number of second to wait.
-@param sec time in seconds to wait.
+   * 
+   * ```js
+   * I.wait(2); // wait 2 secs
+   * ```
+   * 
+   * @param {number} sec number of second to wait.
+   * {--end--}
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -1343,17 +1459,18 @@ I.wait(2); // wait 2 secs
 
   /**
    * Waits for a text to appear (by default waits for 1sec).
-Element can be located by CSS or XPath.
-Narrow down search results by providing context.
-
-```js
-I.waitForText('Thank you, form has been submitted');
-I.waitForText('Thank you, form has been submitted', 5, '#modal');
-```
-
-@param text to wait for.
-@param sec (optional) time in seconds to wait.
-@param context (optional) element located by CSS|XPath|strict locator.
+   * Element can be located by CSS or XPath.
+   * Narrow down search results by providing context.
+   * 
+   * ```js
+   * I.waitForText('Thank you, form has been submitted');
+   * I.waitForText('Thank you, form has been submitted', 5, '#modal');
+   * ```
+   * 
+   * @param {string }text to wait for.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * @param {string|object} context (optional) element located by CSS|XPath|strict locator.
+   * {--end--}
    */
   async waitForText(text, sec, context = null) {
     if (!context) {
@@ -1374,14 +1491,15 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
   /**
    * Waits for an element to become visible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitForVisible('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitForVisible('#popup');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   waitForVisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1400,14 +1518,15 @@ I.waitForVisible('#popup');
 
   /**
    * Waits for an element to hide (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitToHide('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitToHide('#popup');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
@@ -1415,14 +1534,15 @@ I.waitToHide('#popup');
 
   /**
    * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitForInvisible('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitForInvisible('#popup');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   waitForInvisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1441,15 +1561,16 @@ I.waitForInvisible('#popup');
 
   /**
    * Waits for element to be present on page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForElement('.btn.continue');
-I.waitForElement('.btn.continue', 5); // wait for 5 secs
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitForElement('.btn.continue');
+   * I.waitForElement('.btn.continue', 5); // wait for 5 secs
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   async waitForElement(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1471,14 +1592,15 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
   /**
    * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitForDetached('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitForDetached('#popup');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * {--end--}
    */
   async waitForDetached(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1494,11 +1616,11 @@ I.waitForDetached('#popup');
 
   /**
    * Reload the current page.
-
-```js
-I.refreshPage();
-```
-
+   * 
+   * ```js
+   * I.refreshPage();
+   * ```
+   * {--end--}
    */
   async refreshPage() {
     return this.browser.refresh();
@@ -1514,16 +1636,17 @@ I.refreshPage();
 
   /**
    * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder. 
-Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
-
-```js
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
-
-@param fileName file name to save. 
-@param fullPage (optional) flag to enable fullscreen screenshot mode.
+   * Filename is relative to output folder.
+   * Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
+   * 
+   * ```js
+   * I.saveScreenshot('debug.png');
+   * I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
+   * ```
+   * 
+   * @param {string} fileName file name to save.
+   * @param {boolean} fullPage (optional, `false` by default) flag to enable fullscreen screenshot mode.
+   * {--end--}
    */
   async saveScreenshot(fileName, fullPage = this.options.fullPageScreenshots) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -1547,16 +1670,17 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
   /**
    * Scrolls to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-```js
-I.scrollTo('footer');
-I.scrollTo('#submit', 5, 5);
-```
-
-@param locator located by CSS|XPath|strict locator.
-@param offsetX (optional) X-axis offset.
-@param offsetY (optional) Y-axis offset.
+   * Extra shift can be set with offsetX and offsetY options.
+   * 
+   * ```js
+   * I.scrollTo('footer');
+   * I.scrollTo('#submit', 5, 5);
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {number} offsetX (optional, `0` by default) X-axis offset.
+   * @param {number} offsetY (optional, `0` by default) Y-axis offset.
+   * {--end--}
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1579,10 +1703,11 @@ I.scrollTo('#submit', 5, 5);
 
   /**
    * Scroll page to the top.
-
-```js
-I.scrollPageToTop();
-```
+   * 
+   * ```js
+   * I.scrollPageToTop();
+   * ```
+   * {--end--}
    */
   async scrollPageToTop() {
     return this.executeScript(() => window.scrollTo(0, 0));
@@ -1590,10 +1715,11 @@ I.scrollPageToTop();
 
   /**
    * Scroll page to the bottom.
-
-```js
-I.scrollPageToBottom();
-```
+   * 
+   * ```js
+   * I.scrollPageToBottom();
+   * ```
+   * {--end--}
    */
   async scrollPageToBottom() {
     /* eslint-disable prefer-arrow-callback, comma-dangle */
@@ -1610,11 +1736,14 @@ I.scrollPageToBottom();
 
   /**
    * Retrieves a page scroll position and returns it to test.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-let { x, y } = await I.grabPageScrollPosition();
-```
+   * Resumes test execution, so **should be used inside an async function with `await`** operator.
+   * 
+   * ```js
+   * let { x, y } = await I.grabPageScrollPosition();
+   * ```
+   * 
+   * @returns {Promise<object>} scroll position
+   * {--end--}
    */
   async grabPageScrollPosition() {
     /* eslint-disable comma-dangle */