From: Fabii547 Date: Mon, 20 Jun 2016 15:59:20 +0000 (+0200) Subject: JSDoc {integer} -> {int} (#2050) X-Git-Tag: 3.0.0_Beta_1~1384^2~4 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=a20b01c779fa7e8ac44f598f953cf50bfb86ba22;p=GitHub%2FWoltLab%2FWCF.git JSDoc {integer} -> {int} (#2050) --- diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Bbcode/ToHtml.js b/wcfsetup/install/files/js/WoltLab/WCF/Bbcode/ToHtml.js index 0327a85790..9dd173b57c 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Bbcode/ToHtml.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Bbcode/ToHtml.js @@ -162,7 +162,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @return {(string|array)} string if only the current item should be replaced or an array with * the first item used for the opening tag and the second item for the closing tag */ @@ -218,7 +218,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertAlignment: function(stack, item, index) { @@ -235,7 +235,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertAttachment: function(stack, item, index) { @@ -287,7 +287,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertCode: function(stack, item, index) { @@ -378,7 +378,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertColor: function(stack, item, index) { @@ -394,7 +394,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertEmail: function(stack, item, index) { @@ -430,7 +430,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertImage: function(stack, item, index) { @@ -484,7 +484,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertList: function(stack, item, index) { @@ -513,7 +513,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertQuote: function(stack, item, index) { @@ -590,7 +590,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertSize: function(stack, item, index) { @@ -606,7 +606,7 @@ define(['Core', 'EventHandler', 'Language', 'StringUtil', 'WoltLab/WCF/Bbcode/Pa * * @param {array} stack linear list of BBCode tags and regular strings * @param {object} item current BBCode tag object - * @param {integer} index current stack index representing `item` + * @param {int} index current stack index representing `item` * @returns {array} first item represents the opening tag, the second the closing one */ _convertUrl: function(stack, item, index) { diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Controller/User/Notification/Settings.js b/wcfsetup/install/files/js/WoltLab/WCF/Controller/User/Notification/Settings.js index 939af2398c..cffc119285 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Controller/User/Notification/Settings.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Controller/User/Notification/Settings.js @@ -96,7 +96,7 @@ define(['Dictionary', 'Language', 'Dom/Traverse', 'Ui/SimpleDropdown'], function /** * Creates the email type dropdown. * - * @param {integer} objectId notification event id + * @param {int} objectId notification event id * @param {string} initialValue initial email type * @returns {Element} dropdown menu object */ diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Date/Util.js b/wcfsetup/install/files/js/WoltLab/WCF/Date/Util.js index 1ea02e8a06..b2078f9004 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Date/Util.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Date/Util.js @@ -194,8 +194,8 @@ define(['Language'], function(Language) { /** * Returns UTC timestamp, if date is not given, current time will be used. * - * @param Date date target date - * @return integer UTC timestamp in seconds + * @param {Date} date target date + * @return {int} UTC timestamp in seconds */ gmdate: function(data) { if (!(date instanceof Date)) { @@ -215,9 +215,9 @@ define(['Language'], function(Language) { /** * Returns a Date object with precise offset (including timezone and local timezone). * - * @param integer timestamp timestamp in miliseconds - * @param integer offset timezone offset in miliseconds - * @return Date localized date + * @param {int} timestamp timestamp in miliseconds + * @param {int} offset timezone offset in miliseconds + * @return {Date} localized date */ getTimezoneDate: function(timestamp, offset) { var date = new Date(timestamp); diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Dom/Util.js b/wcfsetup/install/files/js/WoltLab/WCF/Dom/Util.js index 9cd587f56a..abf35699eb 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Dom/Util.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Dom/Util.js @@ -118,7 +118,7 @@ define(['Environment', 'StringUtil'], function(Environment, StringUtil) { * * @param {Element} el element * @param {CSSStyleDeclaration=} styles result of window.getComputedStyle() - * @return {integer} outer width in px + * @return {int} outer width in px */ outerWidth: function(el, styles) { styles = styles || window.getComputedStyle(el); diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Language/Input.js b/wcfsetup/install/files/js/WoltLab/WCF/Language/Input.js index 1055fcad4f..c60f3ffccd 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Language/Input.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Language/Input.js @@ -25,8 +25,8 @@ define(['Core', 'Dictionary', 'Language', 'ObjectMap', 'StringUtil', 'Dom/Traver * Initializes an input field. * * @param {string} elementId input element id - * @param {object} values preset values per language id - * @param {object} availableLanguages language names per language id + * @param {object} values preset values per language id + * @param {object} availableLanguages language names per language id * @param {boolean} forceSelection require i18n input */ init: function(elementId, values, availableLanguages, forceSelection) { @@ -71,7 +71,7 @@ define(['Core', 'Dictionary', 'Language', 'ObjectMap', 'StringUtil', 'Dom/Traver * @param {string} elementId input element id * @param {Element} element input or textarea element * @param {Dictionary} values preset values per language id - * @param {object} availableLanguages language names per language id + * @param {object} availableLanguages language names per language id * @param {boolean} forceSelection require i18n input */ _initElement: function(elementId, element, values, availableLanguages, forceSelection) { @@ -183,7 +183,7 @@ define(['Core', 'Dictionary', 'Language', 'ObjectMap', 'StringUtil', 'Dom/Traver * Selects a language or non-i18n from the dropdown list. * * @param {string} elementId input element id - * @param {integer} languageId language id or `0` to disable i18n + * @param {int} languageId language id or `0` to disable i18n * @param {boolean} isInit triggers pre-selection on init */ _select: function(elementId, languageId, isInit) { diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Ui/Pagination.js b/wcfsetup/install/files/js/WoltLab/WCF/Ui/Pagination.js index 5b3a03230b..927bb280b1 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Ui/Pagination.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Ui/Pagination.js @@ -16,7 +16,7 @@ define(['Core', 'Language', 'ObjectMap', 'StringUtil', 'WoltLab/WCF/Ui/Page/Jump UiPagination.prototype = { /** * maximum number of displayed page links, should match the PHP implementation - * @var {integer} + * @var {int} */ SHOW_LINKS: 11, @@ -185,7 +185,7 @@ define(['Core', 'Language', 'ObjectMap', 'StringUtil', 'WoltLab/WCF/Ui/Page/Jump /** * Creates a link to a specific page. * - * @param {integer} pageNo page number + * @param {int} pageNo page number * @return {Element} link element */ _createLink: function(pageNo) { @@ -207,7 +207,7 @@ define(['Core', 'Language', 'ObjectMap', 'StringUtil', 'WoltLab/WCF/Ui/Page/Jump /** * Switches to given page number. * - * @param {integer} pageNo page number + * @param {int} pageNo page number * @param {object} event event object */ switchPage: function(pageNo, event) { diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Ui/User/List.js b/wcfsetup/install/files/js/WoltLab/WCF/Ui/User/List.js index 10f7c49d13..a36316579d 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Ui/User/List.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Ui/User/List.js @@ -42,7 +42,7 @@ define(['Ajax', 'Core', 'Dictionary', 'Dom/Util', 'Ui/Dialog', 'WoltLab/WCF/Ui/P /** * Shows the current or given page. * - * @param {integer=} pageNo page number + * @param {int=} pageNo page number */ _showPage: function(pageNo) { if (typeof pageNo === 'number') { diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Upload.js b/wcfsetup/install/files/js/WoltLab/WCF/Upload.js index a7bc7f36b6..cbbf507299 100644 --- a/wcfsetup/install/files/js/WoltLab/WCF/Upload.js +++ b/wcfsetup/install/files/js/WoltLab/WCF/Upload.js @@ -141,7 +141,7 @@ define(['AjaxRequest', 'Core', 'Dom/ChangeListener', 'Language', 'Dom/Util', 'Do /** * Handles a failed file upload. * - * @param {integer} uploadId identifier of a file upload + * @param {int} uploadId identifier of a file upload * @param {object} data response data * @param {string} responseText response * @param {XMLHttpRequest} xhr request object @@ -172,7 +172,7 @@ define(['AjaxRequest', 'Core', 'Dom/ChangeListener', 'Language', 'Dom/Util', 'Do /** * Updates the progress of an upload. * - * @param {integer} uploadId internal upload identifier + * @param {int} uploadId internal upload identifier * @param {XMLHttpRequestProgressEvent} event progress event object */ _progress: function(uploadId, event) { @@ -198,7 +198,7 @@ define(['AjaxRequest', 'Core', 'Dom/ChangeListener', 'Language', 'Dom/Util', 'Do /** * Handles a successful file upload. * - * @param {integer} uploadId identifier of a file upload + * @param {int} uploadId identifier of a file upload * @param {object} data response data * @param {string} responseText response * @param {XMLHttpRequest} xhr request object @@ -214,7 +214,7 @@ define(['AjaxRequest', 'Core', 'Dom/ChangeListener', 'Language', 'Dom/Util', 'Do * @param {Event} event input change event object * @param {File} file uploaded file * @param {Blob} blob file blob - * @return {(integer|Array.|null)} identifier(s) for the uploaded files + * @return {(int|Array.|null)} identifier(s) for the uploaded files */ _upload: function(event, file, blob) { // remove failed upload elements first @@ -278,7 +278,7 @@ define(['AjaxRequest', 'Core', 'Dom/ChangeListener', 'Language', 'Dom/Util', 'Do * * @param {(FileList|Array.)} files uploaded files * @param {Blob} blob file blob - * @return {(integer|null)} identifier for the uploaded files + * @return {(int|null)} identifier for the uploaded files */ _uploadFiles: function(files, blob) { var uploadId = this._createFileElements(files);