- Refactoring: Avoid unnecessary addEventListener false; change internal

jPicker function to class (used with `new`)
- Linting (ESLint): Add `valid-jsdoc` rule and make fixes; but turn off for
  now due to <https://github.com/eslint/eslint/issues/11036> and
  <https://github.com/eslint/eslint/issues/11037>
- Docs (JSDoc): Add some Markdown for variables, line breaks; tighten checks
  for overly generic types (though allow for `.Function` as in
  `jQuery.Function`) and avoid one previously missed instance
This commit is contained in:
Brett Zamir
2018-10-30 23:25:20 +08:00
parent 9b9c900ede
commit aef7b095ef
47 changed files with 1664 additions and 1441 deletions

View File

@@ -31,6 +31,7 @@ let canvasRGBA_ = canvasRGBA;
/**
* @function module:canvg.setStackBlurCanvasRGBA
* @param {module:canvg.StackBlurCanvasRGBA} cb Will be passed the canvas ID, x, y, width, height, blurRadius
* @returns {undefined}
*/
export const setStackBlurCanvasRGBA = (cb) => {
canvasRGBA_ = cb;
@@ -52,7 +53,8 @@ export const setStackBlurCanvasRGBA = (cb) => {
*/
/**
* If called with no arguments, it will replace all `<svg>` elements on the page with `<canvas>` elements
* If called with no arguments, it will replace all `<svg>` elements on the page
* with `<canvas>` elements.
* @function module:canvg.canvg
* @param {HTMLCanvasElement|string} target canvas element or the id of a canvas element
* @param {string|XMLDocument} s: svg string, url to svg file, or xml document
@@ -102,7 +104,7 @@ export const canvg = function (target, s, opts) {
/**
* @param {module:canvg.CanvgOptions} opts
* @returns {object}
* @returns {Object}
* @todo Flesh out exactly what object is returned here (after updating to latest and reincluding our changes here and those of StackBlur)
*/
function build (opts) {

View File

@@ -189,7 +189,7 @@ const colorDefs = [
];
/**
* A class to parse color values
* A class to parse color values.
*/
export default class RGBColor {
/**
@@ -253,7 +253,7 @@ export default class RGBColor {
}
/**
* help
* Offers a bulleted list of help.
* @returns {HTMLUListElement}
*/
getHelpXML () {
@@ -275,8 +275,8 @@ export default class RGBColor {
const listItem = document.createElement('li');
const listColor = new RGBColor(examples[i]);
const exampleDiv = document.createElement('div');
exampleDiv.style.cssText =
`margin: 3px;
exampleDiv.style.cssText = `
margin: 3px;
border: 1px solid black;
background: ${listColor.toHex()};
color: ${listColor.toHex()};`