- Docs: Missing returns, param names
This commit is contained in:
@@ -16,6 +16,8 @@ let contextMenuExtensions = {};
|
||||
* Signature depends on what the user adds; in the case of our uses with
|
||||
* SVGEditor, no parameters are passed nor anything expected for a return.
|
||||
* @callback module:contextmenu.MenuItemAction
|
||||
* @param {...args} args
|
||||
* @returns {any}
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -23,6 +23,7 @@ import {isMac} from '../browser.js';
|
||||
* @param {string} href The `href` value after the first character (for bypassing an initial `#`)
|
||||
* @param {external:jQuery} srcElement The wrapped jQuery srcElement
|
||||
* @param {{x: Float, y: Float, docX: Float, docY: Float}} coords
|
||||
* @returns {void}
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -44,7 +44,7 @@ class Command {
|
||||
* Applies
|
||||
*
|
||||
* @function module:history.HistoryCommand#apply
|
||||
* @param {module:history.HistoryEventHandler}
|
||||
* @param {module:history.HistoryEventHandler} handler
|
||||
* @fires module:history~Command#event:history
|
||||
* @returns {void|true}
|
||||
*/
|
||||
@@ -52,7 +52,7 @@ class Command {
|
||||
*
|
||||
* Unapplies
|
||||
* @function module:history.HistoryCommand#unapply
|
||||
* @param {module:history.HistoryEventHandler}
|
||||
* @param {module:history.HistoryEventHandler} handler
|
||||
* @fires module:history~Command#event:history
|
||||
* @returns {void|true}
|
||||
*/
|
||||
|
||||
@@ -149,6 +149,7 @@ const fixIDs = function (svgEl, svgNum, force) {
|
||||
/**
|
||||
* @callback module:jQuerySVGIcons.SVGIconsLoadedCallback
|
||||
* @param {PlainObject<string, external:jQuery>} svgIcons IDs keyed to jQuery objects of images
|
||||
* @returns {void}
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -383,6 +383,7 @@ export const getTransformList = function (elem) {
|
||||
/**
|
||||
* @callback module:SVGTransformList.removeElementFromListMap
|
||||
* @param {Element} elem
|
||||
* @returns {void}
|
||||
*/
|
||||
/**
|
||||
* Replace `removeElementFromListMap` for unit-testing.
|
||||
|
||||
@@ -3804,7 +3804,7 @@
|
||||
* Applies
|
||||
*
|
||||
* @function module:history.HistoryCommand#apply
|
||||
* @param {module:history.HistoryEventHandler}
|
||||
* @param {module:history.HistoryEventHandler} handler
|
||||
* @fires module:history~Command#event:history
|
||||
* @returns {void|true}
|
||||
*/
|
||||
@@ -3813,7 +3813,7 @@
|
||||
*
|
||||
* Unapplies
|
||||
* @function module:history.HistoryCommand#unapply
|
||||
* @param {module:history.HistoryEventHandler}
|
||||
* @param {module:history.HistoryEventHandler} handler
|
||||
* @fires module:history~Command#event:history
|
||||
* @returns {void|true}
|
||||
*/
|
||||
@@ -22464,6 +22464,7 @@
|
||||
/**
|
||||
* @callback module:jQuerySVGIcons.SVGIconsLoadedCallback
|
||||
* @param {PlainObject<string, external:jQuery>} svgIcons IDs keyed to jQuery objects of images
|
||||
* @returns {void}
|
||||
*/
|
||||
|
||||
/**
|
||||
@@ -24581,6 +24582,7 @@
|
||||
* @param {string} href The `href` value after the first character (for bypassing an initial `#`)
|
||||
* @param {external:jQuery} srcElement The wrapped jQuery srcElement
|
||||
* @param {{x: Float, y: Float, docX: Float, docY: Float}} coords
|
||||
* @returns {void}
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user