From 8bee1e7b8b16518b70bcfc368c6a4071c44840c3 Mon Sep 17 00:00:00 2001 From: Petar Petrov Date: Fri, 6 Nov 2015 08:55:30 +0200 Subject: [PATCH] doc tweak for edge smoothing changes - #755 --- src/drawer.js | 8 ++++---- src/tile.js | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/drawer.js b/src/drawer.js index a28606b1..9e928bb6 100644 --- a/src/drawer.js +++ b/src/drawer.js @@ -290,8 +290,8 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ * drawingHandler({context, tile, rendered}) * @param {Boolean} useSketch - Whether to use the sketch canvas or not. * where rendered is the context with the pre-drawn image. - * @param {Float} scale - Apply a scale to tile position and size. Defaults to 1. - * @param {OpenSeadragon.Point} translate Optional. A translation vector to offset tile position + * @param {Float} [scale=1] - Apply a scale to tile position and size. Defaults to 1. + * @param {OpenSeadragon.Point} [translate] A translation vector to offset tile position */ drawTile: function( tile, drawingHandler, useSketch, scale, translate ) { $.console.assert(tile, '[Drawer.drawTile] tile is required'); @@ -374,9 +374,9 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ /** * Blends the sketch canvas in the main canvas. * @param {Float} opacity The opacity of the blending. - * @param {Float} scale The scale at which tiles were drawn on the sketch. Default is 1. + * @param {Float} [scale=1] The scale at which tiles were drawn on the sketch. Default is 1. * Use scale to draw at a lower scale and then enlarge onto the main canvas. - * @param {OpenSeadragon.Point} translate A translation vector that was used to draw the tiles + * @param OpenSeadragon.Point} [translate] A translation vector that was used to draw the tiles * @returns {undefined} */ blendSketch: function(opacity, scale, translate) { diff --git a/src/tile.js b/src/tile.js index e5d5be50..12a33a22 100644 --- a/src/tile.js +++ b/src/tile.js @@ -240,8 +240,8 @@ $.Tile.prototype = /** @lends OpenSeadragon.Tile.prototype */{ * @param {Function} drawingHandler - Method for firing the drawing event. * drawingHandler({context, tile, rendered}) * where rendered is the context with the pre-drawn image. - * @param {Number} scale - Apply a scale to position and size - * @param {OpenSeadragon.Point} translate - A translation vector + * @param {Number} [scale=1] - Apply a scale to position and size + * @param {OpenSeadragon.Point} [translate] - A translation vector */ drawCanvas: function( context, drawingHandler, scale, translate ) { @@ -338,7 +338,7 @@ $.Tile.prototype = /** @lends OpenSeadragon.Tile.prototype */{ * Get a translation vector that when applied to the tile position produces integer coordinates. * Needed to avoid swimming and twitching. * @function - * @param {Number} scale - Scale to be applied to position. Defaults to 1. + * @param {Number} [scale=1] - Scale to be applied to position. * @return {OpenSeadragon.Point} */ getTranslationForEdgeSmoothing: function(scale) {