From bdfdb2ece5db20b59e43a54b145bac0f5e8192dd Mon Sep 17 00:00:00 2001 From: alschmiedt Date: Wed, 23 Sep 2020 13:26:58 -0700 Subject: [PATCH] Fix jsdoc errors and warnings (#4309) --- core/contextmenu_registry.js | 6 +- core/options.js | 6 +- core/toolbox/category.js | 2 +- core/toolbox/collapsible_category.js | 2 +- core/toolbox/separator.js | 2 +- core/utils/svg.js | 92 +++++++++++++++++++++------- 6 files changed, 78 insertions(+), 32 deletions(-) diff --git a/core/contextmenu_registry.js b/core/contextmenu_registry.js index 40bd386fc..13a316405 100644 --- a/core/contextmenu_registry.js +++ b/core/contextmenu_registry.js @@ -52,7 +52,7 @@ Blockly.ContextMenuRegistry.ScopeType = { * displayText functions that depend on this information. * @typedef {{ * block: (Blockly.BlockSvg|undefined), - * workspace: (Blockly.WorkspaceSvg|undefined), + * workspace: (Blockly.WorkspaceSvg|undefined) * }} */ Blockly.ContextMenuRegistry.Scope; @@ -65,7 +65,7 @@ Blockly.ContextMenuRegistry.Scope; * displayText: ((function(!Blockly.ContextMenuRegistry.Scope):string)|string), * preconditionFn: function(!Blockly.ContextMenuRegistry.Scope):string, * weight: number, - * id: string, + * id: string * }} */ Blockly.ContextMenuRegistry.RegistryItem; @@ -77,7 +77,7 @@ Blockly.ContextMenuRegistry.RegistryItem; * enabled: boolean, * callback: function(!Blockly.ContextMenuRegistry.Scope), * scope: !Blockly.ContextMenuRegistry.Scope, - * weight: number, + * weight: number * }} */ Blockly.ContextMenuRegistry.ContextMenuOption; diff --git a/core/options.js b/core/options.js index 7701b0b9e..489a0dfb3 100644 --- a/core/options.js +++ b/core/options.js @@ -201,7 +201,7 @@ Blockly.BlocklyOptions = function() {}; * colour: string, * length: number, * snap: boolean, - * spacing: number, + * spacing: number * }} */ Blockly.Options.GridOptions; @@ -211,7 +211,7 @@ Blockly.Options.GridOptions; * @typedef {{ * drag: boolean, * scrollbars: boolean, - * wheel: boolean, + * wheel: boolean * }} */ Blockly.Options.MoveOptions; @@ -225,7 +225,7 @@ Blockly.Options.MoveOptions; * pinch: boolean, * scaleSpeed: number, * startScale: number, - * wheel: boolean, + * wheel: boolean * }} */ Blockly.Options.ZoomOptions; diff --git a/core/toolbox/category.js b/core/toolbox/category.js index 76e3c4841..03691db73 100644 --- a/core/toolbox/category.js +++ b/core/toolbox/category.js @@ -127,7 +127,7 @@ Blockly.utils.object.inherits(Blockly.ToolboxCategory, Blockly.ToolboxItem); * label:?string, * selected:?string, * openIcon:?string, - * closedIcon:?string, + * closedIcon:?string * }} */ Blockly.ToolboxCategory.CssConfig; diff --git a/core/toolbox/collapsible_category.js b/core/toolbox/collapsible_category.js index 07b2c958a..b4e2af3c1 100644 --- a/core/toolbox/collapsible_category.js +++ b/core/toolbox/collapsible_category.js @@ -76,7 +76,7 @@ Blockly.utils.object.inherits(Blockly.CollapsibleToolboxCategory, Blockly.Toolbo * selected:?string, * openIcon:?string, * closedIcon:?string, - * contents:?string, + * contents:?string * }} */ Blockly.CollapsibleToolboxCategory.CssConfig; diff --git a/core/toolbox/separator.js b/core/toolbox/separator.js index b5a72669e..bac8a5e27 100644 --- a/core/toolbox/separator.js +++ b/core/toolbox/separator.js @@ -53,7 +53,7 @@ Blockly.utils.object.inherits(Blockly.ToolboxSeparator, Blockly.ToolboxItem); /** * All the css class names that are used to create a separator. * @typedef {{ - * container:?string, + * container:?string * }} */ Blockly.ToolboxSeparator.CssConfig; diff --git a/core/utils/svg.js b/core/utils/svg.js index e38bb08cf..dde7f7b3c 100644 --- a/core/utils/svg.js +++ b/core/utils/svg.js @@ -42,94 +42,140 @@ Blockly.utils.Svg.prototype.toString = function() { return this.tagName_; }; -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.ANIMATE = new Blockly.utils.Svg('animate'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} +* @package + */ Blockly.utils.Svg.CIRCLE = new Blockly.utils.Svg('circle'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.CLIPPATH = new Blockly.utils.Svg('clipPath'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.DEFS = new Blockly.utils.Svg('defs'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FECOMPOSITE = new Blockly.utils.Svg('feComposite'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FECOMPONENTTRANSFER = new Blockly.utils.Svg('feComponentTransfer'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FEFLOOD = new Blockly.utils.Svg('feFlood'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FEFUNCA = new Blockly.utils.Svg('feFuncA'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FEGAUSSIANBLUR = new Blockly.utils.Svg('feGaussianBlur'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FEPOINTLIGHT = new Blockly.utils.Svg('fePointLight'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FESPECULARLIGHTING = new Blockly.utils.Svg('feSpecularLighting'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FILTER = new Blockly.utils.Svg('filter'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.FOREIGNOBJECT = new Blockly.utils.Svg('foreignObject'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.G = new Blockly.utils.Svg('g'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.IMAGE = new Blockly.utils.Svg('image'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.LINE = new Blockly.utils.Svg('line'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.PATH = new Blockly.utils.Svg('path'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.PATTERN = new Blockly.utils.Svg('pattern'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.POLYGON = new Blockly.utils.Svg('polygon'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.RECT = new Blockly.utils.Svg('rect'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.SVG = new Blockly.utils.Svg('svg'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.TEXT = new Blockly.utils.Svg('text'); -/** @type {!Blockly.utils.Svg} @package */ +/** @type {!Blockly.utils.Svg} + * @package + */ Blockly.utils.Svg.TSPAN = new Blockly.utils.Svg('tspan');