diff --git a/editor/path.js b/editor/path.js index 29ffa151..b391765e 100644 --- a/editor/path.js +++ b/editor/path.js @@ -89,7 +89,7 @@ let editorContext_ = null; * Object with the following keys/values * @typedef {PlainObject} module:path.SVGElementJSON * @property {string} element - Tag name of the SVG element to create -* @property {PlainObject} attr - Has key-value attributes to assign to the new element +* @property {PlainObject} attr - Has key-value attributes to assign to the new element. An `id` should be set so that {@link module:utilities.EditorContext#addSVGElementFromJson} can later re-identify the element for modification or replacement. * @property {boolean} [curStyles=false] - Indicates whether current style attributes should be applied first * @property {module:path.SVGElementJSON[]} [children] - Data objects to be added recursively as children * @property {string} [namespace="http://www.w3.org/2000/svg"] - Indicate a (non-SVG) namespace diff --git a/editor/utilities.js b/editor/utilities.js index 36bac308..190cf69a 100644 --- a/editor/utilities.js +++ b/editor/utilities.js @@ -41,7 +41,7 @@ let svgroot_ = null; * Object with the following keys/values * @typedef {PlainObject} module:utilities.SVGElementJSON * @property {string} element - Tag name of the SVG element to create -* @property {PlainObject} attr - Has key-value attributes to assign to the new element +* @property {PlainObject} attr - Has key-value attributes to assign to the new element. An `id` should be set so that {@link module:utilities.EditorContext#addSVGElementFromJson} can later re-identify the element for modification or replacement. * @property {boolean} [curStyles=false] - Indicates whether current style attributes should be applied first * @property {module:utilities.SVGElementJSON[]} [children] - Data objects to be added recursively as children * @property {string} [namespace="http://www.w3.org/2000/svg"] - Indicate a (non-SVG) namespace diff --git a/package-lock.json b/package-lock.json index c0641496..fa81564d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4195,9 +4195,9 @@ } }, "eslint-plugin-jsdoc": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-9.0.1.tgz", - "integrity": "sha512-4Sd6rjpMJ5YOd2WnCcgWW7K/EIawKKYgn4ObtDG0pyDP+QpN9EyRoPvY62IQtUOz5KkAS/EpFvEIMUo3qUyeyQ==", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-10.0.0.tgz", + "integrity": "sha512-xZUjGTjg4t4XoHe4VVlIddV9Xy3XFDKOyVTwM1kuyGGSP691w/o3TbxNIHe7j+x+8hcR1KGk/uLEOaI+FCTQgg==", "dev": true, "requires": { "comment-parser": "^0.5.5", diff --git a/package.json b/package.json index dbb6271a..1f9a836a 100644 --- a/package.json +++ b/package.json @@ -91,7 +91,7 @@ "eslint-plugin-compat": "^3.2.0", "eslint-plugin-eslint-comments": "^3.1.2", "eslint-plugin-import": "2.18.0", - "eslint-plugin-jsdoc": "^9.0.1", + "eslint-plugin-jsdoc": "^10.0.0", "eslint-plugin-markdown": "^1.0.0", "eslint-plugin-no-use-extend-native": "^0.4.1", "eslint-plugin-node": "9.1.0",