From 4c64042bacc7fb55abcecd79d538d6b29f50c467 Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Thu, 5 Mar 2020 10:29:08 -0800 Subject: [PATCH] JSDoc fixes --- src/drawer.js | 2 +- src/tiledimage.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/drawer.js b/src/drawer.js index 18a63ece..db08fbee 100644 --- a/src/drawer.js +++ b/src/drawer.js @@ -184,7 +184,7 @@ $.Drawer.prototype = { /** * This function will create multiple polygon paths on the drawing context by provided polygons, * then clip the context to the paths. - * @param {(OpenSeadragon.Point[])[]} polygons - an array of polygons. A polygon is an array of OpenSeadragon.Point + * @param {OpenSeadragon.Point[][]} polygons - an array of polygons. A polygon is an array of OpenSeadragon.Point * @param {Boolean} useSketch - Whether to use the sketch canvas or not. */ clipWithPolygons: function (polygons, useSketch) { diff --git a/src/tiledimage.js b/src/tiledimage.js index 046d86f8..347a5b3e 100644 --- a/src/tiledimage.js +++ b/src/tiledimage.js @@ -677,7 +677,7 @@ $.extend($.TiledImage.prototype, $.EventSource.prototype, /** @lends OpenSeadrag /** * Sets an array of polygons to crop the TiledImage during draw tiles. * The render function will use the default non-zero winding rule. - * @param Polygons represented in an array of point object in image coordinates. + * @param {OpenSeadragon.Point[][]} polygons - represented in an array of point object in image coordinates. * Example format: [ * [{x: 197, y:172}, {x: 226, y:172}, {x: 226, y:198}, {x: 197, y:198}], // First polygon * [{x: 328, y:200}, {x: 330, y:199}, {x: 332, y:201}, {x: 329, y:202}] // Second polygon