github/svgedit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Linting (ESLint): Update as per latest ash-nazg (bad jsdoc)

Browse Source 
- npm: Update devDeps
This commit is contained in:
Brett Zamir
2019-12-31 13:14:33 +08:00
parent c9e17b8aa7
commit 477d5fdb6c
21 changed files with 203 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
editor/canvg/canvg.js
View File

@@ -27,17 +27,17 @@ const isNullish = (val) => {
/**
* @typedef {PlainObject} module:canvg.CanvgOptions
* @property {boolean} opts.ignoreMouse true => ignore mouse events
* @property {boolean} opts.ignoreAnimation true => ignore animations
* @property {boolean} opts.ignoreDimensions true => does not try to resize canvas
* @property {boolean} opts.ignoreClear true => does not clear canvas
* @property {Integer} opts.offsetX int => draws at a x offset
* @property {Integer} opts.offsetY int => draws at a y offset
* @property {Integer} opts.scaleWidth int => scales horizontally to width
* @property {Integer} opts.scaleHeight int => scales vertically to height
* @property {module:canvg.ForceRedraw} opts.forceRedraw function => will call the function on every frame, if it returns true, will redraw
* @property {boolean} opts.log Adds log function
* @property {boolean} opts.useCORS Whether to set CORS `crossOrigin` for the image to `Anonymous`
* @property {boolean} ignoreMouse true => ignore mouse events
* @property {boolean} ignoreAnimation true => ignore animations
* @property {boolean} ignoreDimensions true => does not try to resize canvas
* @property {boolean} ignoreClear true => does not clear canvas
* @property {Integer} offsetX int => draws at a x offset
* @property {Integer} offsetY int => draws at a y offset
* @property {Integer} scaleWidth int => scales horizontally to width
* @property {Integer} scaleHeight int => scales vertically to height
* @property {module:canvg.ForceRedraw} forceRedraw function => will call the function on every frame, if it returns true, will redraw
* @property {boolean} log Adds log function
* @property {boolean} useCORS Whether to set CORS `crossOrigin` for the image to `Anonymous`
*/
/**

15
editor/jgraduate/jQuery.jGraduate.js
View File

@@ -17,6 +17,7 @@
* @example $.jGraduate.Paint({hex: '#rrggbb', linearGradient: o}); // throws an exception?
*/
/* eslint-disable jsdoc/require-property */
/**
* The jQuery namespace.
* @external jQuery
@@ -27,6 +28,7 @@
* @memberof external:jQuery
* @see {@link http://learn.jquery.com/plugins/|jQuery Plugins}
*/
/* eslint-enable jsdoc/require-property */
const ns = {
svg: 'http://www.w3.org/2000/svg',
@@ -59,11 +61,11 @@ export default function jQueryPluginJGraduate ($) {
/**
* @typedef {PlainObject} module:jGraduate.jGraduatePaintOptions
* @param {Float} [alpha]
* @param {module:jGraduate~Paint} [copy] Copy paint object
* @param {SVGLinearGradientElement} [linearGradient]
* @param {SVGRadialGradientElement} [radialGradient]
* @param {string} [solidColor]
* @property {Float} [alpha]
* @property {module:jGraduate~Paint} [copy] Copy paint object
* @property {SVGLinearGradientElement} [linearGradient]
* @property {SVGRadialGradientElement} [radialGradient]
* @property {string} [solidColor]
*/
/**
@@ -144,11 +146,14 @@ export default function jQueryPluginJGraduate ($) {
}
}
}
/* eslint-disable jsdoc/require-property */
/**
* @namespace {PlainObject} jGraduate
* @memberof external:jQuery
*/
$.jGraduate = /** @lends external:jQuery.jGraduate */ {
/* eslint-enable jsdoc/require-property */
/**
* @class external:jQuery.jGraduate.Paint
* @see module:jGraduate~Paint

2
editor/jgraduate/jQuery.jPicker.js
View File

@@ -690,11 +690,13 @@ const jPicker = function ($) {
* @property {string} [ahex]
*/
/* eslint-disable jsdoc/require-property */
/**
* @namespace {PlainObject} jPicker
* @memberof external:jQuery
*/
$.jPicker = /** @lends external:jQuery.jPicker */ {
/* eslint-enable jsdoc/require-property */
/**
* Array holding references to each active instance of the jPicker control
* @type {external:jQuery.fn.$.fn.jPicker[]}

2
editor/path.js
View File

@@ -1697,6 +1697,7 @@ function pathDSegment (letter, points, morePoints, lastPoint) {
return segment;
}
/* eslint-disable jsdoc/require-property */
/**
* Group: Path edit functions
* Functions relating to editing path elements
@@ -1704,6 +1705,7 @@ function pathDSegment (letter, points, morePoints, lastPoint) {
* @memberof module:path
*/
export const pathActions = (function () {
/* eslint-enable jsdoc/require-property */
let subpath = false;
let newPoint, firstCtrl;

2
editor/svg-editor.js
View File

@@ -5552,11 +5552,13 @@ editor.init = function () {
'#tool_source_cancel', '#tool_docprops_cancel',
'#tool_prefs_cancel', '.overlay'
];
/* eslint-disable jsdoc/require-property */
/**
* Associate all button actions as well as non-button keyboard shortcuts
* @namespace {PlainObject} module:SVGEditor~Actions
*/
const Actions = (function () {
/* eslint-enable jsdoc/require-property */
/**
* @typedef {PlainObject} module:SVGEditor.ToolButton
* @property {string} sel The CSS selector for the tool

6
editor/svgcanvas.js
View File

@@ -1139,8 +1139,8 @@ const runExtensions = this.runExtensions = function (action, vars, returnArray,
*/
/**
* @typedef {PlainObject} module:svgcanvas.ExtensionInitArgs
* @param {external:jQuery} initArgs.$
* @param {module:SVGEditor~ImportLocale} initArgs.importLocale
* @property {external:jQuery} $
* @property {module:SVGEditor~ImportLocale} importLocale
*/
/**
* Add an extension to the editor.
@@ -3022,6 +3022,7 @@ $(container).bind(
);
}());
/* eslint-disable jsdoc/require-property */
/**
* Group: Text edit functions
* Functions relating to editing text elements
@@ -3029,6 +3030,7 @@ $(container).bind(
* @memberof module:svgcanvas.SvgCanvas#
*/
const textActions = canvas.textActions = (function () {
/* eslint-enable jsdoc/require-property */
let curtext;
let textinput;
let cursor;

4
editor/typedefs.js
View File

@@ -22,7 +22,7 @@
* @returns {ArbitraryCallbackResult} Return dependent on the function
*/
/* eslint-disable jsdoc/check-types */
/* eslint-disable jsdoc/require-property */
/**
* This should only be used for objects known to be potentially arbitrary in form.
* For those whose determination has not yet been made, simply use type `object`
@@ -32,7 +32,7 @@
/**
* @typedef {object} ArbitraryModule
*/
/* eslint-enable jsdoc/check-types */
/* eslint-enable jsdoc/require-property */
/**
* This should only be used for objects known to be potentially arbitrary in form,

36
editor/xdomain-svgedit-config-iife.js
View File

@@ -6805,6 +6805,8 @@
return segment;
}
/* eslint-disable jsdoc/require-property */
/**
* Group: Path edit functions
* Functions relating to editing path elements
@@ -6814,6 +6816,7 @@
var pathActions = function () {
/* eslint-enable jsdoc/require-property */
var subpath = false;
var newPoint, firstCtrl;
var currentPath = null;
@@ -14697,8 +14700,8 @@
/**
* @typedef {PlainObject} module:svgcanvas.ExtensionInitArgs
* @param {external:jQuery} initArgs.$
* @param {module:SVGEditor~ImportLocale} initArgs.importLocale
* @property {external:jQuery} $
* @property {module:SVGEditor~ImportLocale} importLocale
*/
/**
@@ -16877,6 +16880,8 @@
call('zoomDone');
});
})();
/* eslint-disable jsdoc/require-property */
/**
* Group: Text edit functions
* Functions relating to editing text elements
@@ -16886,6 +16891,7 @@
var textActions = canvas.textActions = function () {
/* eslint-enable jsdoc/require-property */
var curtext;
var textinput;
var cursor;
@@ -22910,6 +22916,8 @@
* @example $.jGraduate.Paint({hex: '#rrggbb', linearGradient: o}); // throws an exception?
*/
/* eslint-disable jsdoc/require-property */
/**
* The jQuery namespace.
* @external jQuery
@@ -22921,6 +22929,8 @@
* @memberof external:jQuery
* @see {@link http://learn.jquery.com/plugins/|jQuery Plugins}
*/
/* eslint-enable jsdoc/require-property */
var ns = {
svg: 'http://www.w3.org/2000/svg',
xlink: 'http://www.w3.org/1999/xlink'
@@ -22958,11 +22968,11 @@
}
/**
* @typedef {PlainObject} module:jGraduate.jGraduatePaintOptions
* @param {Float} [alpha]
* @param {module:jGraduate~Paint} [copy] Copy paint object
* @param {SVGLinearGradientElement} [linearGradient]
* @param {SVGRadialGradientElement} [radialGradient]
* @param {string} [solidColor]
* @property {Float} [alpha]
* @property {module:jGraduate~Paint} [copy] Copy paint object
* @property {SVGLinearGradientElement} [linearGradient]
* @property {SVGRadialGradientElement} [radialGradient]
* @property {string} [solidColor]
*/
/**
@@ -23050,6 +23060,8 @@
this.radialGradient = null;
}
};
/* eslint-disable jsdoc/require-property */
/**
* @namespace {PlainObject} jGraduate
* @memberof external:jQuery
@@ -23059,6 +23071,8 @@
$.jGraduate =
/** @lends external:jQuery.jGraduate */
{
/* eslint-enable jsdoc/require-property */
/**
* @class external:jQuery.jGraduate.Paint
* @see module:jGraduate~Paint
@@ -25724,6 +25738,8 @@
* @property {string} [ahex]
*/
/* eslint-disable jsdoc/require-property */
/**
* @namespace {PlainObject} jPicker
* @memberof external:jQuery
@@ -25733,6 +25749,8 @@
$.jPicker =
/** @lends external:jQuery.jPicker */
{
/* eslint-enable jsdoc/require-property */
/**
* Array holding references to each active instance of the jPicker control
* @type {external:jQuery.fn.$.fn.jPicker[]}
@@ -35241,12 +35259,16 @@
$$b('input,select').attr('autocomplete', 'off');
var dialogSelectors = ['#tool_source_cancel', '#tool_docprops_cancel', '#tool_prefs_cancel', '.overlay'];
/* eslint-disable jsdoc/require-property */
/**
* Associate all button actions as well as non-button keyboard shortcuts
* @namespace {PlainObject} module:SVGEditor~Actions
*/
var Actions = function () {
/* eslint-enable jsdoc/require-property */
/**
* @typedef {PlainObject} module:SVGEditor.ToolButton
* @property {string} sel The CSS selector for the tool