diff --git a/src/button.js b/src/button.js index 71aaff61..b25a7534 100644 --- a/src/button.js +++ b/src/button.js @@ -282,7 +282,7 @@ $.Button = function( options ) { clickHandler: function( event ) { if ( event.quick ) { /** - * Raised when a mouse button is pressed and released or touch is initiated end ended in the Button element within the time and distance threshold. + * Raised when a mouse button is pressed and released or touch is initiated and ended in the Button element within the time and distance threshold. * * @event click * @memberof OpenSeadragon.Button @@ -299,7 +299,7 @@ $.Button = function( options ) { //console.log( "%s : handling key %s!", _this.tooltip, event.keyCode); if( 13 === event.keyCode ){ /*** - * Raised when a mouse button is pressed and released or touch is initiated end ended in the Button element within the time and distance threshold. + * Raised when a mouse button is pressed and released or touch is initiated and ended in the Button element within the time and distance threshold. * * @event click * @memberof OpenSeadragon.Button diff --git a/src/openseadragon.js b/src/openseadragon.js index 7f763da2..9dc40535 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -118,8 +118,8 @@ * @memberof OpenSeadragon * * @property {Array|String|Function|Object[]|Array[]|String[]|Function[]} [tileSources=null] - * As an Array, the tileSource can hold either be all Objects or mixed - * types of Arrays of Objects, String, Function. When a value is a String, + * As an Array, the tileSource can hold either Objects or mixed + * types of Arrays of Objects, Strings, or Functions. When a value is a String, * the tileSource is used to create a {@link OpenSeadragon.DziTileSource}. * When a value is a Function, the function is used to create a new * {@link OpenSeadragon.TileSource} whose abstract method @@ -241,10 +241,10 @@ * point is less than this many pixels, ignore the drag event. * * @property {Number} [zoomPerClick=2.0] - * The "zoom distance" per mouse click or touch tap. + * The "zoom distance" per mouse click or touch tap. **Note:** Setting this to 1.0 effectively disables the click-to-zoom feature. * * @property {Number} [zoomPerScroll=1.2] - * The "zoom distance" per mouse scroll or touch pinch. + * The "zoom distance" per mouse scroll or touch pinch. **Note:** Setting this to 1.0 effectively disables the mouse-wheel zoom feature. * * @property {Number} [zoomPerSecond=1.0] * The number of seconds to animate a single zoom event over. diff --git a/src/viewer.js b/src/viewer.js index 8d4e3fdc..a7a91b87 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -54,13 +54,7 @@ var THIS = {}, * @memberof OpenSeadragon * @extends OpenSeadragon.EventSource * @extends OpenSeadragon.ControlDock - * @param {OpenSeadragon.Options} [options] - Viewer options. If an {@link OpenSeadragon.Options} object is passed first, all other parameters are ignored. This is the preferred method of creating a viewer. - * @param {String} element - Id of Element to attach to, - * @param {String} xmlPath - Xpath ( TODO: not sure! ), - * @param {String} prefixUrl - Url used to prepend to paths, eg button images, etc. - * @param {OpenSeadragon.Control[]} controls - Array of OpenSeadragon.Control, - * @param {OpenSeadragon.Overlay[]} overlays - Array of OpenSeadragon.Overlay, - * @param {OpenSeadragon.Control[]} overlayControls - An Array of ( TODO: not sure! ) + * @param {OpenSeadragon.Options} options - Viewer options. * **/ $.Viewer = function( options ) { @@ -120,7 +114,7 @@ $.Viewer = function( options ) { customControls: [], //These are originally not part options but declared as members - //in initialize. Its still considered idiomatic to put them here + //in initialize. It's still considered idiomatic to put them here source: null, /** * @member {OpenSeadragon.Drawer} drawer @@ -141,7 +135,7 @@ $.Viewer = function( options ) { navigator: null, //A collection viewport is a separate viewport used to provide - //simultanious rendering of sets of tiles + //simultaneous rendering of sets of tiles collectionViewport: null, collectionDrawer: null,