mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-25 14:46:10 +03:00
Code Issues Projects Releases Wiki Activity

Fix JSDoc.

Browse Source
This commit is contained in:
Antoine Vandecreme 2016-04-05 20:00:35 -04:00
parent d631d97545
commit bd4cabaec2
2 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/openseadragon.js
View File

@ -96,11 +96,6 @@
* *
*/ */
/**
* @module OpenSeadragon
*
*/
/** /**
* @namespace OpenSeadragon * @namespace OpenSeadragon
* *
@ -691,8 +686,7 @@
* This function serves as a single point of instantiation for an {@link OpenSeadragon.Viewer}, including all * This function serves as a single point of instantiation for an {@link OpenSeadragon.Viewer}, including all
* combinations of out-of-the-box configurable features. * combinations of out-of-the-box configurable features.
* *
* @function OpenSeadragon * @function
* @memberof module:OpenSeadragon
* @param {OpenSeadragon.Options} options - Viewer options. * @param {OpenSeadragon.Options} options - Viewer options.
* @returns {OpenSeadragon.Viewer} * @returns {OpenSeadragon.Viewer}
*/ */

4
src/viewport.js
View File

@ -317,8 +317,8 @@ $.Viewport.prototype = {
}, },
/** /**
* @function
* The margins push the "home" region in from the sides by the specified amounts. * The margins push the "home" region in from the sides by the specified amounts.
* @function
* @returns {Object} Properties (Numbers, in screen coordinates): left, top, right, bottom. * @returns {Object} Properties (Numbers, in screen coordinates): left, top, right, bottom.
*/ */
getMargins: function() { getMargins: function() {
@ -326,8 +326,8 @@ $.Viewport.prototype = {
}, },
/** /**
* @function
* The margins push the "home" region in from the sides by the specified amounts. * The margins push the "home" region in from the sides by the specified amounts.
* @function
* @param {Object} margins - Properties (Numbers, in screen coordinates): left, top, right, bottom. * @param {Object} margins - Properties (Numbers, in screen coordinates): left, top, right, bottom.
*/ */
setMargins: function(margins) { setMargins: function(margins) {