From 71b7ffcf7e5702eefd7a5d4189b48e0801632231 Mon Sep 17 00:00:00 2001 From: Sergei Kolesnikov Date: Sat, 26 Aug 2023 15:21:10 +0300 Subject: [PATCH] Update JSDoc params signatures --- js/misc/util.js | 6 +++--- js/ui/shellDBus.js | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/js/misc/util.js b/js/misc/util.js index 0201fd112..330e16de2 100644 --- a/js/misc/util.js +++ b/js/misc/util.js @@ -364,7 +364,7 @@ export class DBusSenderChecker { /** * @async * @param {string} sender - the bus name that invoked the checked method - * @returns {bool} + * @returns {Promise} */ async _isSenderAllowed(sender) { await this._initializedPromise; @@ -372,13 +372,13 @@ export class DBusSenderChecker { } /** - * Check whether the bus name that invoked @invocation maps + * Check whether the bus name that invoked {@link invocation} maps * to an entry in the allow list. * * @async * @throws * @param {Gio.DBusMethodInvocation} invocation - the invocation - * @returns {void} + * @returns {Promise} */ async checkInvocation(invocation) { if (global.context.unsafe_mode) diff --git a/js/ui/shellDBus.js b/js/ui/shellDBus.js index 12ca261c8..c5991d606 100644 --- a/js/ui/shellDBus.js +++ b/js/ui/shellDBus.js @@ -82,9 +82,9 @@ export class GnomeShell { * Focus the overview's search entry * * @async - * @param {...any} params - method parameters + * @param {any[]} params - method parameters * @param {Gio.DBusMethodInvocation} invocation - the invocation - * @returns {void} + * @returns {Promise} */ async FocusSearchAsync(params, invocation) { try { @@ -102,9 +102,9 @@ export class GnomeShell { * Show OSD with the specified parameters * * @async - * @param {...any} params - method parameters + * @param {[any[]]} params - method parameters * @param {Gio.DBusMethodInvocation} invocation - the invocation - * @returns {void} + * @returns {Promise} */ async ShowOSDAsync([params], invocation) { try { @@ -143,9 +143,9 @@ export class GnomeShell { * Focus specified app in the overview's app grid * * @async - * @param {string} id - an application ID + * @param {[string]} id - an application ID * @param {Gio.DBusMethodInvocation} invocation - the invocation - * @returns {void} + * @returns {Promise} */ async FocusAppAsync([id], invocation) { try { @@ -172,9 +172,9 @@ export class GnomeShell { * Show the overview's app grid * * @async - * @param {...any} params - method parameters + * @param {any[]} params - method parameters * @param {Gio.DBusMethodInvocation} invocation - the invocation - * @returns {void} + * @returns {Promise} */ async ShowApplicationsAsync(params, invocation) { try {