brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

23
js/ui/main.js
View File

@ -524,8 +524,9 @@ function loadTheme() {
/**
* notify:
* @param {string} msg: A message
* @param {string} details: Additional information
*
* @param {string} msg A message
* @param {string} details Additional information
*/
function notify(msg, details) {
let source = new MessageTray.SystemNotificationSource();
@ -713,6 +714,11 @@ function popModal(grab, timestamp) {
actionMode = Shell.ActionMode.NORMAL;
}
/**
* Creates the looking glass panel
*
* @returns {LookingGlass.LookingGlass}
*/
function createLookingGlass() {
if (lookingGlass == null)
lookingGlass = new LookingGlass.LookingGlass();
@ -720,6 +726,9 @@ function createLookingGlass() {
return lookingGlass;
}
/**
* Opens the run dialog
*/
function openRunDialog() {
if (runDialog == null)
runDialog = new RunDialog.RunDialog();
@ -736,9 +745,10 @@ function openWelcomeDialog() {
/**
* activateWindow:
* @param {Meta.Window} window: the window to activate
* @param {number=} time: current event time
* @param {number=} workspaceNum: window's workspace number
*
* @param {Meta.Window} window the window to activate
* @param {number=} time current event time
* @param {number=} workspaceNum window's workspace number
*
* Activates @window, switching to its workspace first if necessary,
* and switching out of the overview if it's currently active
@ -882,7 +892,8 @@ function initializeDeferredWork(actor, callback) {
/**
* queueDeferredWork:
* @param {string} workId: work identifier
*
* @param {string} workId work identifier
*
* Ensure that the work identified by @workId will be
* run on map or timeout. You should call this function