mirror/feather
1
0
Fork 0
mirror of https://github.com/feathericons/feather.git synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

docs: Update function documentation

Browse Source
This commit is contained in:
Cole Bemis 2018-05-18 10:17:40 -07:00 committed by GitHub
parent 90133ea33e
commit bd129d9dcf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
bin/build-icons-object.js
View File

@ -4,8 +4,8 @@ import { minify } from 'html-minifier';
/** /**
* Build an object in the format: `{ <name>: <contents> }`. * Build an object in the format: `{ <name>: <contents> }`.
* @param {string[]} svgFiles - A list of file names. * @param {string[]} svgFiles - A list of filenames.
* @param {Function} getSvg - A function that returns the contents of an SVG file. * @param {Function} getSvg - A function that returns the contents of an SVG file given a filename.
* @returns {Object} * @returns {Object}
*/ */
function buildIconsObject(svgFiles, getSvg) { function buildIconsObject(svgFiles, getSvg) {
@ -25,6 +25,7 @@ function buildIconsObject(svgFiles, getSvg) {
/** /**
* Get contents between opening and closing `<svg>` tags. * Get contents between opening and closing `<svg>` tags.
* @param {string} svg * @param {string} svg
* @returns {string}
*/ */
function getSvgContents(svg) { function getSvgContents(svg) {
const $ = cheerio.load(svg); const $ = cheerio.load(svg);