add acceptable/possible return value in param side as well

appium · Jan 26, 2025 · 4513759 · 4513759
1 parent af7f0f0
commit 4513759
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/lib/subcommands/ui.js b/lib/subcommands/ui.js
@@ -46,6 +46,8 @@ commands.setAppearance = async function setAppearance (appearance) {
  *
  * @this {import('../simctl').Simctl}
  * @return {Promise<string>} the contrast configuration value.
+ *                           Possible return value is 'enabled', 'disabled',
+ *                           'unsupported' or 'unknown' with Xcode 16.2.
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while getting the value.
  * @throws {Error} If the `udid` instance property is unset
@@ -65,6 +67,7 @@ commands.getIncreaseContrast = async function getIncreaseContrast () {
  *
  * @this {import('../simctl').Simctl}
  * @param {string} increaseContrast valid increase constrast configuration value.
+ *                                  Acceptable value is 'enabled' or 'disabled' with Xcode 16.2.
  * @throws {Error} if the current SDK version does not support the command
  * or the given value was invalid for the command.
  * @throws {Error} If the `udid` instance property is unset
@@ -86,7 +89,12 @@ commands.setIncreaseContrast = async function setIncreaseContrast (increaseContr
  *   Other values: unknown, unsupported.
  *
  * @this {import('../simctl').Simctl}
- * @return {Promise<string>} the content size value.
+ * @return {Promise<string>} the content size value. Possible return value is
+ *                           extra-small, small, medium, large, extra-large, extra-extra-large,
+ *                           extra-extra-extra-large, accessibility-medium, accessibility-large,
+ *                           accessibility-extra-large, accessibility-extra-extra-large,
+ *                           accessibility-extra-extra-extra-large,
+ *                           unknown or unsupported with Xcode 16.2.
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while getting the value.
  * @throws {Error} If the `udid` instance property is unset
@@ -111,8 +119,11 @@ commands.getContentSize = async function getContentSize () {
  * in the caller side.
  *
  * @this {import('../simctl').Simctl}
- * @param {string} contentSizeAction valid content size or action value.
- *                                   The example is in the description avobe.
+ * @param {string} contentSizeAction valid content size or action value. Acceptable value is
+ *                                   extra-small, small, medium, large, extra-large, extra-extra-large,
+ *                                   extra-extra-extra-large, accessibility-medium, accessibility-large,
+ *                                   accessibility-extra-large, accessibility-extra-extra-large,
+ *                                   accessibility-extra-extra-extra-large with Xcode 16.2.
  * @throws {Error} if the current SDK version does not support the command
  * or the given value was invalid for the command.
  * @throws {Error} If the `udid` instance property is unset