Add generic type and description when its missing

Signed-off-by: Louis Chemineau <louis@chmn.me>
This commit is contained in:
Louis Chemineau 2022-01-10 14:16:47 +01:00
parent d92cbf5149
commit 9fc6cc9634
36 changed files with 68 additions and 69 deletions

View File

@ -65,8 +65,8 @@ export default async function({ commentsType, ressourceId }, options = {}) {
// https://github.com/perry-mitchell/webdav-client/blob/9de2da4a2599e06bd86c2778145b7ade39fe0b3c/source/interface/directoryContents.js#L32 // https://github.com/perry-mitchell/webdav-client/blob/9de2da4a2599e06bd86c2778145b7ade39fe0b3c/source/interface/directoryContents.js#L32
/** /**
* @param result * @param {any} result -
* @param isDetailed * @param {any} isDetailed -
*/ */
function processMultistatus(result, isDetailed = false) { function processMultistatus(result, isDetailed = false) {
// Extract the response items (directory contents) // Extract the response items (directory contents)
@ -91,8 +91,8 @@ function processMultistatus(result, isDetailed = false) {
} }
/** /**
* @param value * @param {any} value -
* @param passes * @param {any} passes -
*/ */
function decodeHtmlEntities(value, passes = 1) { function decodeHtmlEntities(value, passes = 1) {
const parser = new DOMParser() const parser = new DOMParser()

View File

@ -108,8 +108,8 @@ export async function findScheduleInboxAvailability() {
} }
/** /**
* @param slots * @param {any} slots -
* @param timezoneId * @param {any} timezoneId -
*/ */
export async function saveScheduleInboxAvailability(slots, timezoneId) { export async function saveScheduleInboxAvailability(slots, timezoneId) {
const all = [...Object.keys(slots).flatMap(dayId => slots[dayId].map(slot => ({ const all = [...Object.keys(slots).flatMap(dayId => slots[dayId].map(slot => ({

View File

@ -1203,7 +1203,7 @@
/** /**
* Custom code * Custom code
* Set tag for all selected files * Set tag for all selected files
* @param tagModel * @param {any} tagModel -
* @private * @private
*/ */
_onSelectTag: function(tagModel) { _onSelectTag: function(tagModel) {
@ -1221,7 +1221,7 @@
}, },
/** /**
* remove tag from all selected files * remove tag from all selected files
* @param tagId * @param {any} tagId -
* @private * @private
*/ */
_onDeselectTag: function(tagId) { _onDeselectTag: function(tagId) {
@ -3348,7 +3348,7 @@
}, },
/** /**
* hide files matching the given filter * hide files matching the given filter
* @param filter * @param {any} filter -
*/ */
setFilter:function(filter) { setFilter:function(filter) {
var total = 0; var total = 0;
@ -3413,7 +3413,7 @@
}, },
/** /**
* get the current filter * get the current filter
* @param filter * @param {any} filter -
*/ */
getFilter:function(filter) { getFilter:function(filter) {
return this._filter; return this._filter;

View File

@ -23,7 +23,7 @@
import axios from '@nextcloud/axios' import axios from '@nextcloud/axios'
/** /**
* @param url * @param {any} url -
*/ */
export default async function(url) { export default async function(url) {
const response = await axios({ const response = await axios({

View File

@ -383,8 +383,8 @@ OCA.Files_External.StatusManager = {
/** /**
* Function to display custom dialog to enter credentials * Function to display custom dialog to enter credentials
* @param mountPoint * @param {any} mountPoint -
* @param mountData * @param {any} mountData -
*/ */
showCredentialsDialog: function (mountPoint, mountData) { showCredentialsDialog: function (mountPoint, mountData) {
var dialog = $(OCA.Files_External.Templates.credentialsDialog({ var dialog = $(OCA.Files_External.Templates.credentialsDialog({

View File

@ -377,12 +377,12 @@ OCA.Sharing.PublicApp = {
* fall back to old behaviour where we redirect the user to his server to mount * fall back to old behaviour where we redirect the user to his server to mount
* the public link instead of creating a dedicated federated share * the public link instead of creating a dedicated federated share
* *
* @param remote * @param {any} remote -
* @param token * @param {any} token -
* @param owner * @param {any} owner -
* @param ownerDisplayName * @param {any} ownerDisplayName -
* @param name * @param {any} name -
* @param isProtected * @param {any} isProtected -
* @private * @private
*/ */
_legacyCreateFederatedShare: function (remote, token, owner, ownerDisplayName, name, isProtected) { _legacyCreateFederatedShare: function (remote, token, owner, ownerDisplayName, name, isProtected) {

View File

@ -16,7 +16,7 @@ OC.Settings = OC.Settings || {};
* The callback will be fired as soon as enter is pressed by the * The callback will be fired as soon as enter is pressed by the
* user or 1 second after the last data entry * user or 1 second after the last data entry
* *
* @param callback * @param {any} callback -
* @param allowEmptyValue if this is set to true the callback is also called when the value is empty * @param allowEmptyValue if this is set to true the callback is also called when the value is empty
*/ */
jQuery.fn.keyUpDelayedOrEnter = function (callback, allowEmptyValue) { jQuery.fn.keyUpDelayedOrEnter = function (callback, allowEmptyValue) {

View File

@ -34,8 +34,8 @@ export async function startRegistration() {
} }
/** /**
* @param name * @param {any} name -
* @param data * @param {any} data -
*/ */
export async function finishRegistration(name, data) { export async function finishRegistration(name, data) {
const url = generateUrl('/settings/api/personal/webauthn/registration') const url = generateUrl('/settings/api/personal/webauthn/registration')
@ -45,7 +45,7 @@ export async function finishRegistration(name, data) {
} }
/** /**
* @param id * @param {any} id -
*/ */
export async function removeRegistration(id) { export async function removeRegistration(id) {
const url = generateUrl(`/settings/api/personal/webauthn/registration/${id}`) const url = generateUrl(`/settings/api/personal/webauthn/registration/${id}`)

View File

@ -278,7 +278,7 @@ const actions = {
* @param {object} options destructuring object * @param {object} options destructuring object
* @param {number} options.offset List offset to request * @param {number} options.offset List offset to request
* @param {number} options.limit List number to return from offset * @param {number} options.limit List number to return from offset
* @param options.search * @param {string} options.search -
* @return {Promise} * @return {Promise}
*/ */
getUsersFromList(context, { offset, limit, search }) { getUsersFromList(context, { offset, limit, search }) {
@ -301,7 +301,7 @@ const actions = {
* @param {object} options destructuring object * @param {object} options destructuring object
* @param {number} options.offset List offset to request * @param {number} options.offset List offset to request
* @param {number} options.limit List number to return from offset * @param {number} options.limit List number to return from offset
* @param options.groupid * @param {string} options.groupid -
* @return {Promise} * @return {Promise}
*/ */
getUsersFromGroup(context, { groupid, offset, limit }) { getUsersFromGroup(context, { groupid, offset, limit }) {
@ -462,8 +462,8 @@ const actions = {
* Add a user * Add a user
* *
* @param {object} context store context * @param {object} context store context
* @param {Function} context.commit * @param {Function} context.commit -
* @param {Function} context.dispatch * @param {Function} context.dispatch -
* @param {object} options destructuring object * @param {object} options destructuring object
* @param {string} options.userid User id * @param {string} options.userid User id
* @param {string} options.password User password * @param {string} options.password User password
@ -473,7 +473,6 @@ const actions = {
* @param {string} options.subadmin User subadmin groups * @param {string} options.subadmin User subadmin groups
* @param {string} options.quota User email * @param {string} options.quota User email
* @param {string} options.language User language * @param {string} options.language User language
* @param options.language
* @return {Promise} * @return {Promise}
*/ */
addUser({ commit, dispatch }, { userid, password, displayName, email, groups, subadmin, quota, language }) { addUser({ commit, dispatch }, { userid, password, displayName, email, groups, subadmin, quota, language }) {

View File

@ -48,7 +48,7 @@
/** /**
* Array of system tag ids to filter by * Array of system tag ids to filter by
* *
* @type Array.<string> * @type {Array.<string>}
*/ */
_systemTagIds: [], _systemTagIds: [],
_lastUsedTags: [], _lastUsedTags: [],

View File

@ -27,7 +27,7 @@
(function(OCA) { (function(OCA) {
/** /**
* @param model * @param {any} model -
*/ */
function modelToSelection(model) { function modelToSelection(model) {
const data = model.toJSON() const data = model.toJSON()

View File

@ -22,7 +22,7 @@
*/ */
/** /**
* @param data * @param {any} data -
*/ */
export function print(data) { export function print(data) {
const name = OC.theme.name || 'Nextcloud' const name = OC.theme.name || 'Nextcloud'

View File

@ -17,8 +17,8 @@ OCA = OCA || {};
/** /**
* initializes the instance. Always call it after initialization. * initializes the instance. Always call it after initialization.
* *
* @param tabIndex * @param {any} tabIndex -
* @param tabID * @param {any} tabID -
*/ */
init: function (tabIndex, tabID) { init: function (tabIndex, tabID) {
this._super(tabIndex, tabID); this._super(tabIndex, tabID);
@ -281,7 +281,7 @@ OCA = OCA || {};
setDynamicGroupMemberURL: function(attribute) { setDynamicGroupMemberURL: function(attribute) {
this.setElementValue(this.managedItems.ldap_dynamic_group_member_url.$element, attribute); this.setElementValue(this.managedItems.ldap_dynamic_group_member_url.$element, attribute);
}, },
/** /**
* enabled or disables the use of nested groups (groups in groups in * enabled or disables the use of nested groups (groups in groups in
* groups) * groups)

View File

@ -22,8 +22,8 @@ OCA = OCA || {};
/** /**
* initializes the instance. Always call it after initialization. * initializes the instance. Always call it after initialization.
* *
* @param tabIndex * @param {any} tabIndex -
* @param tabID * @param {any} tabID -
*/ */
init: function (tabIndex, tabID) { init: function (tabIndex, tabID) {
tabIndex = 0; tabIndex = 0;
@ -245,8 +245,8 @@ OCA = OCA || {};
* updates the configuration chooser upon the deletion of a * updates the configuration chooser upon the deletion of a
* configuration and, if necessary, loads an existing one. * configuration and, if necessary, loads an existing one.
* *
* @param view * @param {any} view -
* @param result * @param {any} result -
*/ */
onDeleteConfiguration: function(view, result) { onDeleteConfiguration: function(view, result) {
if(result.isSuccess === true) { if(result.isSuccess === true) {

View File

@ -17,8 +17,8 @@ OCA = OCA || {};
/** /**
* initializes the instance. Always call it after initialization. * initializes the instance. Always call it after initialization.
* *
* @param tabIndex * @param {any} tabIndex -
* @param tabID * @param {any} tabID -
*/ */
init: function (tabIndex, tabID) { init: function (tabIndex, tabID) {
this._super(tabIndex, tabID); this._super(tabIndex, tabID);

View File

@ -147,8 +147,8 @@ OCA = OCA || {};
/** /**
* displays server error messages. * displays server error messages.
* *
* @param view * @param {any} view -
* @param payload * @param {any} payload -
*/ */
onServerError: function(view, payload) { onServerError: function(view, payload) {
if ( !_.isUndefined(view.managedItems[payload.relatedKey])) { if ( !_.isUndefined(view.managedItems[payload.relatedKey])) {
@ -456,7 +456,7 @@ OCA = OCA || {};
* sets the filter mode initially and resets the "isToggling" marker. * sets the filter mode initially and resets the "isToggling" marker.
* This method is called after a save operation against the mode key. * This method is called after a save operation against the mode key.
* *
* @param mode * @param {any} mode -
*/ */
setFilterModeOnce: function(mode) { setFilterModeOnce: function(mode) {
this.isToggling = false; this.isToggling = false;

View File

@ -16,8 +16,8 @@ OCA = OCA || {};
/** /**
* initializes the instance. Always call it after initialization. * initializes the instance. Always call it after initialization.
* *
* @param tabIndex * @param {any} tabIndex -
* @param tabID * @param {any} tabID -
*/ */
init: function (tabIndex, tabID) { init: function (tabIndex, tabID) {
this._super(tabIndex, tabID); this._super(tabIndex, tabID);
@ -134,7 +134,7 @@ OCA = OCA || {};
/** /**
* presents the result of the login name test * presents the result of the login name test
* *
* @param result * @param {any} result -
*/ */
handleLoginTestResult: function(result) { handleLoginTestResult: function(result) {
var message; var message;

View File

@ -48,7 +48,7 @@ const actions = {
* *
* @param {object} vuex The Vuex components * @param {object} vuex The Vuex components
* @param {Function} vuex.commit The Vuex commit function * @param {Function} vuex.commit The Vuex commit function
* @param vuex.state * @param {object} vuex.state -
*/ */
async loadAllPredefinedStatuses({ state, commit }) { async loadAllPredefinedStatuses({ state, commit }) {
if (state.predefinedStatuses.length > 0) { if (state.predefinedStatuses.length > 0) {

View File

@ -28,7 +28,7 @@ import OC from './index'
import { formatFileSize as humanFileSize } from '@nextcloud/files' import { formatFileSize as humanFileSize } from '@nextcloud/files'
/** /**
* @param t * @param {any} t -
*/ */
function chunkify(t) { function chunkify(t) {
// Adapted from http://my.opera.com/GreyWyvern/blog/show.dml/1671288 // Adapted from http://my.opera.com/GreyWyvern/blog/show.dml/1671288

View File

@ -35,21 +35,21 @@ import $ from 'jquery'
const urlRegex = /(\s|^)(https?:\/\/)?((?:[-A-Z0-9+_]+\.)+[-A-Z]+(?:\/[-A-Z0-9+&@#%?=~_|!:,.;()]*)*)(\s|$)/ig const urlRegex = /(\s|^)(https?:\/\/)?((?:[-A-Z0-9+_]+\.)+[-A-Z]+(?:\/[-A-Z0-9+&@#%?=~_|!:,.;()]*)*)(\s|$)/ig
/** /**
* @param content * @param {any} content -
*/ */
export function plainToRich(content) { export function plainToRich(content) {
return this.formatLinksRich(content) return this.formatLinksRich(content)
} }
/** /**
* @param content * @param {any} content -
*/ */
export function richToPlain(content) { export function richToPlain(content) {
return this.formatLinksPlain(content) return this.formatLinksPlain(content)
} }
/** /**
* @param content * @param {any} content -
*/ */
export function formatLinksRich(content) { export function formatLinksRich(content) {
return content.replace(urlRegex, function(_, leadingSpace, protocol, url, trailingSpace) { return content.replace(urlRegex, function(_, leadingSpace, protocol, url, trailingSpace) {
@ -65,7 +65,7 @@ export function formatLinksRich(content) {
} }
/** /**
* @param content * @param {any} content -
*/ */
export function formatLinksPlain(content) { export function formatLinksPlain(content) {
const $content = $('<div></div>').html(content) const $content = $('<div></div>').html(content)

View File

@ -26,7 +26,7 @@ import $ from 'jquery'
import { generateOcsUrl } from '@nextcloud/router' import { generateOcsUrl } from '@nextcloud/router'
/** /**
* @param options * @param {any} options -
*/ */
export function query(options) { export function query(options) {
options = options || {} options = options || {}
@ -42,8 +42,8 @@ export function query(options) {
} }
/** /**
* @param version * @param {any} version -
* @param options * @param {any} options -
*/ */
export function dismiss(version, options) { export function dismiss(version, options) {
options = options || {} options = options || {}
@ -59,10 +59,10 @@ export function dismiss(version, options) {
} }
/** /**
* @param data * @param {any} data -
* @param statusText * @param {any} statusText -
* @param xhr * @param {any} xhr -
* @param dismissOptions * @param {any} dismissOptions -
*/ */
function onQuerySuccess(data, statusText, xhr, dismissOptions) { function onQuerySuccess(data, statusText, xhr, dismissOptions) {
console.debug('querying Whats New data was successful: ' + statusText) console.debug('querying Whats New data was successful: ' + statusText)
@ -145,9 +145,9 @@ function onQuerySuccess(data, statusText, xhr, dismissOptions) {
} }
/** /**
* @param x * @param {any} x -
* @param t * @param {any} t -
* @param e * @param {any} e -
*/ */
function onQueryError(x, t, e) { function onQueryError(x, t, e) {
console.debug('querying Whats New Data resulted in an error: ' + t + e) console.debug('querying Whats New Data resulted in an error: ' + t + e)
@ -155,14 +155,14 @@ function onQueryError(x, t, e) {
} }
/** /**
* @param data * @param {any} data -
*/ */
function onDismissSuccess(data) { function onDismissSuccess(data) {
// noop // noop
} }
/** /**
* @param data * @param {any} data -
*/ */
function onDismissError(data) { function onDismissError(data) {
console.debug('dismissing Whats New data resulted in an error: ' + data) console.debug('dismissing Whats New data resulted in an error: ' + data)

View File

@ -22,7 +22,7 @@
*/ */
/** /**
* @param name * @param {any} name -
*/ */
export default function getURLParameter(name) { export default function getURLParameter(name) {
return decodeURIComponent( return decodeURIComponent(

View File

@ -26,7 +26,7 @@ import $ from 'jquery'
/** /**
* select a range in an input field * select a range in an input field
* *
* @link http://stackoverflow.com/questions/499126/jquery-set-cursor-position-in-text-area * @see {@link http://stackoverflow.com/questions/499126/jquery-set-cursor-position-in-text-area}
* @param {number} start start selection from * @param {number} start start selection from
* @param {number} end number of char from start * @param {number} end number of char from start
* @return {void} * @return {void}

View File

@ -24,7 +24,7 @@ import Axios from '@nextcloud/axios'
import { generateUrl } from '@nextcloud/router' import { generateUrl } from '@nextcloud/router'
/** /**
* @param loginName * @param {any} loginName -
*/ */
export function startAuthentication(loginName) { export function startAuthentication(loginName) {
const url = generateUrl('/login/webauthn/start') const url = generateUrl('/login/webauthn/start')
@ -34,7 +34,7 @@ export function startAuthentication(loginName) {
} }
/** /**
* @param data * @param {any} data -
*/ */
export function finishAuthentication(data) { export function finishAuthentication(data) {
const url = generateUrl('/login/webauthn/finish') const url = generateUrl('/login/webauthn/finish')

View File

@ -61,7 +61,7 @@
* Lazy fetch. * Lazy fetch.
* Only fetches once, subsequent calls will directly call the success handler. * Only fetches once, subsequent calls will directly call the success handler.
* *
* @param options * @param {any} options -
* @param [options.force] true to force fetch even if cached entries exist * @param [options.force] true to force fetch even if cached entries exist
* *
* @see Backbone.Collection#fetch * @see Backbone.Collection#fetch

Binary file not shown.

Binary file not shown.

BIN
dist/core-login.js.map vendored

Binary file not shown.

BIN
dist/core-main.js.map vendored

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.