From 4fa7ed159000db58d9e9cf15b177bbd1c3ce1353 Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Sat, 9 Apr 2016 10:15:02 -0400 Subject: [PATCH] Adapt doc to new version of JSDoc. --- src/openseadragon.js | 17 +---------------- src/viewer.js | 17 +++++++++++------ 2 files changed, 12 insertions(+), 22 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index 7b51ee7f..cee2d9e3 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -82,23 +82,9 @@ */ -/** - * @version <%= pkg.name %> <%= pkg.version %> - * - * @file - *

OpenSeadragon - Javascript Deep Zooming

- *

- * 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. - *

- * - */ - /** * @namespace OpenSeadragon - * + * @version <%= pkg.name %> <%= pkg.version %> * @classdesc The root namespace for OpenSeadragon. All utility methods * 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 * combinations of out-of-the-box configurable features. * - * @function * @param {OpenSeadragon.Options} options - Viewer options. * @returns {OpenSeadragon.Viewer} */ diff --git a/src/viewer.js b/src/viewer.js index d3cce4b8..b647ee41 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -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.
+ *
* 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.
+ *
* 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.
+ *
+ * To create a viewer, you can use either of this methods:
+ * * @class Viewer * @classdesc The main OpenSeadragon viewer class. *