Update JSDoc for geolocation, keyboard and orientation commands.

nightwatchjs · Dec 5, 2022 · 23ee2ef · 23ee2ef
1 parent 1c2d044
commit 23ee2ef
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/lib/api/protocol/getGeolocation.js b/lib/api/protocol/getGeolocation.js
@@ -1,9 +1,9 @@
 const ProtocolAction = require('./_base-action.js');
 
 /**
- * Get the current geolocation of the mobile device. Getting the current geolocation for desktop browsers is not supported.
- *
- * This command is a part of old [JSON Wire Protocol](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidlocation), and works with Appium v1 only.
+ * Get the current geolocation of the mobile device.
+ * 
+ * This command works with Appium only. Getting the current geolocation for desktop browsers is not supported.
  *
  * @syntax .getGeolocation([callback])
  * @method getGeolocation

diff --git a/lib/api/protocol/getOrientation.js b/lib/api/protocol/getOrientation.js
@@ -3,7 +3,7 @@ const ProtocolAction = require('./_base-action.js');
 /**
  * Get the current browser/device orientation.
  *
- * @syntax browser.getOrientation([callback])
+ * @syntax .getOrientation([callback])
  * @method getOrientation
  * @param {function} callback Callback function which is called with the result value.
  * @returns {string} The current browser/device orientation: `LANDSCAPE` or `PORTRAIT`.

diff --git a/lib/api/protocol/isKeyboardShown.js b/lib/api/protocol/isKeyboardShown.js
@@ -7,7 +7,7 @@ const ProtocolAction = require('./_base-action.js');
  *
  * @syntax .isKeyboardShown([callback])
  * @method isKeyboardShown
- * @param {function} [callback] Optional callback function to be called when the command finishes.
+ * @param {function} [callback] Callback function which is called with the result value.
  * @returns {boolean} True if the keyboard is shown.
  * @see hideKeyboard
  * @api protocol.mobile

diff --git a/lib/api/protocol/setOrientation.js b/lib/api/protocol/setOrientation.js
@@ -3,7 +3,7 @@ const ProtocolAction = require('./_base-action.js');
 /**
  * Set the current browser/device orientation.
  *
- * @syntax browser.setOrientation(orientation, [callback])
+ * @syntax .setOrientation(orientation, [callback])
  * @method setOrientation
  * @param {string} orientation The new browser/device orientation: `LANDSCAPE` or `PORTRAIT`.
  * @param {function} [callback] Optional callback function to be called when the command finishes.