fixing jsdocs that caused recursion

This commit is contained in:
thatcher 2013-02-19 22:53:54 -05:00
parent 6e99a5dd42
commit 070a48f6c8
7 changed files with 16 additions and 12 deletions

View File

@ -69,7 +69,7 @@ module.exports = function(grunt) {
}, },
server: { server: {
port: 8000, port: 8000,
base: "." base: "../openseadragon.github.com"//"."
}, },
watch: { watch: {
files: [ "grunt.js", "src/*.js" ], files: [ "grunt.js", "src/*.js" ],
@ -115,4 +115,5 @@ module.exports = function(grunt) {
// Package task. // Package task.
grunt.registerTask("package", "default compress"); grunt.registerTask("package", "default compress");
}; };

View File

@ -244,7 +244,7 @@ function configureFromXML( tileSource, xmlDoc ){
Y: parseInt( rectNode.getAttribute( "Y" ), 10 ), Y: parseInt( rectNode.getAttribute( "Y" ), 10 ),
Width: parseInt( rectNode.getAttribute( "Width" ), 10 ), Width: parseInt( rectNode.getAttribute( "Width" ), 10 ),
Height: parseInt( rectNode.getAttribute( "Height" ), 10 ), Height: parseInt( rectNode.getAttribute( "Height" ), 10 ),
MinLevel: 0, // ignore MinLevel attribute, bug in Deep Zoom Composer MinLevel: parseInt( dispRectNode.getAttribute( "MinLevel" ), 10 ),
MaxLevel: parseInt( dispRectNode.getAttribute( "MaxLevel" ), 10 ) MaxLevel: parseInt( dispRectNode.getAttribute( "MaxLevel" ), 10 )
} }
}); });
@ -310,7 +310,7 @@ function configureFromObject( tileSource, configuration ){
parseInt( rectData.Y, 10 ), parseInt( rectData.Y, 10 ),
parseInt( rectData.Width, 10 ), parseInt( rectData.Width, 10 ),
parseInt( rectData.Height, 10 ), parseInt( rectData.Height, 10 ),
0, // ignore MinLevel attribute, bug in Deep Zoom Composer parseInt( rectData.MinLevel, 10 ),
parseInt( rectData.MaxLevel, 10 ) parseInt( rectData.MaxLevel, 10 )
)); ));
} }

View File

