js: Add JSDoc to exported functions and fix incorrect JSDoc formatting

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1499>
This commit is contained in:
Evan Welsh
2023-07-30 15:56:59 +03:00
committed by Florian Müllner
parent 4642a8541d
commit 64aa871a8a
56 changed files with 623 additions and 280 deletions

View File

@ -49,8 +49,12 @@ var DISABLE_USER_LIST_KEY = 'disable-user-list';
var USER_READ_TIME = 48;
const FINGERPRINT_ERROR_TIMEOUT_WAIT = 15;
/**
* Keep messages in order by priority
*
* @enum {number}
*/
var MessageType = {
// Keep messages in order by priority
NONE: 0,
HINT: 1,
INFO: 2,
@ -109,6 +113,9 @@ function fadeOutActor(actor) {
return hold;
}
/**
* @param {Clutter.Actor} actor
*/
function cloneAndFadeOutActor(actor) {
// Immediately hide actor so its sibling can have its space
// and position, but leave a non-reactive clone on-screen,