MDL-78316 core: Improve jsdoc typedef for icons

This commit is contained in:
Andrew Nicols
2023-07-07 16:31:54 +08:00
parent f57af194fb
commit 3ff84d3eb7
2 changed files with 12 additions and 5 deletions
File diff suppressed because one or more lines are too long
+11 -4
View File
@@ -28,6 +28,13 @@ import * as Mustache from './mustache';
import * as Config from './config';
import * as Url from './url';
/**
* An set of properties for an icon.
* @typedef {object} IconProperties
* @property {array} attributes
* @private
*/
/**
* The FontAwesome icon system.
*/
@@ -154,13 +161,13 @@ export default class IconSystemFontawesome extends IconSystem {
}
/**
* Get the unamapped icon content, if the icon is not mapped.
* Get the unmapped icon content, if the icon is not mapped.
*
* @param {object<attributes<array>>} mappedIcon
* @param {IconProperties} mappedIcon
* @param {string} key
* @param {string} component
* @param {StaticRange} title
* @returns {object<attributes<array>>|null}
* @param {string} title
* @returns {IconProperties|null}
* @private
*/
getUnmappedIcon(mappedIcon, key, component, title) {