Fixed W3C WebDriver spec links in API docs. (#4166)

Co-authored-by: Priyansh Garg <[email protected]>
nightwatchjs · May 27, 2024 · 88c9acd · 88c9acd
1 parent 10384ae
commit 88c9acd
Show file tree

Hide file tree

Showing 25 changed files with 35 additions and 34 deletions.
diff --git a/lib/api/client-commands/document/source.js b/lib/api/client-commands/document/source.js
@@ -21,7 +21,7 @@ const ClientCommand = require('../_base-command.js');
  * @method document.source
  * @param {function} [callback] Callback function which is called with the result value.
  * @returns {string} String serialized source of the current page.
- * @link https://www.w3.org/TR/webdriver#getting-page-source
+ * @link /#get-page-source
  * @api protocol.document
  */
 class Source extends ClientCommand {

diff --git a/lib/api/element-commands/clickAndHold.js b/lib/api/element-commands/clickAndHold.js
@@ -42,7 +42,7 @@ const BaseElementCommand = require('./_baseElementCommand.js');
  * @param {string} selector The CSS/Xpath selector used to locate the element.
  * @param {function} [callback] Optional callback function to be called when the command finishes.
  * @api protocol.elementinteraction
- * @link /#dfn-element-clickAndHold
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#click-and-hold
  * @since 2.0.0
  */
 class ClickAndHold extends BaseElementCommand {

diff --git a/lib/api/element-commands/doubleClick.js b/lib/api/element-commands/doubleClick.js
@@ -42,7 +42,7 @@ const BaseElementCommand = require('./_baseElementCommand.js');
  * @param {string} selector The CSS/Xpath selector used to locate the element.
  * @param {function} [callback] Optional callback function to be called when the command finishes.
  * @api protocol.elementinteraction
- * @link /#dfn-element-doubleClick
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#double-click
  */
 class doubleClick extends BaseElementCommand {
   get extraArgsCount() {

diff --git a/lib/api/element-commands/getValue.js b/lib/api/element-commands/getValue.js
@@ -38,7 +38,7 @@ const BaseElementCommand = require('./_baseElementCommand.js');
  * @param {string|object} selector The selector (CSS/Xpath) used to locate the element. Can either be a string or an object which specifies [element properties](https://nightwatchjs.org/guide#element-properties).
  * @param {function} callback Callback function which is called with the result value.
  * @returns {string} The element's value.
- * @link /#dfn-get-element-tag-name
+ * @link /#get-element-property
  * @api protocol.elementstate
  */
 class GetValue extends BaseElementCommand {

diff --git a/lib/api/element-commands/rightClick.js b/lib/api/element-commands/rightClick.js
@@ -43,7 +43,7 @@ const BaseElementCommand = require('./_baseElementCommand.js');
  * @param {function} [callback] Optional callback function to be called when the command finishes.
  * @api protocol.elementinteraction
  * @since 2.0.0
- * @link /#dfn-element-rightClick
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#context-click
  */
 class RightClick extends BaseElementCommand {
   get extraArgsCount() {

diff --git a/lib/api/web-element/commands/clear.js b/lib/api/web-element/commands/clear.js
@@ -23,9 +23,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).clear()
- * @see https://www.w3.org/TR/webdriver#dfn-element-clear
+ * @link /#dfn-element-clear
  * @returns {ScopedWebElement}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommand('clearElementValue');
 };
diff --git a/lib/api/web-element/commands/click.js b/lib/api/web-element/commands/click.js
@@ -19,9 +19,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).click()
- * @see https://www.w3.org/TR/webdriver#dfn-element-click
+ * @link /#dfn-element-click
  * @returns {ScopedWebElement}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommand('clickElement');
 };
diff --git a/lib/api/web-element/commands/clickAndHold.js b/lib/api/web-element/commands/clickAndHold.js
@@ -18,9 +18,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).clickAndHold()
- * @see https://www.w3.org/TR/webdriver#dfn-element-clickAndHold
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#click-and-hold
  * @returns {ScopedWebElement}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommand('pressAndHold');
 };
diff --git a/lib/api/web-element/commands/doubleClick.js b/lib/api/web-element/commands/doubleClick.js
@@ -20,9 +20,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).doubleClick()
- * @see https://www.w3.org/TR/webdriver#dfn-element-doubleClick
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#double-click
  * @returns {ScopedWebElement}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommand('doubleClick');
 };
diff --git a/lib/api/web-element/commands/getAccessibleName.js b/lib/api/web-element/commands/getAccessibleName.js
@@ -21,7 +21,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getAccessibleName()
- * @see https://www.w3.org/TR/webdriver#dfn-get-computed-label
+ * @link /#get-computed-label
  * @returns {ScopedValue<string>} A container with accessible name of an element.
  */
 module.exports.command = function() {

diff --git a/lib/api/web-element/commands/getAriaRole.js b/lib/api/web-element/commands/getAriaRole.js
@@ -20,7 +20,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getAriaRole()
- * @see https://www.w3.org/TR/webdriver#dfn-get-computed-role
+ * @link /#get-computed-role
  * @returns {ScopedValue<string>} The container with computed WAI-ARIA role of an element.
  */
 module.exports.command = function() {

diff --git a/lib/api/web-element/commands/getAttribute.js b/lib/api/web-element/commands/getAttribute.js
@@ -23,7 +23,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getAttribute(name)
- * @see https://www.w3.org/TR/webdriver#dfn-get-element-attribute
+ * @link /#get-element-attribute
  * @param {string} name The attribute name to inspect.
  * @returns {ScopedValue<string | null>} The value of the attribute
  */

diff --git a/lib/api/web-element/commands/getCssProperty.js b/lib/api/web-element/commands/getCssProperty.js
@@ -34,7 +34,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getCssProperty(name)
- * @see https://www.w3.org/TR/webdriver#get-element-css-value
+ * @link /#get-element-css-value
  * @param {string} cssProperty The CSS property to inspect.
  * @returns {ScopedValue<string>} The container with a value of the css property
  */

diff --git a/lib/api/web-element/commands/getProperty.js b/lib/api/web-element/commands/getProperty.js
@@ -37,9 +37,9 @@
  * @param {string} name element property
  * @instance
  * @syntax browser.element(selector).getProperty(name)
- * @see https://www.w3.org/TR/webdriver#get-element-property
+ * @link /#get-element-property
  * @returns {ScopedValue<string>}
  */
-module.exports.command = function(name) {
+module.exports.command = function (name) {
   return this.runQueuedCommandScoped('getElementProperty', name);
 };
diff --git a/lib/api/web-element/commands/getRect.js b/lib/api/web-element/commands/getRect.js
@@ -27,11 +27,11 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getRect()
- * @see https://www.w3.org/TR/webdriver#dfn-get-element-rect
+ * @link /#dfn-get-element-rect
  * @returns {ScopedValue<{ width: number, height: number }>}
  * @alias getSize
  * @alias getLocation
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommandScoped('getElementRect');
 };
diff --git a/lib/api/web-element/commands/getTagName.js b/lib/api/web-element/commands/getTagName.js
@@ -21,7 +21,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getTagName()
- * @see https://www.w3.org/TR/webdriver#dfn-get-element-tag-name
+ * @link /#get-element-tag-name
  * @returns {ScopedValue<string>}
  */
 module.exports.command = function() {

diff --git a/lib/api/web-element/commands/getText.js b/lib/api/web-element/commands/getText.js
@@ -22,7 +22,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getText()
- * @see https://www.w3.org/TR/webdriver#dfn-get-element-text
+ * @link /#get-element-text
  * @returns {ScopedValue<string>}
  */
 module.exports.command = function() {

diff --git a/lib/api/web-element/commands/getValue.js b/lib/api/web-element/commands/getValue.js
@@ -21,7 +21,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).getValue()
- * @see https://www.w3.org/TR/webdriver#dfn-get-element-tag-name
+ * @link /#get-element-property
  * @returns {ScopedValue<string>}
  */
 module.exports.command = function () {

diff --git a/lib/api/web-element/commands/isEnabled.js b/lib/api/web-element/commands/isEnabled.js
@@ -22,7 +22,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).isEnabled()
- * @see https://www.w3.org/TR/webdriver/#is-element-enabled
+ * @link /#is-element-enabled
  * @returns {ScopedValue<boolean>}
  */
 module.exports.command = function () {

diff --git a/lib/api/web-element/commands/isSelected.js b/lib/api/web-element/commands/isSelected.js
@@ -22,7 +22,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).isSelected()
- * @see https://www.w3.org/TR/webdriver/#is-element-selected
+ * @link /#is-element-selected
  * @returns {ScopedValue<boolean>}
  */
 module.exports.command = function () {

diff --git a/lib/api/web-element/commands/isVisible.js b/lib/api/web-element/commands/isVisible.js
@@ -20,7 +20,7 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).isVisible()
- * @see https://www.w3.org/TR/webdriver/#element-displayedness
+ * @link /#element-displayedness
  * @returns {ScopedValue<boolean>}
  * @alias isDisplayed
  */

diff --git a/lib/api/web-element/commands/rightClick.js b/lib/api/web-element/commands/rightClick.js
@@ -19,9 +19,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).rightClick()
- * @see https://www.w3.org/TR/webdriver#dfn-element-rightclick
+ * @see https://www.selenium.dev/documentation/webdriver/actions_api/mouse/#context-click
  * @returns {ScopedWebElement}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommand('contextClick');
 };
diff --git a/lib/api/web-element/commands/sendKeys.js b/lib/api/web-element/commands/sendKeys.js
@@ -22,10 +22,11 @@
  * @instance
  * @syntax browser.element(selector).sendKeys(...keys)
  * @param {...string} keys
+ * @link /#element-send-keys
  * @see https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/index_exports_WebElement.html#sendKeys
  * @returns {ScopedWebElement}
  */
-module.exports.command = function(...args) {
+module.exports.command = function (...args) {
   const keys = args.reduce((prev, key) => {
     const keyList = Array.isArray(key) ? key : [key];
     prev.push(...keyList);

diff --git a/lib/api/web-element/commands/takeScreenshot.js b/lib/api/web-element/commands/takeScreenshot.js
@@ -21,9 +21,9 @@
  * @memberof ScopedWebElement
  * @instance
  * @syntax browser.element(selector).takeScreenshot()
- * @see https://www.w3.org/TR/webdriver#dfn-take-element-screenshot
+ * @link /#dfn-take-element-screenshot
  * @returns {ScopedValue<string>}
  */
-module.exports.command = function() {
+module.exports.command = function () {
   return this.runQueuedCommandScoped('takeElementScreenshot');
 };
diff --git a/lib/api/web-element/commands/update.js b/lib/api/web-element/commands/update.js
@@ -22,10 +22,10 @@
  * @instance
  * @syntax browser.element(selector).update(characters, ...keys)
  * @param {...string} keys
- * @see https://www.w3.org/TR/webdriver#element-send-keys
+ * @link /#element-send-keys
  * @returns {ScopedWebElement}
  */
-module.exports.command = function(...args) {
+module.exports.command = function (...args) {
   const keys = args.reduce((prev, key) => {
     const keyList = Array.isArray(key) ? key : [key];
     prev.push(...keyList);