@ -9,7 +9,7 @@
* https://gist.github.com/jpstroop/4624253 * https://gist.github.com/jpstroop/4624253
* *
* @class * @class
* @name OpenSeadragon.IIIFTileSource * @extends OpenSeadragon.TileSource
* @see http://library.stanford.edu/iiif/image-api/ * @see http://library.stanford.edu/iiif/image-api/
*/ */
$.IIIFTileSource = function( options ){ $.IIIFTileSource = function( options ){
@ -35,8 +35,6 @@ $.IIIFTileSource = function( options ){
}; };
$.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, { $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, {
/** /**
* Determine if the data and/or url imply the image service is supported by * Determine if the data and/or url imply the image service is supported by
* this tile source. * this tile source.

View File

@ -1,6 +1,5 @@
(function( $ ){ (function( $ ){
/** /**
* The LegacyTileSource allows simple, traditional image pyramids to be loaded * The LegacyTileSource allows simple, traditional image pyramids to be loaded
* into an OpenSeadragon Viewer. Basically, this translates to the historically * into an OpenSeadragon Viewer. Basically, this translates to the historically
@ -9,6 +8,7 @@
* resolution image and a high resolution image in standard web formats like * resolution image and a high resolution image in standard web formats like
* png or jpg. * png or jpg.
* @class * @class
* @extends OpenSeadragon.TileSource
* @param {Array} levels An array of file descriptions, each is an object with * @param {Array} levels An array of file descriptions, each is an object with
* a 'url', a 'width', and a 'height'. Overriding classes can expect more * a 'url', a 'width', and a 'height'. Overriding classes can expect more
* properties but these properties are sufficient for this implementation. * properties but these properties are sufficient for this implementation.
@ -59,7 +59,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
* Determine if the data and/or url imply the image service is supported by * Determine if the data and/or url imply the image service is supported by
* this tile source. * this tile source.
* @function * @function
* @name OpenSeadragon.DziTileSource.prototype.supports * @name OpenSeadragon.LegacyTileSource.prototype.supports
* @param {Object|Array} data * @param {Object|Array} data
* @param {String} optional - url * @param {String} optional - url
*/ */
@ -77,7 +77,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
/** /**
* *
* @function * @function
* @name OpenSeadragon.DziTileSource.prototype.configure * @name OpenSeadragon.LegacyTileSource.prototype.configure
* @param {Object|XMLDocument} configuration - the raw configuration * @param {Object|XMLDocument} configuration - the raw configuration
* @param {String} dataUrl - the url the data was retreived from if any. * @param {String} dataUrl - the url the data was retreived from if any.
* @return {Object} options - A dictionary of keyword arguments sufficient * @return {Object} options - A dictionary of keyword arguments sufficient
@ -102,6 +102,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
/** /**
* @function * @function
* @name OpenSeadragon.LegacyTileSource.prototype.getLevelScale
* @param {Number} level * @param {Number} level
*/ */
getLevelScale: function( level ) { getLevelScale: function( level ) {
@ -116,6 +117,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
/** /**
* @function * @function
* @name OpenSeadragon.LegacyTileSource.prototype.getNumTiles
* @param {Number} level * @param {Number} level
*/ */
getNumTiles: function( level ) { getNumTiles: function( level ) {
@ -129,6 +131,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
/** /**
* @function * @function
* @name OpenSeadragon.LegacyTileSource.prototype.getTileAtPoint
* @param {Number} level * @param {Number} level
* @param {OpenSeadragon.Point} point * @param {OpenSeadragon.Point} point
*/ */
@ -143,6 +146,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, {
* server technologies, and various specifications for building image * server technologies, and various specifications for building image
* pyramids, this method is here to allow easy integration. * pyramids, this method is here to allow easy integration.
* @function * @function
* @name OpenSeadragon.LegacyTileSource.prototype.getTileUrl
* @param {Number} level * @param {Number} level
* @param {Number} x * @param {Number} x
* @param {Number} y * @param {Number} y

View File

@ -65,7 +65,7 @@ $.extend( $.OsmTileSource.prototype, $.TileSource.prototype, {
* Determine if the data and/or url imply the image service is supported by * Determine if the data and/or url imply the image service is supported by
* this tile source. * this tile source.
* @function * @function
* @name OpenSeadragon.DziTileSource.prototype.supports * @name OpenSeadragon.OsmTileSource.prototype.supports
* @param {Object|Array} data * @param {Object|Array} data
* @param {String} optional - url * @param {String} optional - url
*/ */

View File

@ -238,7 +238,7 @@ $.extend( $.ReferenceStrip.prototype, $.EventHandler.prototype, $.Viewer.prototy
}, },
/** /**
* @function * @function
* @name OpenSeadragon.Navigator.prototype.update * @name OpenSeadragon.ReferenceStrip.prototype.update
*/ */
update: function( viewport ){ update: function( viewport ){

View File

@ -2,7 +2,7 @@
/** /**
* @class * @class
* @extends OpenSeadragon.TileSourceCollection * @extends OpenSeadragon.TileSource
*/ */
$.TileSourceCollection = function( tileSize, tileSources, rows, layout ) { $.TileSourceCollection = function( tileSize, tileSources, rows, layout ) {
@ -62,6 +62,7 @@ $.extend( $.TileSourceCollection.prototype, $.TileSource.prototype, {
/** /**
* @function * @function
* @name OpenSeadragon.TileSourceCollection.prototype.getTileBounds
* @param {Number} level * @param {Number} level
* @param {Number} x * @param {Number} x
* @param {Number} y * @param {Number} y