Merge pull request #1259 from openseadragon/ian

Fixed doc comments for 2.3.0

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
+     * True if inside an iframe, otherwise false.
-    // @private
+     * @member {Boolean} isInIframe
-    // @inner
+     * @private
+     * @inner
+     */
     var isInIframe = (function() {
         try {
             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) {
         try {
             return target.addEventListener && target.removeEventListener;

src/openseadragon.js

@@ -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 ){
     return new OpenSeadragon.Viewer( options );
 }

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}
      */