From ca4550d76e9aea43dd8eabbd2c301c4752631746 Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Tue, 18 Jul 2017 16:22:26 -0700 Subject: [PATCH] Doc comment fixes --- src/mousetracker.js | 26 ++++++++++++++++---------- src/tiledimage.js | 2 +- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/src/mousetracker.js b/src/mousetracker.js index 8f274933..8a342d18 100644 --- a/src/mousetracker.js +++ b/src/mousetracker.js @@ -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. + * @function */ addContact: function() { ++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. + * @function */ removeContact: function() { --this.contacts; @@ -3341,10 +3343,12 @@ } } - // True if inside an iframe, otherwise false. - // @member {Boolean} isInIframe - // @private - // @inner + /** + * True if inside an iframe, otherwise false. + * @member {Boolean} isInIframe + * @private + * @inner + */ var isInIframe = (function() { try { return window.self !== window.top; @@ -3353,10 +3357,12 @@ } })(); - // @function - // @private - // @inner - // @returns {Boolean} True if the target has access rights to events, otherwise false. + /** + * @function + * @private + * @inner + * @returns {Boolean} True if the target has access rights to events, otherwise false. + */ function canAccessEvents (target) { try { return target.addEventListener && target.removeEventListener; diff --git a/src/tiledimage.js b/src/tiledimage.js index 779039d4..8851a933 100644 --- a/src/tiledimage.js +++ b/src/tiledimage.js @@ -849,8 +849,8 @@ $.extend($.TiledImage.prototype, $.EventSource.prototype, /** @lends OpenSeadrag }, /** - * @private * Get the point around which this tiled image is rotated + * @private * @param {Boolean} current True for current rotation point, false for target. * @returns {OpenSeadragon.Point} */