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

Adapt doc to new version of JSDoc.

Browse Source
This commit is contained in:
Antoine Vandecreme 2016-04-09 10:15:02 -04:00
parent 5ebf84a580
commit 4fa7ed1590
2 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/openseadragon.js
View File

@ -82,23 +82,9 @@
*/ */
/**
* @version <%= pkg.name %> <%= pkg.version %>
*
* @file
* <h2><strong>OpenSeadragon - Javascript Deep Zooming</strong></h2>
* <p>
* OpenSeadragon provides an html interface for creating
* deep zoom user interfaces. The simplest examples include deep
* zoom for large resolution images, and complex examples include
* zoomable map interfaces driven by SVG files.
* </p>
*
*/
/** /**
* @namespace OpenSeadragon * @namespace OpenSeadragon
* * @version <%= pkg.name %> <%= pkg.version %>
* @classdesc The root namespace for OpenSeadragon. All utility methods * @classdesc The root namespace for OpenSeadragon. All utility methods
* and classes are defined on or below this namespace. * and classes are defined on or below this namespace.
* *
@ -686,7 +672,6 @@
* 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
* @param {OpenSeadragon.Options} options - Viewer options. * @param {OpenSeadragon.Options} options - Viewer options.
* @returns {OpenSeadragon.Viewer} * @returns {OpenSeadragon.Viewer}
*/ */

17
src/viewer.js
View File

@ -40,14 +40,19 @@ var nextHash = 1;
/** /**
* *
* The main point of entry into creating a zoomable image on the page. * The main point of entry into creating a zoomable image on the page.<br>
* * <br>
* We have provided an idiomatic javascript constructor which takes * We have provided an idiomatic javascript constructor which takes
* a single object, but still support the legacy positional arguments. * a single object, but still support the legacy positional arguments.<br>
* * <br>
* The options below are given in order that they appeared in the constructor * The options below are given in order that they appeared in the constructor
* as arguments and we translate a positional call into an idiomatic call. * as arguments and we translate a positional call into an idiomatic call.<br>
* * <br>
* To create a viewer, you can use either of this methods:<br>
* <ul>
* <li><code>var viewer = new OpenSeadragon.Viewer(options);</code></li>
* <li><code>var viewer = OpenSeadragon(options);</code></li>
* </ul>
* @class Viewer * @class Viewer
* @classdesc The main OpenSeadragon viewer class. * @classdesc The main OpenSeadragon viewer class.
* *