edu4rdshl/gnome-shell
1
0
Fork 0
mirror of https://github.com/edu4rdshl/gnome-shell.git synced 2026-07-17 23:24:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'docs/jsdoc-shelldbus' into 'main'

Browse source 
cleanup: Update JSDoc params signatures

See merge request GNOME/gnome-shell!2915
This commit is contained in:
Sergei Kolesnikov 2024-06-29 18:42:31 +00:00
commit 7240f1ed7b
2 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

6
js/misc/util.js
View file

@ -391,7 +391,7 @@ export class DBusSenderChecker {
/**
* @async
* @param {string} sender - the bus name that invoked the checked method
* @returns {bool}
* @returns {Promise<boolean>}
*/
async _isSenderAllowed(sender) {
await this._initializedPromise;
@ -399,13 +399,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<void>}
*/
async checkInvocation(invocation) {
if (global.context.unsafe_mode)

16
js/ui/shellDBus.js
View file

@ -88,9 +88,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<void>}
*/
async FocusSearchAsync(params, invocation) {
try {
@ -108,9 +108,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<void>}
*/
async ShowOSDAsync([params], invocation) {
try {
@ -149,9 +149,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<void>}
*/
async FocusAppAsync([id], invocation) {
try {
@ -178,9 +178,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<void>}
*/
async ShowApplicationsAsync(params, invocation) {
try {