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

@@ -17,6 +17,7 @@ const { loadInterfaceXML } = imports.misc.fileUtils;
const FdoNotificationsIface = loadInterfaceXML('org.freedesktop.Notifications');
/** @enum {number} */
var NotificationClosedReason = {
EXPIRED: 1,
DISMISSED: 2,
@@ -24,6 +25,7 @@ var NotificationClosedReason = {
UNDEFINED: 4,
};
/** @enum {number} */
var Urgency = {
LOW: 0,
NORMAL: 1,
@@ -544,9 +546,12 @@ function objectPathFromAppId(appId) {
return `/${appId.replace(/\./g, '/').replace(/-/g, '_')}`;
}
/**
* @returns {{ 'desktop-startup-id': string }}
*/
function getPlatformData() {
let startupId = GLib.Variant.new('s', `_TIME${global.get_current_time()}`);
return { "desktop-startup-id": startupId };
return {'desktop-startup-id': startupId};
}
function InvalidAppError() {}