From c965d6b5f2e2d0fdafec2c106e16066228068663 Mon Sep 17 00:00:00 2001 From: tetedacier Date: Tue, 29 May 2018 10:39:29 +0200 Subject: [PATCH] Fix jsdoc syntax error --- dist/index-es.js | 7 +++---- dist/index-umd.js | 7 +++---- editor/draw.js | 2 +- editor/history.js | 7 +++---- editor/historyrecording.js | 3 +-- editor/layer.js | 4 ++-- 6 files changed, 13 insertions(+), 17 deletions(-) diff --git a/dist/index-es.js b/dist/index-es.js index 14ec7a82..e85a8ab7 100644 --- a/dist/index-es.js +++ b/dist/index-es.js @@ -3197,8 +3197,7 @@ var HistoryEventTypes = { /** * An interface that all command objects must implement. - * @typedef svgedit.history.HistoryCommand - * @type {Object} + * @typedef {Object} svgedit.history.HistoryCommand * void apply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler); * Element[] elements(); @@ -11214,7 +11213,7 @@ var Layer = function () { Layer.CLASS_NAME = 'layer'; /** - * @type {RegExp} CLASS_REGEX - Used to test presence of class Layer.CLASS_NAME + * @property {RegExp} CLASS_REGEX Used to test presence of class Layer.CLASS_NAME */ Layer.CLASS_REGEX = new RegExp('(\\s|^)' + Layer.CLASS_NAME + '(\\s|$)'); @@ -11482,7 +11481,7 @@ function getNewLayerName(existingLayerNames) { * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object * encapsulates. If the svgElem has a se:nonce attribute on it, then * IDs will use the nonce as they are generated. - * @param {String=svg_} [optIdPrefix] - The ID prefix to use. + * @param {String} [optIdPrefix=svg_] - The ID prefix to use. */ var Drawing = function () { function Drawing(svgElem, optIdPrefix) { diff --git a/dist/index-umd.js b/dist/index-umd.js index 342c3829..56702051 100644 --- a/dist/index-umd.js +++ b/dist/index-umd.js @@ -3203,8 +3203,7 @@ /** * An interface that all command objects must implement. - * @typedef svgedit.history.HistoryCommand - * @type {Object} + * @typedef {Object} svgedit.history.HistoryCommand * void apply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler); * Element[] elements(); @@ -11220,7 +11219,7 @@ Layer.CLASS_NAME = 'layer'; /** - * @type {RegExp} CLASS_REGEX - Used to test presence of class Layer.CLASS_NAME + * @property {RegExp} CLASS_REGEX - Used to test presence of class Layer.CLASS_NAME */ Layer.CLASS_REGEX = new RegExp('(\\s|^)' + Layer.CLASS_NAME + '(\\s|$)'); @@ -11488,7 +11487,7 @@ * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object * encapsulates. If the svgElem has a se:nonce attribute on it, then * IDs will use the nonce as they are generated. - * @param {String=svg_} [optIdPrefix] - The ID prefix to use. + * @param {String} [optIdPrefix=svg_] - The ID prefix to use. */ var Drawing = function () { function Drawing(svgElem, optIdPrefix) { diff --git a/editor/draw.js b/editor/draw.js index 35396911..e34c26f1 100644 --- a/editor/draw.js +++ b/editor/draw.js @@ -72,7 +72,7 @@ function getNewLayerName (existingLayerNames) { * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object * encapsulates. If the svgElem has a se:nonce attribute on it, then * IDs will use the nonce as they are generated. - * @param {String=svg_} [optIdPrefix] - The ID prefix to use. + * @param {String} [optIdPrefix=svg_] - The ID prefix to use. */ export class Drawing { constructor (svgElem, optIdPrefix) { diff --git a/editor/history.js b/editor/history.js index 7c0fc396..08ee38c9 100644 --- a/editor/history.js +++ b/editor/history.js @@ -21,8 +21,7 @@ export const HistoryEventTypes = { /** * An interface that all command objects must implement. - * @typedef svgedit.history.HistoryCommand - * @type {Object} + * @typedef {Object} svgedit.history.HistoryCommand * void apply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler); * Element[] elements(); @@ -69,7 +68,7 @@ export class MoveElementCommand { /** * Re-positions the element - * @param {handleHistoryEvent: function} + * @param {{handleHistoryEvent: function}} handler */ apply (handler) { // TODO(codedread): Refactor this common event code into a base HistoryCommand class. @@ -86,7 +85,7 @@ export class MoveElementCommand { /** * Positions the element back to its original location - * @param {handleHistoryEvent: function} + * @param {{handleHistoryEvent: function}} handler */ unapply (handler) { if (handler) { diff --git a/editor/historyrecording.js b/editor/historyrecording.js index 719bbaee..277d4749 100644 --- a/editor/historyrecording.js +++ b/editor/historyrecording.js @@ -155,7 +155,6 @@ export default class HistoryRecordingService { } } /** - * @type {svgedit.history.HistoryRecordingService} NO_HISTORY - Singleton that can be passed - * in to functions that record history, but the caller requires that no history be recorded. + * @property {HistoryRecordingService} NO_HISTORY - Singleton that can be passed to functions that record history, but the caller requires that no history be recorded. */ HistoryRecordingService.NO_HISTORY = new HistoryRecordingService(); diff --git a/editor/layer.js b/editor/layer.js index b2b18d1d..9d04734a 100644 --- a/editor/layer.js +++ b/editor/layer.js @@ -185,12 +185,12 @@ export default class Layer { } } /** - * @type {string} CLASS_NAME - class attribute assigned to all layer groups. + * @property {string} CLASS_NAME - class attribute assigned to all layer groups. */ Layer.CLASS_NAME = 'layer'; /** - * @type {RegExp} CLASS_REGEX - Used to test presence of class Layer.CLASS_NAME + * @property {RegExp} CLASS_REGEX - Used to test presence of class Layer.CLASS_NAME */ Layer.CLASS_REGEX = new RegExp('(\\s|^)' + Layer.CLASS_NAME + '(\\s|$)');