cleanup: Fixup wrong JSDoc comments

There are a handful of JSDoc comments that are invalid or don't
conform to the configured format. Fix them to remove the last
remaining bit of legacy configuration.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2866>
This commit is contained in:
Florian Müllner
2023-08-07 03:15:51 +02:00
committed by Marge Bot
parent a42f7c2384
commit ff010a11ab
15 changed files with 119 additions and 170 deletions

View File

@@ -30,13 +30,12 @@ import {loadInterfaceXML} from '../misc/fileUtils.js';
//
/**
* sleep:
* @param {number} milliseconds - number of milliseconds to wait
* @returns {Promise} that resolves after @milliseconds ms
*
* Used within an automation script to pause the the execution of the
* current script for the specified amount of time. Use as
* 'yield Scripting.sleep(500);'
*
* @param {number} milliseconds - number of milliseconds to wait
* @returns {Promise} that resolves after @milliseconds ms
*/
export function sleep(milliseconds) {
return new Promise(resolve => {
@@ -49,12 +48,11 @@ export function sleep(milliseconds) {
}
/**
* waitLeisure:
* @returns {Promise} that resolves when the shell is idle
*
* Used within an automation script to pause the the execution of the
* current script until the shell is completely idle. Use as
* 'yield Scripting.waitLeisure();'
*
* @returns {Promise} that resolves when the shell is idle
*/
export function waitLeisure() {
return new Promise(resolve => {