diff options
author | Louis Chemineau <louis@chmn.me> | 2022-01-10 14:06:28 +0100 |
---|---|---|
committer | Louis Chemineau <louis@chmn.me> | 2022-01-11 17:12:55 +0100 |
commit | d92cbf51493f0aa15745d2f9545cba2372eecec3 (patch) | |
tree | 349a555a74c99b40c20fcc470c26b7f7c0029f8d /core/src/OC | |
parent | 7484abb6c07f2296abc2040ecd747ddf1d65e98e (diff) | |
download | nextcloud-server-d92cbf51493f0aa15745d2f9545cba2372eecec3.tar.gz nextcloud-server-d92cbf51493f0aa15745d2f9545cba2372eecec3.zip |
Typing corrections
Signed-off-by: Louis Chemineau <louis@chmn.me>
Diffstat (limited to 'core/src/OC')
-rw-r--r-- | core/src/OC/admin.js | 2 | ||||
-rw-r--r-- | core/src/OC/capabilities.js | 2 | ||||
-rw-r--r-- | core/src/OC/host.js | 8 | ||||
-rw-r--r-- | core/src/OC/index.js | 4 | ||||
-rw-r--r-- | core/src/OC/l10n.js | 6 | ||||
-rw-r--r-- | core/src/OC/menu.js | 2 | ||||
-rw-r--r-- | core/src/OC/notification.js | 6 | ||||
-rw-r--r-- | core/src/OC/plugins.js | 2 | ||||
-rw-r--r-- | core/src/OC/util.js | 4 |
9 files changed, 18 insertions, 18 deletions
diff --git a/core/src/OC/admin.js b/core/src/OC/admin.js index 96ad6cd4048..3472cb2184a 100644 --- a/core/src/OC/admin.js +++ b/core/src/OC/admin.js @@ -26,7 +26,7 @@ const isAdmin = !!window._oc_isadmin /** * Returns whether the current user is an administrator * - * @return {bool} true if the user is an admin, false otherwise + * @return {boolean} true if the user is an admin, false otherwise * @since 9.0.0 */ export const isUserAdmin = () => isAdmin diff --git a/core/src/OC/capabilities.js b/core/src/OC/capabilities.js index 01405ec9b29..38d1e4eb72a 100644 --- a/core/src/OC/capabilities.js +++ b/core/src/OC/capabilities.js @@ -29,7 +29,7 @@ import { getCapabilities as realGetCapabilities } from '@nextcloud/capabilities' * * @return {Array} capabilities * - * @since 14.0 + * @since 14.0.0 */ export const getCapabilities = () => { console.warn('OC.getCapabilities is deprecated and will be removed in Nextcloud 21. See @nextcloud/capabilities') diff --git a/core/src/OC/host.js b/core/src/OC/host.js index d525818a6ca..e4c43f5014e 100644 --- a/core/src/OC/host.js +++ b/core/src/OC/host.js @@ -34,7 +34,7 @@ export const getProtocol = () => window.location.protocol.split(':')[0] * * @return {string} host * - * @since 8.2 + * @since 8.2.0 * @deprecated 17.0.0 use window.location.host directly */ export const getHost = () => window.location.host @@ -44,7 +44,7 @@ export const getHost = () => window.location.host * The hostname is always stripped of the port * * @return {string} hostname - * @since 9.0 + * @since 9.0.0 * @deprecated 17.0.0 use window.location.hostname directly */ export const getHostName = () => window.location.hostname @@ -52,9 +52,9 @@ export const getHostName = () => window.location.hostname /** * Returns the port number used to access this Nextcloud instance * - * @return {int} port number + * @return {number} port number * - * @since 8.2 + * @since 8.2.0 * @deprecated 17.0.0 use window.location.port directly */ export const getPort = () => window.location.port diff --git a/core/src/OC/index.js b/core/src/OC/index.js index 7f811c51a56..ed0f6ce185b 100644 --- a/core/src/OC/index.js +++ b/core/src/OC/index.js @@ -153,7 +153,7 @@ export default { /** * Currently logged in user or null if none * - * @type String + * @type {string} * @deprecated use `getCurrentUser` from https://www.npmjs.com/package/@nextcloud/auth */ currentUser, @@ -307,7 +307,7 @@ export default { * Relative path to Nextcloud root. * For example: "/nextcloud" * - * @type string + * @type {string} * * @deprecated 19.0.0 use `getRootUrl` from https://www.npmjs.com/package/@nextcloud/router * @see OC#getRootPath diff --git a/core/src/OC/l10n.js b/core/src/OC/l10n.js index 48dfe6c1785..9cbad9a7d44 100644 --- a/core/src/OC/l10n.js +++ b/core/src/OC/l10n.js @@ -106,8 +106,8 @@ const L10n = { * @param {object} [vars] map of placeholder key to value * @param {number} [count] number to replace %n with * @param {Array} [options] options array - * @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) - * @param {bool} [options.sanitize=true] enable/disable sanitization (by default enabled) + * @param {boolean} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) + * @param {boolean} [options.sanitize=true] enable/disable sanitization (by default enabled) * @return {string} */ translate(app, text, vars, count, options) { @@ -159,7 +159,7 @@ const L10n = { * @param {number} count number to determine whether to use singular or plural * @param {object} [vars] map of placeholder key to value * @param {Array} [options] options array - * @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) + * @param {boolean} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) * @return {string} Translated string */ translatePlural(app, textSingular, textPlural, count, vars, options) { diff --git a/core/src/OC/menu.js b/core/src/OC/menu.js index 669b1f1566b..9522650c472 100644 --- a/core/src/OC/menu.js +++ b/core/src/OC/menu.js @@ -37,7 +37,7 @@ export let currentMenuToggle = null * @param {jQuery} $menuEl the menu container element * @param {Function | undefined} toggle callback invoked everytime the menu is opened * @param {boolean} headerMenu is this a top right header menu? - * @return {undefined} + * @return {void} */ export const registerMenu = function($toggle, $menuEl, toggle, headerMenu) { $menuEl.addClass('menu') diff --git a/core/src/OC/notification.js b/core/src/OC/notification.js index 02383af81df..74499d5241b 100644 --- a/core/src/OC/notification.js +++ b/core/src/OC/notification.js @@ -97,7 +97,7 @@ export default { * @param {string} html Message to display * @param {object} [options] options * @param {string} [options.type] notification type - * @param {int} [options.timeout=0] timeout value, defaults to 0 (permanent) + * @param {number} [options.timeout=0] timeout value, defaults to 0 (permanent) * @return {jQuery} jQuery element for notification row * @deprecated 17.0.0 use the `@nextcloud/dialogs` package */ @@ -116,7 +116,7 @@ export default { * @param {string} text Message to display * @param {object} [options] options * @param {string} [options.type] notification type - * @param {int} [options.timeout=0] timeout value, defaults to 0 (permanent) + * @param {number} [options.timeout=0] timeout value, defaults to 0 (permanent) * @return {jQuery} jQuery element for notification row * @deprecated 17.0.0 use the `@nextcloud/dialogs` package */ @@ -159,7 +159,7 @@ export default { * * @param {string} text Message to show * @param {Array} [options] options array - * @param {int} [options.timeout=7] timeout in seconds, if this is 0 it will show the message permanently + * @param {number} [options.timeout=7] timeout in seconds, if this is 0 it will show the message permanently * @param {boolean} [options.isHTML=false] an indicator for HTML notifications (true) or text (false) * @param {string} [options.type] notification type * @return {JQuery<any>} the toast element diff --git a/core/src/OC/plugins.js b/core/src/OC/plugins.js index 6be76a2d5a4..b9221481aa5 100644 --- a/core/src/OC/plugins.js +++ b/core/src/OC/plugins.js @@ -24,7 +24,7 @@ export default { /** - * @type Array.<OC.Plugin> + * @type {Array.<OC.Plugin>} */ _plugins: {}, diff --git a/core/src/OC/util.js b/core/src/OC/util.js index e3e3e2a3171..463fd937eca 100644 --- a/core/src/OC/util.js +++ b/core/src/OC/util.js @@ -148,7 +148,7 @@ export default { /** * Returns the width of a generic browser scrollbar * - * @return {int} width of scrollbar + * @return {number} width of scrollbar */ getScrollBarWidth() { if (this._scrollBarWidth) { @@ -230,7 +230,7 @@ export default { * Calls the callback in a given interval until it returns true * * @param {Function} callback function to call on success - * @param {integer} interval in milliseconds + * @param {number} interval in milliseconds */ waitFor(callback, interval) { const internalCallback = function() { |