Fix jsdoc syntax error

This commit is contained in:
tetedacier
2018-05-29 10:39:29 +02:00
parent 463fb72bb2
commit c965d6b5f2
6 changed files with 13 additions and 17 deletions

View File

@@ -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) {

View File

@@ -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) {

View File

@@ -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();

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';
/**
* @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|$)');