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:

committed by
Florian Müllner

parent
4642a8541d
commit
64aa871a8a
@ -23,11 +23,13 @@ var DEFAULT_BUTTON_WELL_ANIMATION_TIME = 300;
|
||||
|
||||
var MESSAGE_FADE_OUT_ANIMATION_TIME = 500;
|
||||
|
||||
/** @enum {number} */
|
||||
var AuthPromptMode = {
|
||||
UNLOCK_ONLY: 0,
|
||||
UNLOCK_OR_LOG_IN: 1,
|
||||
};
|
||||
|
||||
/** @enum {number} */
|
||||
var AuthPromptStatus = {
|
||||
NOT_VERIFYING: 0,
|
||||
VERIFYING: 1,
|
||||
@ -37,6 +39,7 @@ var AuthPromptStatus = {
|
||||
VERIFICATION_IN_PROGRESS: 5,
|
||||
};
|
||||
|
||||
/** @enum {number} */
|
||||
var BeginRequestType = {
|
||||
PROVIDE_USERNAME: 0,
|
||||
DONT_PROVIDE_USERNAME: 1,
|
||||
|
@ -43,6 +43,9 @@ var OVirtCredentialsManager = class OVirtCredentialsManager extends Credential.C
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @returns {OVirtCredentialsManager}
|
||||
*/
|
||||
function getOVirtCredentialsManager() {
|
||||
if (!_oVirtCredentialsManager)
|
||||
_oVirtCredentialsManager = new OVirtCredentialsManager();
|
||||
|
@ -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,
|
||||
|
@ -46,6 +46,9 @@ var VmwareCredentialsManager = class VmwareCredentialsManager extends Credential
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @returns {VmwareCredentialsManager}
|
||||
*/
|
||||
function getVmwareCredentialsManager() {
|
||||
if (!_vmwareCredentialsManager)
|
||||
_vmwareCredentialsManager = new VmwareCredentialsManager();
|
||||
|
Reference in New Issue
Block a user