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

Fix jsdoc syntax error

master
tetedacier 2018-05-29 10:39:29 +02:00
parent 463fb72bb2
commit c965d6b5f2
6 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
dist/index-es.js vendored
View File

@ -3197,8 +3197,7 @@ var HistoryEventTypes = {
/** /**
* An interface that all command objects must implement. * An interface that all command objects must implement.
* @typedef svgedit.history.HistoryCommand * @typedef {Object} svgedit.history.HistoryCommand
* @type {Object}
* void apply(svgedit.history.HistoryEventHandler); * void apply(svgedit.history.HistoryEventHandler);
* void unapply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler);
* Element[] elements(); * Element[] elements();
@ -11214,7 +11213,7 @@ var Layer = function () {
Layer.CLASS_NAME = 'layer'; 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|$)'); 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 * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object
* encapsulates. If the svgElem has a se:nonce attribute on it, then * encapsulates. If the svgElem has a se:nonce attribute on it, then
* IDs will use the nonce as they are generated. * 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 () { var Drawing = function () {
function Drawing(svgElem, optIdPrefix) { function Drawing(svgElem, optIdPrefix) {

7
dist/index-umd.js vendored
View File

@ -3203,8 +3203,7 @@
/** /**
* An interface that all command objects must implement. * An interface that all command objects must implement.
* @typedef svgedit.history.HistoryCommand * @typedef {Object} svgedit.history.HistoryCommand
* @type {Object}
* void apply(svgedit.history.HistoryEventHandler); * void apply(svgedit.history.HistoryEventHandler);
* void unapply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler);
* Element[] elements(); * Element[] elements();
@ -11220,7 +11219,7 @@
Layer.CLASS_NAME = 'layer'; 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|$)'); 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 * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object
* encapsulates. If the svgElem has a se:nonce attribute on it, then * encapsulates. If the svgElem has a se:nonce attribute on it, then
* IDs will use the nonce as they are generated. * 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 () { var Drawing = function () {
function Drawing(svgElem, optIdPrefix) { function Drawing(svgElem, optIdPrefix) {

2
editor/draw.js
View File

@ -72,7 +72,7 @@ function getNewLayerName (existingLayerNames) {
* @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object * @param {SVGSVGElement} svgElem - The SVG DOM Element that this JS object
* encapsulates. If the svgElem has a se:nonce attribute on it, then * encapsulates. If the svgElem has a se:nonce attribute on it, then
* IDs will use the nonce as they are generated. * 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 { export class Drawing {
constructor (svgElem, optIdPrefix) { constructor (svgElem, optIdPrefix) {

7
editor/history.js
View File

@ -21,8 +21,7 @@ export const HistoryEventTypes = {
/** /**
* An interface that all command objects must implement. * An interface that all command objects must implement.
* @typedef svgedit.history.HistoryCommand * @typedef {Object} svgedit.history.HistoryCommand
* @type {Object}
* void apply(svgedit.history.HistoryEventHandler); * void apply(svgedit.history.HistoryEventHandler);
* void unapply(svgedit.history.HistoryEventHandler); * void unapply(svgedit.history.HistoryEventHandler);
* Element[] elements(); * Element[] elements();
@ -69,7 +68,7 @@ export class MoveElementCommand {
/** /**
* Re-positions the element * Re-positions the element
* @param {handleHistoryEvent: function} * @param {{handleHistoryEvent: function}} handler
*/ */
apply (handler) { apply (handler) {
// TODO(codedread): Refactor this common event code into a base HistoryCommand class. // 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 * Positions the element back to its original location
* @param {handleHistoryEvent: function} * @param {{handleHistoryEvent: function}} handler
*/ */
unapply (handler) { unapply (handler) {
if (handler) { if (handler) {

3
editor/historyrecording.js
View File

@ -155,7 +155,6 @@ export default class HistoryRecordingService {
} }
} }
/** /**
* @type {svgedit.history.HistoryRecordingService} NO_HISTORY - Singleton that can be passed * @property {HistoryRecordingService} NO_HISTORY - Singleton that can be passed to functions that record history, but the caller requires that no history be recorded.
* in to functions that record history, but the caller requires that no history be recorded.
*/ */
HistoryRecordingService.NO_HISTORY = new HistoryRecordingService(); HistoryRecordingService.NO_HISTORY = new HistoryRecordingService();

4
editor/layer.js
View File

@ -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'; 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|$)'); Layer.CLASS_REGEX = new RegExp('(\\s|^)' + Layer.CLASS_NAME + '(\\s|$)');