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

Merge pull request #1259 from openseadragon/ian

Browse Source 
Fixed doc comments for 2.3.0
This commit is contained in:
Ian Gilman 2017-07-18 16:58:27 -07:00 committed by GitHub
commit bb8631bbe8
3 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/mousetracker.js
View File

@ -1238,8 +1238,9 @@
}, },
/** /**
* @function Increment this pointer's contact count. * Increment this pointer's contact count.
* It will evaluate whether this pointer type is allowed to have multiple contacts. * It will evaluate whether this pointer type is allowed to have multiple contacts.
* @function
*/ */
addContact: function() { addContact: function() {
++this.contacts; ++this.contacts;
@ -1250,8 +1251,9 @@
}, },
/** /**
* @function Decrement this pointer's contact count. * Decrement this pointer's contact count.
* It will make sure the count does not go below 0. * It will make sure the count does not go below 0.
* @function
*/ */
removeContact: function() { removeContact: function() {
--this.contacts; --this.contacts;
@ -3341,10 +3343,12 @@
} }
} }
// True if inside an iframe, otherwise false. /**
// @member {Boolean} isInIframe * True if inside an iframe, otherwise false.
// @private * @member {Boolean} isInIframe
// @inner * @private
* @inner
*/
var isInIframe = (function() { var isInIframe = (function() {
try { try {
return window.self !== window.top; return window.self !== window.top;
@ -3353,10 +3357,12 @@
} }
})(); })();
// @function /**
// @private * @function
// @inner * @private
// @returns {Boolean} True if the target has access rights to events, otherwise false. * @inner
* @returns {Boolean} True if the target has access rights to events, otherwise false.
*/
function canAccessEvents (target) { function canAccessEvents (target) {
try { try {
return target.addEventListener && target.removeEventListener; return target.addEventListener && target.removeEventListener;

7
src/openseadragon.js
View File

@ -690,13 +690,6 @@
*/ */
/**
* This function serves as a single point of instantiation for an {@link OpenSeadragon.Viewer}, including all
* combinations of out-of-the-box configurable features.
*
* @param {OpenSeadragon.Options} options - Viewer options.
* @returns {OpenSeadragon.Viewer}
*/
function OpenSeadragon( options ){ function OpenSeadragon( options ){
return new OpenSeadragon.Viewer( options ); return new OpenSeadragon.Viewer( options );
} }

2
src/tiledimage.js
View File

@ -849,8 +849,8 @@ $.extend($.TiledImage.prototype, $.EventSource.prototype, /** @lends OpenSeadrag
}, },
/** /**
* @private
* Get the point around which this tiled image is rotated * Get the point around which this tiled image is rotated
* @private
* @param {Boolean} current True for current rotation point, false for target. * @param {Boolean} current True for current rotation point, false for target.
* @returns {OpenSeadragon.Point} * @returns {OpenSeadragon.Point}
*/ */