Refactor JSDoc for axe commands. (#4188)

nightwatchjs · Apr 17, 2024 · ab07e60 · ab07e60
1 parent 819e82f
commit ab07e60
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/lib/api/_loaders/element-api.js b/lib/api/_loaders/element-api.js
@@ -5,6 +5,7 @@ const {By} = require('selenium-webdriver');
 
 class ScopedElementAPILoader {
   static get availableElementCommands() {
+    // commands directly available on `browser.element`
     return [
       ['findElement', 'find', 'get'],
       ['findAll'],

diff --git a/lib/api/client-commands/axeInject.js b/lib/api/client-commands/axeInject.js
@@ -1,5 +1,6 @@
 /**
  * Injects the [axe-core](https://github.com/dequelabs/axe-core) js library into the current page (using the `.executeScript()` command).
+ *
  * To be paired with `.axeRun()` to evaluate the axe-core accessibility rules.
  *
  * @example

diff --git a/lib/api/client-commands/axeRun.js b/lib/api/client-commands/axeRun.js
@@ -16,7 +16,7 @@
  *
  * @method axeRun
  * @syntax browser.axeRun('body')
- * @param {*} [context] Defines the scope of the analysis, will cascade to child elements. See [axe-core docs](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#context-parameter) for more details.
+ * @param {any} [context] Defines the scope of the analysis, will cascade to child elements. See [axe-core docs](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#context-parameter) for more details.
  * @param {object} [options] Object containing rules configuration to use when performing the analysis. See [axe-core docs](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#options-parameter) for more details.
  * @param {function} [callback] Optional callback function which is called with the results.
  * @api protocol.accessibility