add jsdoc and solved the linting issues

js/pastebox.js

@@ -9,12 +9,28 @@
 // License along with this library; if not, write to the Free Software
 // Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA
 
-const PASTEBOX = '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="280" height="55"> <rect width="280" height="55" x="0" y="-3.5762787e-06" style="fill:#f0f0f0;fill-opacity:1;fill-rule:nonzero;stroke:none" /> <g transform="translate(225,0)" style="fill:#000000;display:block"> <path d="m 27.557,5.053 c -12.43,0 -22.5,10.076 -22.5,22.497 0,12.432 10.07,22.503 22.5,22.503 12.431,0 22.5,-10.071 22.5,-22.503 0,-12.421 -10.07,-22.497 -22.5,-22.497 z m 10.199,28.159 c 1.254,1.256 1.257,3.291 0,4.545 -0.628,0.629 -1.451,0.943 -2.274,0.943 -0.822,0 -1.644,-0.314 -2.27,-0.94 l -5.76,-5.761 -5.76,5.761 c -0.627,0.626 -1.449,0.94 -2.271,0.94 -0.823,0 -1.647,-0.314 -2.275,-0.943 -1.254,-1.254 -1.254,-3.289 0.004,-4.545 l 5.758,-5.758 -5.758,-5.758 c -1.258,-1.254 -1.258,-3.292 -0.004,-4.546 1.255,-1.254 3.292,-1.259 4.546,0 l 5.76,5.759 5.76,-5.759 c 1.252,-1.259 3.288,-1.254 4.544,0 1.257,1.254 1.254,3.292 0,4.546 l -5.758,5.758 5.758,5.758 z" style="fill:#000000;display:inline" /> </g></svg>';
+const PASTEBOX =
+    '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="280" height="55"> <rect width="280" height="55" x="0" y="-3.5762787e-06" style="fill:#f0f0f0;fill-opacity:1;fill-rule:nonzero;stroke:none" /> <g transform="translate(225,0)" style="fill:#000000;display:block"> <path d="m 27.557,5.053 c -12.43,0 -22.5,10.076 -22.5,22.497 0,12.432 10.07,22.503 22.5,22.503 12.431,0 22.5,-10.071 22.5,-22.503 0,-12.421 -10.07,-22.497 -22.5,-22.497 z m 10.199,28.159 c 1.254,1.256 1.257,3.291 0,4.545 -0.628,0.629 -1.451,0.943 -2.274,0.943 -0.822,0 -1.644,-0.314 -2.27,-0.94 l -5.76,-5.761 -5.76,5.761 c -0.627,0.626 -1.449,0.94 -2.271,0.94 -0.823,0 -1.647,-0.314 -2.275,-0.943 -1.254,-1.254 -1.254,-3.289 0.004,-4.545 l 5.758,-5.758 -5.758,-5.758 c -1.258,-1.254 -1.258,-3.292 -0.004,-4.546 1.255,-1.254 3.292,-1.259 4.546,0 l 5.76,5.759 5.76,-5.759 c 1.252,-1.259 3.288,-1.254 4.544,0 1.257,1.254 1.254,3.292 0,4.546 l -5.758,5.758 5.758,5.758 z" style="fill:#000000;display:inline" /> </g></svg>';
 
 // A pop up for pasting from the browser clipboard
+
+/* global docById, createjs */
+
+/*
+   Global locations
+    js/utils/utils.js
+        _
+    js/activity.js
+        createjs
+*/
+
+/* exported PasteBox */
 class PasteBox {
-    constructor() {
 
+    /**
+     * @constructor
+     */
+    constructor() {
         this._canvas = null;
         this._stage = null;
         this._refreshCanvas = null;
@@ -24,27 +40,50 @@ class PasteBox {
         this.close = null;
         this._scale = 1;
     }
-
+    /**
+     * @public
+     * @param {Object} canvas object
+     * @returns {Object} createjs canvas
+     */
     setCanvas(canvas) {
         this._canvas = canvas;
         return this;
     }
 
+    /**
+     * @public
+     * @param {Object} stage 
+     * @returns {Object} createjs stage
+     */
     setStage(stage) {
         this._stage = stage;
         return this;
     }
 
+        /**
+         * @public
+         * @param {Object} paste 
+         * @returns {Object} paste
+         */
     setPaste(paste) {
         this._paste = paste;
         return this;
     }
 
+    /**
+     * @public
+     * @param {Object} refreshCanvas 
+     * @returns {Object} refreshCanvas
+     */
     setRefreshCanvas(refreshCanvas) {
         this._refreshCanvas = refreshCanvas;
         return this;
     }
 
+    /**
+     * @public
+     * @returns {void}
+     */
     hide() {
         if (this._container != null) {
             this._container.visible = false;
@@ -55,6 +94,12 @@ class PasteBox {
         }
     }
 
+    /**
+     * @public
+     * @param {number} scale 
+     * @param {number} x coordinate
+     * @param {number} y coordinate
+     */
     createBox(scale, x, y) {
         if (this._container == null) {
             this._scale = scale;
@@ -64,7 +109,7 @@ class PasteBox {
             this._container.x = x;
             this._container.y = y;
 
-            const __processBackground = (that, name, bitmap, extras) => {
+            const __processBackground = (that, name, bitmap) => {
                 that._container.addChild(bitmap);
                 that._loadClearContainerHandler();
                 that._container.visible = true;
@@ -75,39 +120,45 @@ class PasteBox {
         }
     }
 
+    /**
+     * @public
+     * @returns {void}
+     */
     show() {
         this._container.visible = true;
         this._refreshCanvas();
         // this._paste.visibile = true;
         docById("paste").style.visibility = "visible";
     }
 
+    /**
+     * @public
+     * @returns {Object}
+     */
     getPos() {
         return [this._container.x, this._container.y];
     }
 
+    /**
+     * @private
+     * @returns {void}
+     */
     _loadClearContainerHandler() {
         const hitArea = new createjs.Shape();
         this.bounds = this._container.getBounds();
         hitArea.graphics
             .beginFill("#FFF")
-            .drawRect(
-                this.bounds.x,
-                this.bounds.y,
-                this.bounds.width,
-                this.bounds.height
-            );
+            .drawRect(this.bounds.x, this.bounds.y, this.bounds.width, this.bounds.height);
         hitArea.x = 0;
         hitArea.y = 0;
         this._container.hitArea = hitArea;
 
         let locked = false;
-        const that = this;
 
         this._container.on("click", (event) => {
             // We need a lock to "debouce" the click.
             if (locked) {
-                console.debug("debouncing click");
+                // console.debug("debouncing click");
                 return;
             }
 
@@ -125,19 +176,19 @@ class PasteBox {
         });
     }
 
+    /**
+     * @deprecated
+     */
     _makeBoxBitmap(data, name, callback, extras) {
         // Async creation of bitmap from SVG data
         // Works with Chrome, Safari, Firefox (untested on IE)
         const img = new Image();
-        const that = this;
 
         img.onload = () => {
             const bitmap = new createjs.Bitmap(img);
             callback(this, name, bitmap, extras);
         };
 
-        img.src =
-            "data:image/svg+xml;base64," +
-            window.btoa(unescape(encodeURIComponent(data)));
+        img.src = "data:image/svg+xml;base64," + window.btoa(unescape(encodeURIComponent(data)));
     }
 }